AM/TA - Get Account Details

Details

/external/v1/account

Synopsis

Get Account Details

get

This route is used to retrieve the details of accounts, 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.

accountIdsFilterstringOptional

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

Example: USCCWSF01I00,USCCWSF01I01

accountCorrelationIdsFilterstringOptional

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

Example: 1234,5678,7890

accountCorrelationOrgIdstring · max: 12Optional

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

investorIdsFilterstringOptional

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

Example: USCCWSF01I00,USCCWSF01I01

investorCorrelationIdsFilterstringOptional

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

Example: 1234,5678,7890

investorCorrelationOrgIdstring · max: 12Optional

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

Responses

200

Successfully retrieved the Account details

application/json

namestring · max: 500Optional

The account name. It is optional if accountId is provided. It is mandatory for new accounts.

benefitPlanInvestorbooleanOptional

True if the investor's account is designed to provide retirement benefits, or other forms of compensation to employees or plan participants. Is an optional field, if not provided "false" will be assumed.

Default: falseExample: true

typeall ofOptional

The account type. It is optional if accountId is provided. It is mandatory for new accounts. This information cannot be changed when promoting account updates.

string · enumOptional

The account type. It is optional if accountId is provided. It is mandatory for new accounts. This information cannot be changed when promoting account updates.

Possible values:

subTypeall ofOptional

The account subtype. It is an optional field. This information can be changed when promoting account updates.

string · enumOptional

The account subtype. It is an optional field. This information can be changed when promoting account updates.

Possible values:

additionalTypeInfostring · max: 100Optional

The additional account info. This parameter should be provided if account type or subtype are set to 'other'. This information can be changed when promoting account updates. If this property is set to null during an account update action (e.g. asset remediation) then the stored value will be clear.

Example: LLCPartnership

relationshipTypeall ofOptional

The account relationship type. It is optional if accountId is provided. It is mandatory for new accounts. - Brokerage - for accounts created under a broker - Institutional - for institutional accounts - Advisory - for accounts maintained by an RIA

Example: Brokerage

string · enumOptional

The account relationship type. It is optional if accountId is provided. It is mandatory for new accounts. - Brokerage - for accounts created under a broker - Institutional - for institutional accounts - Advisory - for accounts maintained by an RIA

Possible values:

isSubjectToERISAbooleanOptional

True if the account is subject to ERISA, false otherwise. Do not provide this if it is not applicable.

Example: true

accountIdstringOptional

This property uniquely identifies an account on the ledger

Example: TEST1234

statusall ofRequired

The status of the account.

Example: sync

string · enumOptional

The status of the account.

Possible values:

latestUpdateTimestampstring · date-timeOptional

The timestamp of the latest update to this account. This will match the "timestamp" obtained via account history endpoint for the latest block where this account's data was recorded.

Example: 2024-09-12T00:00:00.000Z

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/account

HTTPcURLJavaScriptPython

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

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "secureExtraData": {
      "some": "Sensitive Data"
    },
    "name": "text",
    "bankAccount": {
      "accountNumber": "111111111",
      "accountName": "savings account",
      "bankABA": "555555555",
      "bankName": "Test Bank",
      "bankSwift": "AAAA-BB-CC-123"
    },
    "contactInfo": [
      {
        "email": "[email protected]",
        "phoneNumber": "832-426-4242"
      }
    ],
    "benefitPlanInvestor": true,
    "type": "Individual",
    "subType": "Individual",
    "additionalTypeInfo": "LLCPartnership",
    "relationshipType": "Brokerage",
    "authorizedSigners": [
      {
        "name": "John Doe",
        "primary": true,
        "extraData": {
          "externalId": "12345"
        }
      }
    ],
    "beneficiaries": [
      {
        "name": "John Doe",
        "beneficialOwnership": 40,
        "individualInfo": {
          "name": "John Doe",
          "taxId": "123456789"
        }
      },
      {
        "name": "Jane Doe LLC",
        "beneficialOwnership": 60,
        "legalEntityInfo": {
          "name": "Jane Doe LLC",
          "type": "LLC",
          "taxId": "987654321"
        }
      }
    ],
    "beneficialOwners": [
      {
        "name": "John Doe",
        "beneficialOwnership": 40,
        "individualInfo": {
          "name": "John Doe",
          "taxId": "123456789"
        },
        "isAdministrator": true
      },
      {
        "name": "Jane Doe LLC",
        "beneficialOwnership": 60,
        "legalEntityInfo": {
          "name": "Jane Doe LLC",
          "type": "LLC",
          "taxId": "987654321"
        },
        "isExecutor": true
      }
    ],
    "questionnaires": [
      {
        "type": "AccreditedInvestor",
        "title": "US Accredited Investor Questionnaire",
        "questions": [
          {
            "question": {
              "questionId": "q1",
              "questionText": "Are you an accredited investor as defined by the SEC?",
              "answerType": "Boolean"
            },
            "answers": [
              {
                "booleanValue": true
              }
            ]
          },
          {
            "question": {
              "questionId": "q2",
              "questionText": "Please select the criteria under which you qualify as an accredited investor.",
              "answerType": "Choice",
              "allowedAnswerValues": [
                "Income exceeding $200,000 in each of the two most recent years",
                "Net worth exceeding $1 million",
                "Other criteria as defined by the SEC"
              ]
            },
            "answers": [
              {
                "choiceValue": "Net worth exceeding $1 million"
              }
            ]
          },
          {
            "question": {
              "questionId": "q3",
              "questionText": "Please provide any additional information or comments.",
              "answerType": "Text"
            },
            "answers": [
              {
                "textValue": "No additional comments."
              }
            ]
          }
        ]
      }
    ],
    "isSubjectToERISA": true,
    "custodian": {
      "custodianId": "US1W12QDRJ9O"
    },
    "advisors": [
      {
        "advisorId": "US1W1V3RQK3X"
      }
    ],
    "accountId": "TEST1234",
    "associatedInvestors": [
      {
        "investorId": "ORG1X123456",
        "isPrimaryHolder": false
      }
    ],
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    },
    "status": "sync",
    "correlationData": [
      {
        "correlationId": "123245573717",
        "origin": "Identifies account on backoffice",
        "organization": {
          "name": "Test Organization",
          "orgId": "TEST1234"
        },
        "extraData": {
          "some": "Custom Property"
        }
      }
    ],
    "latestUpdateTimestamp": "2024-09-12T00:00:00.000Z"
  }
]