API Internet BankingAccounts

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.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

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