AM/TA/Inv - Get Advisor Details

Details

/external/v1/advisor

Synopsis

Get Advisor Details

get

This route is used to retrieve the details of advisors, given a set of search filters. This endpoint is paginated, up to 25 records can be retrieved per call. This endpoint can be called by applications with access to scope "readAccount".

Required scopes

This endpoint requires the following scopes:

• : readAccount

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

extraDataKeyFilterstring · max: 100Optional

The key to search within the extraData property. Will be used in combination with "extraDataValueFilter". If "extraDataValueFilter" is not provided then this property is discarded.

extraDataValueFilterstring · max: 100Optional

The value to search within the extraData property. Will be used in combination with "extraDataKeyFilter". If "extraDataKeyFilter" is not provided then this property is discarded.

advisorIdsFilterstringOptional

The comma delimited list of advisor ids to filter the advisor records. Up to 25 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

advisorCorrelationIdsFilterstringOptional

The comma delimited list of advisor correlation ids to filter the advisor records. Up to 25 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

advisorCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "advisorCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

Responses

200

Successfully retrieved advisor details

application/json

namestringOptional

The advisor name. It is optional if advisorId is not provided. It is mandatory for new advisors.

typeall ofOptional

The advisor type. It is optional if advisorId is not provided. It is mandatory for new advisors. - FA: Financial Advisor - RIA: Registered Investment Advisor - CSA: Client Services Associate - NA: Not Applicable - Other

string · enumOptional

The advisor type. It is optional if advisorId is not provided. It is mandatory for new advisors. - FA: Financial Advisor - RIA: Registered Investment Advisor - CSA: Client Services Associate - NA: Not Applicable - Other

Possible values:

additionalTypeInfostring · min: 1 · max: 100Optional

This field can be used to provide additional information about the 'type', which is particularly relevant when the 'type' is set to 'Other'

Example: A financial advisor that specializes in retirement planning

companyNamestringOptional

The name of the company to which the advisor works for.

companyIdstringOptional

The id of the company to which the advisor works for

crdCodestringOptional

The Central Registration Depository (CRD) code of the advisor.

repCodestringOptional

The registered representative code

branchstring · min: 1 · max: 100Optional

The identifier of the advisor branch. This field is optional.

Example: b-12345

divisionstring · min: 1 · max: 100Optional

The division of the advisor. This field is optional.

Example: d-12345

advisorIdstringRequired

The advisor id that uniquely identifies an advisor on the ledger.

400

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

application/json

get

/external/v1/advisor

HTTPcURLJavaScriptPython

GET /external/v1/advisor HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "secureExtraData": {
      "some": "Sensitive Data"
    },
    "name": "text",
    "nameDetails": {
      "firstName": "John",
      "middleName": "Doe",
      "lastName": "Smith",
      "suffix": "Jr.",
      "prefix": "Mr.",
      "pronouns": "he/him",
      "knownName": "Johnny",
      "preferredName": "John",
      "title": "Dr."
    },
    "type": "RIA",
    "additionalTypeInfo": "A financial advisor that specializes in retirement planning",
    "companyName": "text",
    "companyId": "text",
    "crdCode": "text",
    "repCode": "text",
    "contactInfo": {
      "email": "[email protected]",
      "phoneNumber": "832-426-4242"
    },
    "branch": "b-12345",
    "division": "d-12345",
    "advisorId": "text",
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    },
    "correlationData": [
      {
        "correlationId": "123245573717",
        "origin": "Identifies advisor on backoffice",
        "organization": {
          "name": "Test Organization",
          "orgId": "TEST1234"
        },
        "extraData": {
          "some": "Custom Property"
        }
      }
    ]
  }
]