company

AM/FA - Complete Offering

Details

/external/v1/security-admin/complete

Synopsis

Complete Offering

put

This route is used to trigger the complete of an offering.

This should be called when the minimum amount being raised has been reached.

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

Once processed, no further investments can be performed unless the offering is reverted back to active (be aware that contingent offerings cannot be reverted back to active so this action will be irreversible in that case).

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","paused"].

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

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

Authorizations
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".

Responses
200
Successfully triggered the process to complete the offering. The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.
application/json
put
PUT /external/v1/security-admin/complete HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "signer": {
    "email": "[email protected]",
    "name": "John Doe"
  },
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "securityId": "USS3JKS01I00",
  "securityCorrelationData": {
    "correlationId": "USS3JKS01I00",
    "orgId": "US9QIMA"
  }
}
{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
PreviousAM/FA - Resume Paused OfferingNextAM/FA - Confirm Offering Completion

Last updated

Was this helpful?