custody/accounts

This endpoint retrieves a list of custody accounts. It supports pagination, filtering, and sorting capabilities.

Log in to see full request history

Response Structure

{ "statusCode": "101", "statusDesc": "Ok", "custody_accounts": [ { "accountId": "A00000003", "requestId": "1BIBe0V", "status": "Approved", "relationship": null, "restrictedStatus": "No", "restrictedReason": null, "principalReviewBy": "", "approvalDate": "2025-02-12 17:11:18", "notes": "", "createdDate": "2025-02-12 17:11:17", "updatedDate": "2025-02-12 17:11:18" } ], "pagination": { "totalRecords": 1001, "startIndex": 0, "endIndex": 0 } }

Examples

  1. Basic query (default behavior):
GET /v3/custody/accounts
  1. Limit the number of results:
GET /v3/custody/accounts?limit=1
  1. Use limit and offset for pagination:
GET /v3/custody/accounts?limit=1&offset=2

Permissions

This method requires the scopecustody_account.read.pii_mediumto be granted to the calling API key.

This scope can be assigned by system admins through the API or Transact Portal.

Filtering

For more information on filtering see

Working with List Endpoints

Query Params
int32
Defaults to 10

The maximum number of accounts to return. Max value is 500.

int32
Defaults to 0

The row index at which to begin the query. Zero represents the first account in the list.

string
string
boolean
Defaults to false

Include deleted accounts in response

Headers
string
Defaults to Bearer

Bearer token in the format "Bearer clientId:apiKey"

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json