Retrieve bank account details

Returns the bank code (COMPE), branch, and account number for the credentialed account. Useful for displaying deposit instructions or reconciling inbound transfers without relying on PIX keys. accountNumber prefers the number recorded for this account when one exists (a document-level lookup can be ambiguous when the same tax id has more than one account); otherwise it uses the live lookup.

Returns the bank code (COMPE), branch, and account number for the credentialed account. Useful for displaying deposit instructions or reconciling inbound transfers without relying on PIX keys. `accountNumber` prefers the number recorded for this account when one exists (a document-level lookup can be ambiguous when the same tax id has more than one account); otherwise it uses the live lookup.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired

Account identifier.

Response headers

X-SourcestringOptional

Always live (real-time lookup at the banking partner).

Response

Bank account details retrieved.

accountIdstring

holderDocumentstring

CPF or CNPJ (digits only).

holderNamestring

bankCodestring

COMPE bank code (3 digits).

bankIspbstring

ISPB (8 digits).

bankNamestring

branchstring

Branch (agência) without check digit.

accountNumberstring

Bank account number. When a number is recorded for this specific account, that value is returned; otherwise the live lookup by document is used.

statusstring

Account status at the banking partner (active, inactive, blocked, closed).

Errors

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

501

Not Implemented Error

503

Service Unavailable Error

504

Gateway Timeout Error