Skip to main content
GET
Look up a PIX key.

Authorizations

X-API-Key
string
header
required

API Key

Headers

X-API-Version
string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01, 2026-08-01.

Query Parameters

pix_key_type
enum<string>
required

Which PIX key format pix_key is PIX Key Type

Which of the five PIX key formats pix_key is, for GET /pix-key-info. Declared explicitly by the caller rather than guessed from the string's shape, mirroring the tags ApiPixAccountIdentifier uses at registration.

Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
pix_key
string
required

The PIX key to resolve, in the format pix_key_type declares

Response

Lookup succeeded

PIX Key Info

Holder/bank info a PIX key resolves to.

bank_name
string
required

Receiving bank's name

ispb
string
required

8-digit ISPB bank code

name
string
required

Account holder's full name