Skip to main content
POST
Look up bank account details

Authorizations

Authorization
string
header
required

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

Body

application/json
institution_number
string

The 3-digit institution number to look up. Optional.

transit_number
string

The 5-digit transit number to look up. Optional. Resolves a branch address only when sent alongside a recognised institution number.

account_number
string

The account number to validate. Optional. Checked against the check-digit rules published for the given institution.

transaction_type
enum<string>

How the account will be used. Optional, defaults to credit. Send credit for an account that receives payments, such as an employee's or contractor's, and debit for an account that payroll is funded from, such as a business's. Some institutions have account numbers that accept credits only, which warn as invalid for debit.

Available options:
credit,
debit

Response

200 - application/json

OK

id
string
read-only

The unique identifier of the object in Nmbr.

object
string
read-only

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

data
Bank Account Lookup · object