AM/FA - Add Facilitation Account

Details

/external/v1/security-admin/facilitation-account/add

Synopsis

Add Facilitation Account

put

This route is used to add a facilitation account to an existing security. This facilitation account is an existing or new account that will be used as the account for this security. This facilitation account will be broadcast to 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 by organizations that have at least one of the following roles on this security: ["issuer","service_provider"]. This endpoint can't be invoked if the security is restricted. It will trigger an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints. This endpoint can be called by applications with access to scope "manageFacilitationAccount".

Required scopes

This endpoint requires the following scopes:

• : manageFacilitationAccount

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security for facilitation account addition

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}

accountDataall ofRequired

This property contains the reference data of the facilitation account.

Example: {"data":{"name":"Issuance Facilitation Account","bankAccount":{"accountNumber":"111111111","accountName":"savings account","bankABA":"555555555","bankName":"Test Bank","bankSwift":"AAAA-BB-CC-123"},"contactInfo":[{"email":"[email protected]","phoneNumber":"832-426-4242"}],"legalEntityInfo":{"data":{"name":"Test Legal Entity","type":"LP","taxId":"987654321","address":{"addressLineOne":"8 Greenway Plaza","city":"New York","state":"NY","country":"US","zipCode":"10165"},"isUsEntity":true,"contactInfo":[{"email":"[email protected]","phoneNumber":"[phone]"}],"incorporationDate":"2024-09-12","incorporationState":"DE","incorporationCountry":"US"}}},"bookedAccountId":"USS3JKS01I00","correlationData":[{"broadcastToCounterparty":true,"correlationId":"123245573717","origin":"Identifies account on backoffice","extraData":{"some":"Custom Property"}}]}

Responses

200

Successfully triggered the process to add facilitation account to the offering.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 - AC0006 - AC0007 - AC0013 - AC0014 - AC0016 - AC0049 - AC0044 - AC0050 - AC0027 - AC0036 - AC0060 - AC0063 - AC0064 - IV0042 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: - AC0001 - IS0009 - GN0008 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 - IS0010 - AC0009 - AC0052 - AC0053 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/security-admin/facilitation-account/add

HTTPcURLJavaScriptPython

PUT /external/v1/security-admin/facilitation-account/add HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 979

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "accountData": {
    "data": {
      "name": "Issuance Facilitation Account",
      "bankAccount": {
        "accountNumber": "111111111",
        "accountName": "savings account",
        "bankABA": "555555555",
        "bankName": "Test Bank",
        "bankSwift": "AAAA-BB-CC-123"
      },
      "contactInfo": [
        {
          "email": "[email protected]",
          "phoneNumber": "832-426-4242"
        }
      ],
      "legalEntityInfo": {
        "data": {
          "name": "Test Legal Entity",
          "type": "LP",
          "taxId": "987654321",
          "address": {
            "addressLineOne": "8 Greenway Plaza",
            "city": "New York",
            "state": "NY",
            "country": "US",
            "zipCode": "10165"
          },
          "isUsEntity": true,
          "contactInfo": [
            {
              "email": "[email protected]",
              "phoneNumber": "[phone]"
            }
          ],
          "incorporationDate": "2024-09-12",
          "incorporationState": "DE",
          "incorporationCountry": "US"
        }
      }
    },
    "bookedAccountId": "USS3JKS01I00",
    "correlationData": [
      {
        "broadcastToCounterparty": true,
        "correlationId": "123245573717",
        "origin": "Identifies account on backoffice",
        "extraData": {
          "some": "Custom Property"
        }
      }
    ]
  }
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "referenceData": {
    "account": {
      "accountId": "US9QIMAOAS1Q"
    },
    "investors": [
      {
        "investorId": "US9QIM123S1Q"
      }
    ]
  }
}