Skip to main content
POST
Confirmar reivindicação

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Idempotency-Key
string

Idempotency key, max 255 characters

Parâmetros de caminho

claimID
string
obrigatório

Claim UUID

Corpo

application/json

Optional empty body; the decision is determined by the operation path (confirm/reject/acknowledge/complete)

Resposta

OK

Claim record with its current status and deadlines

claimType
string
obrigatório

Claim kind: OWNERSHIP or PORTABILITY

Exemplo:

"OWNERSHIP"

claimerISPB
string
obrigatório

ISPB (8 numeric digits) of the participant initiating the claim

Exemplo:

"12345678"

deadline
string
obrigatório

Donor-response deadline, seven days after initiation (RFC 3339, UTC)

Exemplo:

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

donorISPB
string
obrigatório

ISPB (8 numeric digits) of the current key owner (donor), resolved during initiation

Exemplo:

"87654321"

id
string
obrigatório

Server-assigned claim UUID

Exemplo:

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

keyType
string
obrigatório

PIX key type: CPF, CNPJ, EMAIL, PHONE, or EVP

Exemplo:

"CPF"

keyValue
string
obrigatório

PIX key value under claim

Exemplo:

"12345678901"

requestedAt
string
obrigatório

Claim initiation timestamp (RFC 3339, UTC)

Exemplo:

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

status
string
obrigatório

Claim lifecycle state: OPEN, WAITING_RESOLUTION, CONFIRMED, CANCELLED, or COMPLETED

Exemplo:

"OPEN"

resolution
string

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

Exemplo:

""

resolvedAt
string

Resolution timestamp (RFC 3339, UTC); omitted while the claim is unresolved

Exemplo:

""