--- updatedAt: 2026-06-11T16:01:54.000Z --- Fetch the complete documentation index at: https://simpay-prod.readme.io/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version. # Confirm PIX Key Claim Confirm a PIX key claim as the donor (current key holder). This endpoint is used by the donor to explicitly confirm that they agree to transfer the key to the claimer. ## Endpoint ``` POST /v3/dict/claim/{pix_key_claim_id}/confirm ``` ## Headers | Parameter | Type | Description | Example | | :---------------- | :----- | :---------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authorization** | String | Bearer + Access\_token | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo | | **hmac** | String | HMAC signature for request authentication | hmac: 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6 | ## Path Parameters | Parameter | Type | Description | Example | | :---------------------- | :----- | :-------------------------------------- | :----------------- | | **pix\_key\_claim\_id** | String | The internal ID of the claim to confirm | abc123def456ghi789 | ## Request Examples **Confirm claim:** ```http 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 ```json Response { "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." } ``` | Field | Type | Description | | :------------------------------- | :------ | :------------------------------------------------------------------------- | | **worked** | Boolean | Always `true` for successful requests. | | **pix\_key\_claim\_id** | String | Internal database ID for this claim record | | **claim\_id** | String | DICT claim identifier (UUID format) | | **status** | String | Updated claim status. Should be `CONFIRMED` after successful confirmation | | **confirmation\_reason** | String | Reason for confirmation. Always `USER_REQUESTED` for this operation | | **resolution\_deadline** | String | Deadline for resolution (ISO 8601 format) | | **conclusion\_deadline** | String | Deadline for claimer to conclude (ownership claims only - ISO 8601 format) | | **last\_modification\_datetime** | String | Timestamp of the last modification in DICT (ISO 8601 format) | | **message** | String | Informative message about the operation result | ## Error Responses | HTTP Code | Error Message | Description | | :-------- | :---------------- | :--------------------------------------------------------------- | | 400 | Company not found | The company associated with the authenticated user was not found | \| 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 # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "3.0.0", "title": "Banking & PIX API", "description": "Complete API documentation for the banking and PIX payment platform." }, "servers": [ { "url": "https://api.somossimpay.com.br/" } ], "security": [], "tags": [ { "name": "DICT-API", "description": "DICT-API endpoints" } ], "paths": { "/v3/dict/claim/{pix_key_claim_id}/confirm": { "post": { "operationId": "post_dict_claim_pix_key_claim_id_confirm", "summary": "Confirm PIX Key Claim", "description": "Confirm a PIX key claim as the donor (current key holder). This endpoint is used by the donor to explicitly confirm that they agree to transfer the key to the claimer.", "tags": [ "DICT-API" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request - Invalid parameters" }, "401": { "description": "Unauthorized - Invalid or missing authentication" }, "500": { "description": "Internal server error" } }, "parameters": [ { "name": "pix_key_claim_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The pix_key_claim_id identifier" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "x-readme": { "explorer-enabled": false, "proxy-enabled": true, "samples-languages": [ "curl", "python", "javascript", "java", "go" ] } } ```