Pix - solicitar portabilidade/reivindicação de chave

Inicia uma portabilidade (a chave está em outro PSP e o cliente quer
trazê-la para a Autra) ou reivindicação (apenas para telefone).

Tipos de chave aceitos (keyType):

  • national_registration — CPF/CNPJ. Só aceita claimType: PORTABILITY.
  • email — só aceita claimType: PORTABILITY.
  • phone_number — aceita PORTABILITY ou KEY_TRANSFER.

Chave aleatória (EVP) não é portável.

deviceId é obrigatório (BACEN Resolução 491) — use um device
autorizado da conta. Tela típica do app: depois do scan da chave/dado
em outro banco, antes de confirmar a portabilidade, captura o device id
e envia neste POST.

Fluxo

  1. Cliente solicita → este endpoint cria a claim no DICT da Autra/Autra.
  2. PSP atual da chave (doador) recebe a notificação e tem 7 dias
    para confirmar/contestar. O cliente normalmente confirma no app do
    PSP doador (tela tipo "autorizar portabilidade de chave Pix sainte").
  3. Quando o status mudar (COMPLETED, DENIED, etc.), a Autra dispara
    o webhook outbound pix_keys.claim.{completed|denied|confirmed}
    pro BFF do tenant. Consultar GET /pix-keys/claims também devolve
    o status atual (fonte de verdade = DICT/Autra).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params
string
enum
required
Allowed:
string
required

Valor da chave: CPF/CNPJ só dígitos; e-mail no formato padrão;
telefone em E.164 (+5511999999999).

string
enum
Defaults to PORTABILITY

PORTABILITY (default) — trazer a chave de outra instituição.
KEY_TRANSFER — só telefone, reivindicação de posse.

Allowed:
string
required

Device autorizado da conta (BACEN 491).

string

Texto livre, opcional (rastreabilidade).

Responses

400

Validação falhou (keyType inválido, key vazia, deviceId ausente etc.).

401

Token ausente ou inválido.

404

Conta não encontrada para este tenant.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json