Endpoint

POST /v3/dict/claim/{pix_key_claim_id}/confirm

Headers

Path Parameters

Request Examples

Confirm claim:

POST /v3/dict/claim/abc123def456ghi789/confirm
Authorization: Bearer access_token_here
hmac: computed_hmac_signature
Content-Type: application/json

Important: This endpoint has no request body. Authentication is done via headers only. The HMAC signature must be computed over the JSON payload: {"claim_id": "value"} where value matches the claim ID in the path parameter.

Response Details

{
  "worked": true,
  "pix_key_claim_id": "abc123def456ghi789",
  "claim_id": "123e4567-e89b-12d3-a456-426655440000",
  "status": "CONFIRMED",
  "confirmation_reason": "USER_REQUESTED",
  "resolution_deadline": "2024-12-31T23:59:59.999Z",
  "conclusion_deadline": "2025-01-02T23:59:59.999Z",
  "last_modification_datetime": "2024-12-24T14:30:00.000Z",
  "message": "Claim confirmed successfully in the DICT."
}

Error Responses

| 400 | Claim can only be confirmed in status WAITING_RESOLUTION | Claim is not in the correct status to be confirmed. Current status must be WAITING_RESOLUTION |
| 400 | Claim has no DICT claim_id | The claim does not have a DICT identifier yet and cannot be confirmed |
| 400 | Only donor role records can be confirmed | This endpoint can only be used by the donor (current key holder), not the claimer |
| 401 | Unauthorized | Invalid or missing authentication token, or invalid HMAC signature |
| 404 | Pix key claim not found | The claim ID was not found, or does not belong to the authenticated company, or user lacks permission |
| 422 | Validation error | Request validation failed. Check that all required fields are present and in the correct format. |

Business Rules

Who Can Confirm:

• Only the donor (current key holder) can confirm a claim
• You must have access to the account associated with the claim
• User must be authenticated and authorized

When to Confirm:

• Claim must be in WAITING_RESOLUTION status
• This means the donor has already "read" the claim notification
• Claims in OPEN status must first transition to WAITING_RESOLUTION (happens automatically when donor first views the claim)

Authentication Requirements:

• Must provide valid hmac header
• HMAC must be computed over the JSON: {"claim_id": "actual_claim_id_value"}
• The claim_id value must match the path parameter

Effect of Confirmation:

• Updates claim status to CONFIRMED
• Records confirmation reason as USER_REQUESTED
• Updates deadlines as provided by DICT
• For portability claims: Key transfer happens automatically after confirmation
• For ownership claims: Claimer must still conclude the process with verification

Related Key Operations:

• For portability claims, the original PIX key in the donor's account is automatically deactivated upon confirmation
• Claimer will receive the key once the process completes

Important Notes:

• This operation cannot be undone once confirmed
• After confirmation, the claim can no longer be cancelled by the donor
• For ownership claims, the claimer has a limited time (typically 2 days) to conclude after confirmation
• The confirmation is recorded with the authenticated user's ID for audit purposes