AM/FA/Inv - Update Account Reference Data

Details

/external/v1/account/{accountId}

Synopsis

Update Account`s reference data

put

This route is used to update account's reference data.

Should be called by the organization that created specified account record.

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

Authorizations

Path parameters

accountIdstringRequired

The unique identifier of the account on the blockchain

Example: USS3JKS01I00

Body

transactionDataall ofRequired

This property contains the information regarding who is signing the transaction on the blockchain as well as how it will be signed

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

dataall ofRequired

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

Example: {"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,"extraData":{"externalId":"123456","some":"Other Property"}}],"beneficiaries":[{"name":"John Doe","beneficialOwnership":40,"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 encryptions"}}

Responses

200

Successfully triggered the process to update the account's reference data on the ledger The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process. The "accountId" property can be used on the "Account API" to get the details.

application/json

400

The following error codes can be returned: - GN0002 - AC0006 - AC0007 - AC0017 - AC0049 - AC0021 - AC0022 - AC0031 - AC0032 - AC0033 - AC0034 - AC0035 - AC0043 - CT0019 - CT0020 - QU0001 - QU0002 - QU0003 - QU0004 - QU0005 - QU0006 - QU0007 - QU0008 - QU0009 - QU0010 - CI0001 - CI0002 - 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 - AC0020 Please refer to the error code dictionary for the details of each error code.

application/json

409

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

application/json

put

HTTPcURLJavaScriptPython

PUT /external/v1/account/{accountId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1338

{
  "transactionData": {
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "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,
        "extraData": {
          "externalId": "123456",
          "some": "Other Property"
        }
      }
    ],
    "beneficiaries": [
      {
        "name": "John Doe",
        "beneficialOwnership": 40,
        "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 encryptions"
    }
  }
}

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

Important Notes

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