Throughout the API flows, an asset represents multiple shares, or a lot, of a given security. An investor can recall the asset to undo the subscription.
/external/v1/primary/asset/{assetId}/recall
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
The dryRun option is included in the response, but is not yet used for this method.
\
This route is used to trigger the recall of an asset on the blockchain for a particular security.
Can be invoked at any time while the offering is still active.
This should be called by investor to stop participating in the offering.
This triggers an asynchronous process (the id of which is returned on the success response) to persist this information on the blockchain which can be monitored using the "Transactions API" endpoints.
Once processed, the asset will move to next stage of the lifecycle
This endpoint can be invoked if the security is in one of the following statuses: ["active","paused"].
This endpoint can be invoked if the asset is in one of the following statuses: ["created","remediation_pending","remediated","confirmed","modified"].
This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["investor"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "cancelSubscription".
The unique identifier of the asset on the blockchain.
This can be a 12 characters platform generated identifier or a correlation id provided by the client. If its length is different from 12 it will be treatead as a correlation id.
Particularly relevant for correlation ids, it is recommended that the ID is url encoded if it contains any special characters.
US9QIMAOAS1QThis property is to be used if the value passed in the "assetId" path parameter is a correlation id instead of a platform generated id.
If set to "true" then the platform will try to obtain the asset data using the path parameter as a correlation id instead of a platform generated id.
trueThis is to be used if the value passed in the "assetId" path parameter is a correlation id instead of a platform generated id.
This is the organization identifier linked to that path param. If not provided the organization id will be inferred from the access token.
This will be ignored if the value in the path parameter is 12 characters long and the isAssetCorrelationId is either absent or not "true".
US9QIThis property contains the transactional data information, i.e. which is the security being bought and the investment details
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}PUT /external/v1/primary/asset/{assetId}/recall HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"assetId": "US9QIMAOAS1Q"
}