Inv - Create Transfer

Details

/external/v1/transfer

Synopsis

Create Transfer

post

This route is used to create a transfer request by recipient investing org. 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 called by applications with access to scope "manageTransfer". Once complete the issuer or assigned service provider will review this transfer request and will either accept it and pass it onwards to the sender organization or may ask for some remediation of this request. This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["investor"]. 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't be invoked if the security is restricted.

Required scopes

This endpoint requires the following scopes:

• : manageTransfer

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

accountall ofRequired

This property contains the reference data of the account that holds the digital security.

Example: {"correlationData":[{"correlationId":"INV001"}],"data":{"name":"Individual Account","type":"Individual","relationshipType":"Brokerage","bankAccount":{"accountNumber":"111111111","accountName":"savings account","bankABA":"555555555","bankName":"Test Bank","bankSwift":"AAAA-BB-CC-123","extraData":{"settlementInstructions":"Please wire the amount within 72 hours","some":"Other Property"}},"contactInfo":[{"email":"[email protected]","phoneNumber":"832-426-4242","type":"primary"},{"email":"[email protected]","phoneNumber":"987-564-1234","type":"tax","name":"John Doe","description":"Use this contact for Tax Related Information (K-1, 1099 or other tax related information)"}],"custodian":{"data":{"name":"Charles Schwab"}},"advisors":[{"data":{"type":"FA","name":"Chris Smith","crdCode":"546321","repCode":"AB98765"}}],"authorizedSigners":[{"name":"Jane Doe","primary":true,"isNominee":true,"isKeyController":true,"isExecutor":true,"isAdministrator":true,"isSettlor":true,"extraData":{"externalId":"123456","some":"Other Property"}}],"beneficiaries":[{"name":"John Doe","beneficialOwnership":40,"isNominee":true,"individualInfo":{"name":"John Doe","taxId":"123456789"}},{"name":"Jane Doe LLC","beneficialOwnership":60,"legalEntityInfo":{"name":"Jane Doe Private Investments and Capital Management, LLC","type":"LLC","taxId":"987654321"}}],"secureExtraData":{"sensitive":"Data to be protected by application encryption"}}}

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where the transfer request is being created

Example: {"securityId":"USS3JKS01I00","amount":50000,"transferReason":"gift","sourceAccountData":{"orgId":"TEST1234","accountId":"TEST67891"},"signer":{"email":"[email protected]","name":"John Doe"},"correlationData":[{"broadcastToCounterparty":true,"correlationId":"123245573717","origin":"Identifies transfer on backoffice","extraData":{"some":"Custom Property"}}]}

bookedTransferIdstring · max: 12Optional

This is the booked unique identifier of the transfer. It is optional. If not provided, a new unique identifier will be generated.

Example: USS3JKS01I00

Responses

201

Successfully triggered the creation of the transferThe "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process. The "transferId" property can be used to get the details of this transfer or execute further actions.

application/json

400

The following error codes can be returned: - GN0002 - AS0009 - IS0008 - IS0106 - IS0001 - IV0006 - IV0007 - IV0008 - IV0020 - IV0022 - IV0017 - IV0016 - IV0023 - IV0032 - IV0036 - IV0037 - IV0042 - AC0013 - AC0014 - AC0016 - AC0026 - AC0023 - AC0006 - AC0007 - AC0044 - AC0050 - AC0027 - AC0063 - AC0064 - AD0018 - AD0022 - AD0023 - CT0015 - CT0017 - TR0035 - TR0042 - FL0002 - FL0003 - FL0019 - FL0004 - FL0005 - FL0017 - FL0020 - QU0001 - QU0002 - QU0003 - QU0004 - QU0005 - QU0006 - QU0007 - QU0008 - QU0009 - QU0010 - CI0001 - CI0002 - CI0003 - CI0004 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 - EX0006 - IV0013 - AC0020 - 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 - AC0001 - AC0002 - IV0002 - FL0008 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 - IV0003 - IV0004 - IV0005 - IV0010 - AC0009 - AC0010 - AC0029 - CE0036 - TR0030 - TR0031 - TR0038 - TR0012 - FL0001 - FL0006 - FL0010 - FL0011 - FL0028 Please refer to the error code dictionary for the details of each error code.

application/json

425

The following error codes can be returned: - GN0003 Please refer to the error code dictionary for the details of each error code.

application/json

post

/external/v1/transfer

HTTPcURLJavaScriptPython

POST /external/v1/transfer HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3265

