v1

latestOpenAPI 3.1.02026-07-26457177.8 KB

Accounts

Get a Specific Account for a User

📘

You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

This endpoint retrieves a specific Account for a User based on the Account ID.

get/v1/accounts/{id}

Path parameters

idstring required

The unique ID of the Account

Response

Successful response

idstring

The unique ID of the Account

status'approved' | 'rejected' | 'unreviewed'

The status of the underlying account. Only accounts with a status of approved can be used in routines.

removedboolean

Value of true if the account has been deleted/removed.

official_namestring

The official name of the Account from the Institution

namestring

The name of the Account from the Institution

nicknamestring

The name of the Account defined by the User

maskstring

The last four digits of the Account number

institution_namestring

The name of the Institution where the Account is held

institution_logostring

The Institution logo in base64 format

typestring

The category of the Account type (ie. depository)

subtypestring

The sub category of the Account type (ie. checking)

current_balancenumber float

The value of the current balance for the Account

available_balancenumber float

The value of the available balance for the Account

{"stackTrail":"paths:/v1/accounts/{id}:get:responses:200:content:application/json:schema:properties:last_balance_update_on","oasType":"schema","type":"unknown","description":"The last update for the Account object from the Institution"}

connection_statusstring

The current status of the account (connected or error)