Iniciar reivindicação
Inicia uma nova reivindicação de titularidade ou portabilidade de chave PIX para o participante identificado na rota. Os prazos da reivindicação são de sete dias corridos e a igualdade de ISPB entre reivindicante e doador é rejeitada pela validação de domínio.
Autorizações
JWT bearer token issued by the identity provider.
Cabeçalhos
Idempotency key, max 255 characters
Parâmetros de caminho
Claiming participant ISPB (8 numeric digits)
Corpo
PIX key ownership or portability claim to initiate (seven-day deadline; claimer and donor ISPB must differ)
Claim kind: OWNERSHIP (dispute the current owner) or PORTABILITY (move an existing key to this participant)
"OWNERSHIP"
PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP
"CPF"
PIX key value being claimed (format depends on keyType: CPF, CNPJ, EMAIL, PHONE, or EVP)
"12345678901"
Resposta
Created
Claim record with its current status and deadlines
Claim kind: OWNERSHIP or PORTABILITY
"OWNERSHIP"
ISPB (8 numeric digits) of the participant initiating the claim
"12345678"
Donor-response deadline, seven days after initiation (RFC 3339, UTC)
"2025-03-14T14:30:00Z"
ISPB (8 numeric digits) of the current key owner (donor), resolved during initiation
"87654321"
Server-assigned claim UUID
"550e8400-e29b-41d4-a716-446655440000"
PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP
"CPF"
PIX key value under claim
"12345678901"
Claim initiation timestamp (RFC 3339, UTC)
"2025-03-07T14:30:00Z"
Claim lifecycle state: OPEN, WAITING_RESOLUTION, CONFIRMED, CANCELLED, or COMPLETED
"OPEN"
Terminal resolution reason (e.g. DONOR_CONFIRMED, CANCELLED_BY_CLAIMER, CANCELLED_BY_CLAIMER_FRAUD, CANCELLED_BY_DONOR, CANCELLED_BY_DONOR_FRAUD, DEADLINE_EXPIRED); empty until the claim resolves
""
Resolution timestamp (RFC 3339, UTC); omitted while the claim is unresolved
""

