Retrieve a bank account

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

bank_account

string

required

Query Parameters

expand

enum<string>[]

Available options:

business_entity,

contractor,

employee

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

The type of the object in Nmbr ("bank_account").

data

Default · object

Default
With employee expanded
With contractor expanded
With business_entity expanded

Hide child attributes

data.business_entity

object

The Business Entity that owns this bank account. Present only for Business Entity bank accounts.

Hide child attributes

data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.business_entity.object

string

read-only

The type of the object in Nmbr ("business_entity").

data.institution_number

string

The 3-digit bank institution number.

data.institution_name

string | null

The name of the banking institution matching the institution number, or null if the number is not recognized. Always the English name; see institution_name_translated for the value in the request's locale.

data.institution_name_translations

object

Hide child attributes

data.institution_name_translations.en

string | null

data.institution_name_translations.fr

string | null

data.institution_name_translated

string

read-only

The translation of the institution_name property for the request locale. Computed using the values in institution_name and institution_name_translations and the value of the request's Accept-Language header.

data.transit_number

string

The 5-digit bank transit number.

data.transit_address

string | null

The address of the branch matching the institution and transit numbers, or null if the pair is not recognized.

data.account_number_last_3

string | null

The last 3 digits of the bank account number.

data.is_primary

boolean

Whether this is the primary bank account for its owner.

data.is_deletable

boolean

Whether this bank account can be deleted.

data.warnings

object

A collection of data validation warnings for this bank account. Warnings indicate incomplete or potentially incorrect data, such as an unrecognized institution or transit number.

Hide child attributes

data.warnings.object

string | null

data.warnings.data

object

data.is_pad_signed

boolean

Whether a PAD agreement has been signed. Only present for Business Entity bank accounts.

data.pad_signer_name

string | null

The name of the person who signed the PAD agreement. Only applicable to Business Entity bank accounts.

Maximum string length: 255

data.pad_signer_email

string | null

The email address of the PAD agreement signer. Only applicable to Business Entity bank accounts.

Maximum string length: 255

data.pad_signer_title

string | null

The title or role of the PAD agreement signer. Only applicable to Business Entity bank accounts.

Maximum string length: 255

data.pad_signed_at

string<dateTime> | null

read-only

The date and time the PAD agreement was signed. Only applicable to Business Entity bank accounts.

data.pad_file

any

The signed PAD agreement file. Only present for Business Entity bank accounts.

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.