company

AM/FA - Approve Transfer by Issuing Org

Details

/external/v1/transfer/{transferId}/approve

Synopsis

Approve Transfer

put

This route is used to trigger approval of the transfer.

Asset manager that owns this security or fund admins assigned to this offering can execute this action, then once this call is completedthe transfer will be marked as approved on the ledgerand the sender organization will be notified and will be able to allocate the assets that fulfill this transfer request.

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 invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].

This endpoint can be invoked if the security is in one of the following statuses: ["active","completed","approved_revert_to_active","closed"].

This endpoint can be invoked if the transfer is in one of the following statuses: ["created","remediated"].

This endpoint can't be invoked if the security is restricted.

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

Authorizations
Path parameters
transferIdanyRequired

The id that uniquely identifies the transfer on the ledger.

Example: TEST0000
Body
signerall ofRequired

This property contains basic information regarding the person that is executing this action. It is used for audit trail of who made which request.

This information will be hashed on the block and will not be shared with other organizations that are part of the blockchain network, unless with the the ones that are concerned with this transaction.

Example: {"email":"[email protected]","name":"John Doe"}
processIdstringOptional

This is an externally provided id that can be used to identify the asynchronous process that will be triggered by this action. It is optional. If not provided the system will generate a unique id for this.

If provided, it must have a v4 UUID format.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf
securityIdstringOptional

This is the security unique identifier on the ledger. It uniquely identifies a particular security on the blockchain. It is optional.

Either "securityId" or "securityCorrelationData" must be provided, but not both.

Example: USS3JKS01I00
securityCorrelationDataall ofOptional

This property contains the correlation data that is used to identify a particular security within an organization. It is optional.

Either "securityId" or "securityCorrelationData" must be provided, but not both. Security Correlation IDs can be managed using the "Security Admin API".

extraDataobject · max: 1024Optional

JSON object to collect extra data regarding the entity. This object cannot have more than 1024 length serialized

Example: {"externalId":"123456789","some":"Custom Property"}
Responses
200
Successfully triggered the approval of the transfer
application/json
put
PUT /external/v1/transfer/{transferId}/approve HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 281

{
  "signer": {
    "email": "[email protected]",
    "name": "John Doe"
  },
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "securityId": "USS3JKS01I00",
  "securityCorrelationData": {
    "correlationId": "USS3JKS01I00",
    "orgId": "US9QIMA"
  },
  "extraData": {
    "externalId": "123456789",
    "some": "Custom Property"
  }
}
{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}

Important Notes

PreviousInv - Create TransferNextAM/FA - Request Transfer Remediation

Last updated

Was this helpful?