Get PIX key
Reads one PIX key from this deployment’s own key registry and nowhere else: BACEN DICT is never called and no retained BACEN answer is consulted, so the read spends no DICT query token and needs no paying end user. The key is answered in any local status (ACTIVE or PENDING_CLAIM), with the participant’s requestId. X-ISPB names the participant asking, authorized like the update verb’s: this deployment’s own direct participant or an active indirect it sponsors (403 otherwise). A key bound to any other participant answers 404 exactly as a key with no row does, so its existence does not leak. The key travels percent-encoded as a path segment.
Autorizações
JWT bearer token issued by the identity provider.
Cabeçalhos
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.
^[0-9A-Z]{8}$"12345678"
Parâmetros de caminho
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
Key creation timestamp, RFC 3339 (UTC) — OUR row's local timestamp, not BACEN's; see creationDate for the DICT's own binding-creation instant.
"2025-03-07T14:30:00Z"
Unique PIX key identifier (UUID) assigned by the service.
"550e8400-e29b-41d4-a716-446655440000"
PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP (random key).
"CPF"
PIX key value in its canonical format for the key type.
"12345678901"
Full legal name of the key owner.
"João Silva"
Owner tax identifier: 11 digits for a CPF, 14 alphanumeric characters for a CNPJ (IN RFB 2.229/2024).
"12345678901"
Owning participant ISPB, the BACEN institution identifier (8 digits or uppercase letters).
"12345678"
Key lifecycle status: ACTIVE or PENDING_CLAIM.
"ACTIVE"
Timestamp of the last update to the key, RFC 3339 (UTC).
"2025-03-07T14:30:00Z"
Account number (1..20 digits), omitted for a tuple-less key.
"9988776"
BACEN account type (CACC, SVGS, TRAN, SLRY, OTHR), omitted for a tuple-less key.
CACC, SVGS, TRAN, SLRY, OTHR "CACC"
BACEN's own operational envelope for its most recent interaction on this key; omitted when no BACEN interaction has ever landed on it.
Account branch (1..4 digits), omitted when unset.
"0001"
BACEN's own creation instant for this key/account/owner binding, as the DICT answered it; omitted when BACEN's answer carried none.
"2020-01-15T00:00:00Z"
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.
"2020-01-15T00:00:00Z"
Account opening date, RFC 3339, omitted for a tuple-less key.
"2020-01-15T00:00:00Z"
Owner trade name (legal-entity owners), omitted when unset.
"Silva ME"
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.
NATURAL_PERSON, LEGAL_PERSON "NATURAL_PERSON"
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.
"b2696bf1-0a51-48b0-ab4a-8af2dff440af"

