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".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
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.
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.
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.
USCCWSF01I00,USCCWSF01I01The 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.
1234,5678,7890The 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.
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"
}
}
]
}
]