All pages
Powered by GitBook
1 of 1

Loading...

AM - Update isRepLetterProvided

Details

/external/v1/exclusivity/update-rep-letter-provided

Synopsis

Updates isRepLetterProvided for Investor Org on Exclusivity list

put

This route is used to update the value of the isRepLetterProvided field for the organization on the exclusivity list.

This should only be triggered by the organization that owns the security.

It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints.

This endpoint can be called by applications with access to scope "manageExclusivityOptions".

Authorizations
Body
transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security being affected by this action

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}
orgIdstring · max: 50Required

The id of the organization. Used to uniquely identify the organization on the ledger

Example: US9QIMA
isRepLetterProvidedbooleanRequired

Set this value to true if the issuer of the security has a rep letter from the distribution partner being assigned to the exclusivity list.

Default: falseExample: true
Responses
200
Successfully triggered the process to update isRepLetterProvided field for the investor org on the exclusive list of this security. The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.
application/json
400
The following error codes can be returned: - GN0002 Please refer to the error code dictionary for the details of each error code.
application/json
401
The following error codes can be returned: - AU0001 - AU0003 Please refer to the error code dictionary for the details of each error code.
application/json
403
The following error codes can be returned: - AU0002 - OG0025 Please refer to the error code dictionary for the details of each error code.
application/json
404
The following error codes can be returned: - IS0009 - OG0001 Please refer to the error code dictionary for the details of each error code.
application/json
409
The following error codes can be returned: - IS0013 - IS0010 - EX0005 Please refer to the error code dictionary for the details of each error code.
application/json
put
PUT /external/v1/exclusivity/update-rep-letter-provided HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "orgId": "US9QIMA",
  "isRepLetterProvided": true
}
{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}