Register PIX key
Registers a new PIX key after validating the request, enforcing owner limits, and successfully synchronizing with BACEN DICT. Registration fails closed if BACEN DICT is unavailable or rejects the key.
Authorizations
JWT bearer token issued by the identity provider.
Headers
Idempotency key, max 255 characters
Body
PIX key to register (key type, value, owner identity, and participant ISPB); registration fails closed if BACEN DICT rejects or is unavailable
Account number (1..20 digits).
"9988776"
BACEN account type: CACC (current), TRAN (transactional), SLRY (salary), or SVGS (savings).
CACC, TRAN, SLRY, SVGS "CACC"
PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP (random key).
"CPF"
PIX key value, formatted according to keyType (e.g. 11 digits for CPF, E.164 for PHONE, an email address for EMAIL).
"12345678901"
Account opening date, RFC 3339 (the FI account's opening date, not the key's creation moment).
"2020-01-15T00:00:00Z"
Full legal name of the key owner.
"João Silva"
Owner tax identifier (CPF for individuals, CNPJ for businesses), digits only.
"12345678901"
Owning participant ISPB, the 8-digit BACEN institution identifier.
"12345678"
Account branch (1..4 digits), optional.
"0001"
Owner trade name (legal-entity / CNPJ owners), optional.
"Silva ME"
Response
Created
Registered PIX key with its assigned status
Key creation timestamp, RFC 3339 (UTC).
"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 (CPF or CNPJ), digits only.
"12345678901"
Owning participant ISPB, the 8-digit BACEN institution identifier.
"12345678"
Key lifecycle status: ACTIVE, INACTIVE, PENDING_CLAIM, or PENDING_BACEN_SYNC.
"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, TRAN, SLRY, SVGS), omitted for a tuple-less key.
CACC, TRAN, SLRY, SVGS "CACC"
Account branch (1..4 digits), omitted when unset.
"0001"
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"

