AM/FA/Inv - Update Custodian Reference Data

Details

/external/v1/custodian/{custodianId}

Synopsis

Update Custodian`s reference data

put

This route is used to update custodian's reference data. Should be called by the organization that created specified custodian 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".

Required scopes

This endpoint requires the following scopes:

• : manageReferenceData

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

custodianIdstringRequired

The unique identifier of the custodian on the blockchain

Example: USS3JKS01I00

Body

application/json

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 custodian reference data information.

Example: {"name":"Charles Schwab","contactInfo":[{"email":"[email protected]","phoneNumber":"[phone]"}]}

Responses

200

Successfully triggered the process to update the custodian'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.

application/json

400

The following error codes can be returned: - GN0002 - CT0012 - CT0013 - CT0014 - CT0002 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 - CT0011 Please refer to the error code dictionary for the details of each error code.

application/json

404

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

application/json

409

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

application/json

put

/external/v1/custodian/{custodianId}

HTTPcURLJavaScriptPython

PUT /external/v1/custodian/{custodianId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "transactionData": {
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "data": {
    "name": "Charles Schwab",
    "contactInfo": [
      {
        "email": "[email protected]",
        "phoneNumber": "[phone]"
      }
    ]
  }
}

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