Sign in

v1

latestOpenAPI 3.1.02026-08-061895260.0 KB
Accounts

Get a list of Account objects

Returns a list of account objects. An account object represents a person's bank accounts, debit and pay cards, and earnings balance accounts.

get/rest/accounts

Query parameters

filter[person.id]string uuid
Example:aa860051-c411-4709-9685-c1b716df611b

Limit the results to documents related to a specific person

filter[account_type]'EARNINGS_BALANCE' | 'DEPOSITORY' | 'CARD'
Example:EARNINGS_BALANCE

Limit the results to documents matching the specified account type.

filter[subtype]string
Example:ODP

Limit the results to documents matching the specified account subtype.

filterstring

Response

Returns the account object.