AM/FA/Inv - Update Advisor's Reference Data

Details

/external/v1/advisor/{advisorId}

Synopsis

Update Advisor`s reference data

put

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

Should be called by the organization that created specified advisor 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

oauth2

Path parameters

advisorIdstringRequired

The unique identifier of the advisor 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 advisor reference data information.

Example: {"name":"Charles Schwab","type":"FA","companyName":"Advisor Company","contactInfo":[{"email":"[email protected]","phoneNumber":"[phone]"}]}

Responses

200

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

• AD0010

• AD0011

• AD0002

• AD0014

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

• AD0012

Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned:

• AD0001

Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned:

• AD0003

Please refer to the error code dictionary for the details of each error code.

application/json

put

HTTPcURLJavaScriptPython

PUT /external/v1/advisor/{advisorId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231

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

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