AM/FA/Inv -Get Custodian Details

Details

/external/v1/custodian

Synopsis

Get Custodian Details

get

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

Authorizations

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.

custodianIdsFilterstringOptional

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

Example: USCCWSF01I00,USCCWSF01I01

custodianCorrelationIdsFilterstringOptional

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

Example: 1234,5678,7890

custodianCorrelationOrgIdstring · max: 12Optional

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

Responses

200

Successfully retrieved custodian details

application/json

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

HTTPcURLJavaScriptPython

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

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "secureExtraData": {
      "some": "Sensitive Data"
    },
    "name": "text",
    "contactInfo": {
      "email": "[email protected]",
      "phoneNumber": "832-426-4242"
    },
    "tin": "98567804",
    "custodianId": "text",
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    },
    "correlationData": [
      {
        "correlationId": "123245573717",
        "origin": "Identifies custodian on backoffice",
        "organization": {
          "name": "Test Organization",
          "orgId": "TEST1234"
        },
        "extraData": {
          "some": "Custom Property"
        }
      }
    ]
  }
]