{
  "investors": [
    {
      "data": {
        "type": "individual",
        "accreditationLevel": "qualifiedClient",
        "isInstitutional": false,
        "hasKYCPassed": false,
        "isComplianceApproved": false,
        "is5131RestrictedPerson": false,
        "isNominee": true,
        "name": "John Doe",
        "individualInfo": {
          "name": "John Doe",
          "dateOfBirth": "2024-09-12",
          "taxId": "123456789",
          "occupation": {
            "role": "Software Engineer",
            "companyName": "Sample Company"
          },
          "residentialAddress": {
            "addressLineOne": "8 Greenway Plaza",
            "addressLineTwo": "Suite 1515",
            "country": "US",
            "state": "Texas",
            "city": "Houston",
            "zipCode": "77046 USA"
          },
          "mailingAddress": {
            "addressLineOne": "8 Greenway Plaza",
            "addressLineTwo": "Suite 1515",
            "country": "US",
            "state": "Texas",
            "city": "Houston",
            "zipCode": "77046 USA"
          },
          "isUsPerson": true,
          "contactInfo": [
            {
              "email": "[email protected]",
              "phoneNumber": "832-426-4242"
            }
          ],
          "extraData": {
            "externalInvestorId": "123456",
            "some": "other property"
          }
        }
      },
      "documents": [
        {
          "uploadData": {
            "type": "IdentityVerification",
            "extension": "pdf",
            "name": "John Doe ID",
            "link": "https://test-storage.s3.amazonaws.com/some-id.pdf"
          },
          "extraData": {
            "someCustom": "property to be shared"
          }
        },
        {
          "fileId": "FILE3JUS03I04"
        }
      ],
      "correlationData": [
        {
          "correlationId": "INV001"
        }
      ],
      "accountAssociationData": {
        "isPrimary": true
      }
    }
  ],
  "account": {
    "correlationData": [
      {
        "correlationId": "INV001"
      }
    ],
    "data": {
      "name": "Individual Account",
      "type": "Individual",
      "relationshipType": "Brokerage",
      "bankAccount": {
        "accountNumber": "111111111",
        "accountName": "savings account",
        "bankABA": "555555555",
        "bankName": "Test Bank",
        "bankSwift": "AAAA-BB-CC-123",
        "extraData": {
          "settlementInstructions": "Please wire the amount within 72 hours",
          "some": "Other Property"
        }
      },
      "contactInfo": [
        {
          "email": "[email protected]",
          "phoneNumber": "832-426-4242",
          "type": "primary"
        },
        {
          "email": "[email protected]",
          "phoneNumber": "987-564-1234",
          "type": "tax",
          "name": "John Doe",
          "description": "Use this contact for Tax Related Information (K-1, 1099 or other tax related information)"
        }
      ],
      "custodian": {
        "data": {
          "name": "Charles Schwab"
        }
      },
      "advisors": [
        {
          "data": {
            "type": "FA",
            "name": "Chris Smith",
            "crdCode": "546321",
            "repCode": "AB98765"
          }
        }
      ],
      "authorizedSigners": [
        {
          "name": "Jane Doe",
          "primary": true,
          "isNominee": true,
          "isKeyController": true,
          "isExecutor": true,
          "isAdministrator": true,
          "isSettlor": true,
          "extraData": {
            "externalId": "123456",
            "some": "Other Property"
          }
        }
      ],
      "beneficiaries": [
        {
          "name": "John Doe",
          "beneficialOwnership": 40,
          "isNominee": true,
          "individualInfo": {
            "name": "John Doe",
            "taxId": "123456789"
          }
        },
        {
          "name": "Jane Doe LLC",
          "beneficialOwnership": 60,
          "legalEntityInfo": {
            "name": "Jane Doe Private Investments and Capital Management, LLC",
            "type": "LLC",
            "taxId": "987654321"
          }
        }
      ],
      "secureExtraData": {
        "sensitive": "Data to be protected by application encryption"
      }
    }
  },
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "amount": 50000,
    "transferReason": "gift",
    "sourceAccountData": {
      "orgId": "TEST1234",
      "accountId": "TEST67891"
    },
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    },
    "correlationData": [
      {
        "broadcastToCounterparty": true,
        "correlationId": "123245573717",
        "origin": "Identifies transfer on backoffice",
        "extraData": {
          "some": "Custom Property"
        }
      }
    ]
  },
  "documents": [
    {
      "uploadData": {
        "type": "IdentityVerification",
        "extension": "pdf",
        "name": "John Doe ID",
        "link": "https://test-storage.s3.amazonaws.com/some-id.pdf"
      },
      "extraData": {
        "someCustom": "property to be shared"
      }
    },
    {
      "fileId": "FILE3JUS03I04"
    }
  ],
  "bookedTransferId": "USS3JKS01I00"
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "transferId": "US9QIMAOAS1Q",
  "fileIds": [
    "US9QIFILE1",
    "US9QIFILE2"
  ],
  "referenceData": {
    "account": {
      "accountId": "US9QIMAOAS1Q",
      "custodian": {
        "custodianId": "US9ZIMAOAS1Q"
      }
    },
    "investors": [
      {
        "investorId": "US9QIM123S1Q"
      }
    ]
  }
}

Important Notes

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