Saltar al contenido principal
POST
Confirm a Key Claim

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id
string<uuid>
requerido

Account ID (UUID format)

X-Reason
enum<string>
requerido

Reason for confirmation: USER_REQUESTED, ACCOUNT_CLOSURE, DEFAULT_OPERATION, FRAUD, or RECONCILIATION

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

Parámetros de ruta

claim_id
string<uuid>
requerido

Claim ID (UUID)

Respuesta

OK

accountId
string
requerido

Unique identifier of the account associated with this claim

Ejemplo:

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

bacenClaimId
string
requerido

BACEN DICT identifier for this claim

Ejemplo:

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

cancelReason
string
requerido

Reason for cancellation (if applicable)

Ejemplo:

""

cancelledBy
string
requerido

Who cancelled the claim (if applicable)

Ejemplo:

""

claimer
object
requerido

Account owner information

claimerAccount
object
requerido

Account information of the claimer

completionPeriodEnd
string<date-time>
requerido

Deadline for claim completion - D+14 from creation (ISO 8601 UTC)

Ejemplo:

"2020-09-14T13:48:55.970Z"

confirmReason
string
requerido

Reason the claim was confirmed

Ejemplo:

"DEFAULT_OPERATION"

createdAt
string<date-time>
requerido

Timestamp when the claim was created (ISO 8601 UTC)

Ejemplo:

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

donorParticipant
string
requerido

ISPB of the donor PSP (current key holder)

Ejemplo:

"30306294"

holderId
string
requerido

UUID of the account holder (claimer)

Ejemplo:

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

id
string
requerido

Internal UUID of the claim

Ejemplo:

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

key
string
requerido

The PIX key value (phone, email, CPF, CNPJ, or EVP)

Ejemplo:

"+5561988887777"

keyType
string
requerido

Type of PIX key

Ejemplo:

"PHONE"

resolutionPeriodEnd
string<date-time>
requerido

Deadline for donor response - D+7 from creation (ISO 8601 UTC)

Ejemplo:

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

status
string
requerido

Current status of the claim (should be CONFIRMED)

Ejemplo:

"CONFIRMED"

type
string
requerido

Type of claim (OWNERSHIP or PORTABILITY)

Ejemplo:

"OWNERSHIP"

updatedAt
string<date-time>
requerido

Timestamp when the claim was last updated (ISO 8601 UTC)

Ejemplo:

"2024-01-20T14:45:00Z"