Complete a Key Claim

Use this endpoint to complete a claim by the claimer. As a result, the link between the key and the claiming party is created.

POST /v1/dict/claims/{claim_id}/complete

Complete a Key Claim

cURL

curl --request POST \
  --url https://api.example.com/v1/dict/claims/{claim_id}/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

200

{
  "accountId": "550e8400-e29b-41d4-a716-446655440002",
  "bacenClaimId": "cc91b1b0-8465-44b1-a760-15dd3717ea9b",
  "cancelReason": "FRAUD",
  "cancelledBy": "DONOR",
  "claimer": {
    "document": "52998224725",
    "name": "Antonio Jose Raimundo",
    "type": "NATURAL_PERSON"
  },
  "claimerAccount": {
    "branch": "0001",
    "number": "2227654330",
    "openingDate": "2020-08-17T13:48:36Z",
    "participant": "30306294",
    "type": "TRAN"
  },
  "completedAt": "2020-08-31T13:48:55Z",
  "completionPeriodEnd": "2020-09-07T13:48:55Z",
  "confirmReason": "DEFAULT_OPERATION",
  "createdAt": "2020-08-17T13:48:36Z",
  "donorParticipant": "12345678",
  "holderId": "550e8400-e29b-41d4-a716-446655440001",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "[phone]",
  "keyType": "PHONE",
  "resolutionPeriodEnd": "2020-08-24T13:48:55Z",
  "status": "COMPLETED",
  "type": "PORTABILITY",
  "updatedAt": "2020-08-17T14:00:00Z"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id · string<uuid> · requerido

Account ID (UUID format)

Parámetros de ruta

claim_id · string<uuid> · requerido

Claim ID (UUID)

Respuesta

200

application/json

OK

accountId · string · requerido

Unique identifier of the account associated with this claim

Ejemplo:

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

bacenClaimId · string · requerido

BACEN DICT claim identifier (UUID)

Ejemplo:

"cc91b1b0-8465-44b1-a760-15dd3717ea9b"

cancelReason · enum<string> · requerido

Reason for cancellation

Opciones disponibles: USER_REQUESTED, ACCOUNT_CLOSURE, DEFAULT_OPERATION, FRAUD, RECONCILIATION, COURT_ORDER, PARTICIPANT_EXCLUSION

Ejemplo:

"FRAUD"

cancelledBy · enum<string> · requerido

Who cancelled the claim (DONOR or CLAIMER)

Opciones disponibles: DONOR, CLAIMER

Ejemplo:

"DONOR"

claimer · object · requerido

Account owner information

Show child attributes

claimerAccount · object · requerido

Account information of the claimer

Show child attributes

completedAt · string<date-time> · requerido

Completion timestamp (ISO 8601 UTC)

Ejemplo:

"2020-08-31T13:48:55Z"

completionPeriodEnd · string<date-time> · requerido

Completion deadline - D+14 (ISO 8601 UTC)

Ejemplo:

"2020-09-07T13:48:55Z"

confirmReason · enum<string> · requerido

Reason for confirmation

Opciones disponibles: USER_REQUESTED, ACCOUNT_CLOSURE, DEFAULT_OPERATION, FRAUD, RECONCILIATION

Ejemplo:

"DEFAULT_OPERATION"

createdAt · string<date-time> · requerido

Creation timestamp (ISO 8601 UTC)

Ejemplo:

"2020-08-17T13:48:36Z"

donorParticipant · string · requerido

ISPB of the donor PSP (8 uppercase alphanumeric characters)

Ejemplo:

"12345678"

holderId · string · requerido

Account holder identifier (UUID)

Ejemplo:

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

id · string · requerido

Internal claim identifier (UUID)

Ejemplo:

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

key · string · requerido

PIX key value

Ejemplo:

"[phone]"

keyType · enum<string> · requerido

Type of PIX key

Opciones disponibles: PHONE, EMAIL, CPF, CNPJ, EVP

Ejemplo:

"PHONE"

resolutionPeriodEnd · string<date-time> · requerido

Resolution deadline - D+7 (ISO 8601 UTC)

Ejemplo:

"2020-08-24T13:48:55Z"

status · enum<string> · requerido

Current status of the claim

Opciones disponibles: OPEN, WAITING_RESOLUTION, CONFIRMED, CANCELLED, COMPLETED

Ejemplo:

"COMPLETED"

type · enum<string> · requerido

Claim type (OWNERSHIP or PORTABILITY)

Opciones disponibles: OWNERSHIP, PORTABILITY

Ejemplo:

"PORTABILITY"

updatedAt · string<date-time> · requerido

Last update timestamp (ISO 8601 UTC)

Ejemplo:

"2020-08-17T14:00:00Z"