AM/TA - Digitize Offering's Existing Securities

Details

/external/v1/offline-transactions/asset

Synopsis

Digitize Offering's existing securities

post

This route is used by the issuer that owns the security to digitize offline securities. The asset that is created should be used for allocation purposes, i.e. to eventually transfer the digitized asset to the corresponding investor(s) account(s) once they are on the platform. 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","closed"]. This endpoint can't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "createOfflineAsset".

Required scopes

This endpoint requires the following scopes:

• : createOfflineAsset

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

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

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"}

bookedAssetIdstring · max: 12Optional

This is the booked unique identifier of the asset. It is optional.

Example: USS3JKS01I00

amountnumber · min: 0.01 · max: 999999999999999Required

The amount being invested. Must be less or equal to the available amount being raised on the offering defined by the "securityId" parameter. This parameter should be provided for all security types. Up to 2 fractional digits may be provided.

sharesNumbernumber · min: 0.000001 · max: 999999999999999Optional

The number of shares being bought. Must be less or equal to the number of shares available on the offering defined by the "securityId" parameter. This parameter should be provided for unitized financial instruments with static price. Should not be provided for non-unitized instruments (e.g. lpInterest) or for offerings with rolling price type. Up to 2 fractional digits may be provided.

currencystring · max: 3Optional

The currency of the amount. It must be provided if the offering supports multiple currencies. If the offering only supports one currency this property is optional. If provided then it must match the allowed currencies defined on the offering specified by the securityId. Only the alphabetic code is supported.

Example: USD

acquiredDateone ofOptional

This is the date on which the investor confirmed the intention of investing in this security (e.g. date in which he signed a subscription agreement document). Optional.If not provided the system will assume the current timestamp as the acquired date. If provided, this date needs to be after the start of the offering campaign.

Example: 2024-09-12T00:00:00.000Z

string · date-timeOptional

Date-time string

Example: 2024-09-12T00:00:00.000Z

or

string · dateOptional

Date string

Example: 1980-01-01

or

number · numberOptional

Epoch timestamp (milliseconds)

Example: 1185106460000

frontendFeenumberOptional

Asset front end fee (in percentage %). Reflects the commission charged to the investor for this investment opportunity. Should not exceed the maximum commission value defined by the issuer of the securities. If not provided it is assumed to be 0%. Up to 6 decimal cases is supported.

commissionnumber · max: 999999999999999Optional

The absolute value of the commission paid to the advisors. Is an optional field. If not provided then it is assumed to be 0. Up to 2 decimal cases is supported.

Example: 1000

purchaseDefinitionall ofOptional

This field defines if this is an initial investment or a subsequent investment on an existing security. It is optional. The system will set this to 'subsequent' when it detects that this account already has issued assets on this security.

Example: initial

string · enumOptional

This field defines if this is an initial investment or a subsequent investment on an existing security. It is optional. The system will set this to 'subsequent' when it detects that this account already has issued assets on this security.

Possible values:

currentValuenumberOptional

The current value for the non unitized asset (specified on the same currency as the asset). E.g. for a non-unitized fund of type lpInterest with capital calls structure: - GP/Fund Admin calls 10k from one of their LPs - GP/Fund Admin invests the 10k and makes a profit - GP/Fund Admin sets the current value of that LP as 11k

Example: 10000

Responses

201

Successfully triggered the process to digitize offline securities

application/json

processIdstringRequired

This is used to uniquely identity a transaction process on this system.

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

orchestrationIdstringRequired

The orchestration id. It is used to uniquely identity a group of transactions that are being orchestrated following an action request.If a processId was passed as an input to the action, it will be returned on this property.

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

assetIdstringRequired

The ID of the digital asset that uniquely identifies it on the ledger

Example: US9QIMAOAS1Q

400

The following error codes can be returned: - GN0002 - IS0001 - IS0007 - AS0009 - AS0008 - AS0020 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 - IS0099 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 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - IS0119 - IS0013 - IS0012 - IS0002 - IS0026 - IS0028 - IS0029 - IS0030 - IS0034 - AS0010 - AS0011 - AS0019 - AS0021 - AS0022 - AS0017 - AS0029 Please refer to the error code dictionary for the details of each error code.

application/json

post

/external/v1/offline-transactions/asset

HTTPcURLJavaScriptPython

POST /external/v1/offline-transactions/asset HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 944

{
  "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"
  },
  "bookedAssetId": "USS3JKS01I00",
  "amount": 1,
  "sharesNumber": 1,
  "currency": "USD",
  "acquiredDate": "2024-09-12T00:00:00.000Z",
  "completedByAdvisor": {
    "advisorId": "ADV00018",
    "data": {
      "name": "Jane Doe",
      "type": "FA",
      "crdCode": "5555666"
    }
  },
  "correlationData": [
    {
      "broadcastToCounterparty": true,
      "correlationId": "123245573717",
      "origin": "Identifies asset on backoffice",
      "extraData": {
        "some": "Custom Property"
      }
    }
  ],
  "frontendFee": 1,
  "commission": 1000,
  "purchaseDefinition": "initial",
  "positionInfo": {
    "dividendReinvestmentPlanElection": "cash",
    "extraData": {
      "some": "custom property"
    }
  },
  "currentValue": 10000,
  "capitalCallDetails": {
    "amountCalled": 3000,
    "expenses": 1000,
    "permanentDistributionAmount": 0
  }
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "assetId": "US9QIMAOAS1Q"
}

Important Notes

• See Blockchain Transaction Tracking for information on using orchestrationId and processId.