Pular para o conteúdo principal
GET
Get PIX key

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-ISPB
string
obrigatório

ISPB of the participant asking: this deployment's own direct participant or an active indirect it sponsors. Only a key bound to exactly this participant is answered.

Pattern: ^[0-9A-Z]{8}$
Exemplo:

"12345678"

Parâmetros de caminho

key
string
obrigatório

PIX key value, percent-encoded as a path segment (an e-mail's '@' and '+', a phone's leading '+'); matched in canonical form, as the registry stores it.

Resposta

OK

The PIX key as this deployment's registry holds it, in any local status

createdAt
string
obrigatório

Key creation timestamp, RFC 3339 (UTC) — OUR row's local timestamp, not BACEN's; see creationDate for the DICT's own binding-creation instant.

Exemplo:

"2025-03-07T14:30:00Z"

id
string
obrigatório

Unique PIX key identifier (UUID) assigned by the service.

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

keyType
string
obrigatório

PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP (random key).

Exemplo:

"CPF"

keyValue
string
obrigatório

PIX key value in its canonical format for the key type.

Exemplo:

"12345678901"

ownerName
string
obrigatório

Full legal name of the key owner.

Exemplo:

"João Silva"

ownerTaxId
string
obrigatório

Owner tax identifier: 11 digits for a CPF, 14 alphanumeric characters for a CNPJ (IN RFB 2.229/2024).

Exemplo:

"12345678901"

participantISPB
string
obrigatório

Owning participant ISPB, the BACEN institution identifier (8 digits or uppercase letters).

Exemplo:

"12345678"

status
string
obrigatório

Key lifecycle status: ACTIVE or PENDING_CLAIM.

Exemplo:

"ACTIVE"

updatedAt
string
obrigatório

Timestamp of the last update to the key, RFC 3339 (UTC).

Exemplo:

"2025-03-07T14:30:00Z"

accountNumber
string

Account number (1..20 digits), omitted for a tuple-less key.

Exemplo:

"9988776"

accountType
enum<string>

BACEN account type (CACC, SVGS, TRAN, SLRY, OTHR), omitted for a tuple-less key.

Opções disponíveis:
CACC,
SVGS,
TRAN,
SLRY,
OTHR
Exemplo:

"CACC"

bacen
object

BACEN's own operational envelope for its most recent interaction on this key; omitted when no BACEN interaction has ever landed on it.

branch
string

Account branch (1..4 digits), omitted when unset.

Exemplo:

"0001"

creationDate
string<date-time>

BACEN's own creation instant for this key/account/owner binding, as the DICT answered it; omitted when BACEN's answer carried none.

Exemplo:

"2020-01-15T00:00:00Z"

keyOwnershipDate
string<date-time>

Instant from which the owner has held uninterrupted possession of this key per BACEN; may differ from creationDate after a portability. Omitted when BACEN's answer carried none.

Exemplo:

"2020-01-15T00:00:00Z"

openingDate
string<date-time>

Account opening date, RFC 3339, omitted for a tuple-less key.

Exemplo:

"2020-01-15T00:00:00Z"

ownerTradeName
string

Owner trade name (legal-entity owners), omitted when unset.

Exemplo:

"Silva ME"

ownerType
enum<string>

BACEN's own Person discriminator for the owner, as the DICT published it — not the value the registration declared, which is refused when the two could disagree. Omitted when BACEN's answer carried none.

Opções disponíveis:
NATURAL_PERSON,
LEGAL_PERSON
Exemplo:

"NATURAL_PERSON"

requestId
string<uuid>

The participant's own identifier for the registration that created this binding, echoed back. It is the value BACEN holds against the vinculo for life, so it is what a DICT support case and a retry are addressed by. Omitted for a key registered before this field existed, which had no caller to state one.

Exemplo:

"b2696bf1-0a51-48b0-ab4a-8af2dff440af"