Cancel claim
Cancels a claim. The cancelling side is derived from the authenticated participant; the reason (USER_REQUESTED or FRAUD) is validated against the claim type per the BACEN DICT reason×type matrix.
Authorizations
JWT bearer token issued by the identity provider.
Headers
Idempotency key, max 255 characters
Path Parameters
Claim UUID
Body
Cancellation reason. The cancelling side is derived from the authenticated participant, not this body.
Cancellation reason: USER_REQUESTED (participant withdrawal) or FRAUD (anti-fraud cancel, either side on either claim type)
"USER_REQUESTED"
Response
OK
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
""

