Pular para o conteúdo principal
POST
Create a Key Claim

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Account-Id
string<uuid>
obrigatório

Account ID (UUID format)

X-Reason
enum<string>
obrigatório

Reason for claim: USER_REQUESTED, ACCOUNT_CLOSURE, DEFAULT_OPERATION, FRAUD, RECONCILIATION

Opções disponíveis:
USER_REQUESTED,
ACCOUNT_CLOSURE,
DEFAULT_OPERATION,
FRAUD,
RECONCILIATION

Corpo

application/json
key
string
obrigatório

Pix key value to claim (phone, email, CPF, CNPJ, or EVP)

Minimum string length: 1
Exemplo:

"+5561988887777"

type
enum<string>
obrigatório

Type of claim (OWNERSHIP or PORTABILITY)

Opções disponíveis:
OWNERSHIP,
PORTABILITY
Minimum string length: 1
Exemplo:

"OWNERSHIP"

Resposta

Created

accountId
string
obrigatório

Unique identifier of the account

Exemplo:

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

bacenClaimId
string
obrigatório

BACEN DICT identifier for this claim

Exemplo:

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

cancelReason
enum<string>
obrigatório

Reason provided when the claim was cancelled

Opções disponíveis:
USER_REQUESTED,
ACCOUNT_CLOSURE,
DEFAULT_OPERATION,
FRAUD,
RECONCILIATION,
COURT_ORDER,
PARTICIPANT_EXCLUSION
Exemplo:

"FRAUD"

cancelledBy
enum<string>
obrigatório

Who cancelled the claim (donor PSP or claimer PSP)

Opções disponíveis:
DONOR,
CLAIMER
Exemplo:

"DONOR"

claimer
object
obrigatório

Account owner information

claimerAccount
object
obrigatório

Account information of the claimer

completedAt
string<date-time>
obrigatório

Timestamp when the claim was completed

Exemplo:

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

completionPeriodEnd
string<date-time>
obrigatório

Deadline for completing the claim process (D+14 from creation)

Exemplo:

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

confirmReason
enum<string>
obrigatório

Reason provided when the claim was confirmed

Opções disponíveis:
USER_REQUESTED,
ACCOUNT_CLOSURE,
DEFAULT_OPERATION,
FRAUD,
RECONCILIATION
Exemplo:

"DEFAULT_OPERATION"

createdAt
string<date-time>
obrigatório

Timestamp when the claim was created

Exemplo:

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

donorParticipant
string
obrigatório

ISPB of the donor PSP that currently holds the key

Exemplo:

"30306294"

holderId
string
obrigatório

Unique identifier of the account holder

Exemplo:

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

id
string
obrigatório

Unique identifier of the claim

Exemplo:

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

key
string
obrigatório

Pix key value being claimed

Exemplo:

"+5561988887777"

keyType
enum<string>
obrigatório

Type of Pix key being claimed

Opções disponíveis:
PHONE,
EMAIL,
CPF,
CNPJ,
EVP
Exemplo:

"PHONE"

resolutionPeriodEnd
string<date-time>
obrigatório

Deadline for donor PSP to respond (D+7 from creation)

Exemplo:

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

status
enum<string>
obrigatório

Current status of the claim

Opções disponíveis:
OPEN,
WAITING_RESOLUTION,
CONFIRMED,
CANCELLED,
COMPLETED
Exemplo:

"OPEN"

type
enum<string>
obrigatório

Type of claim being processed

Opções disponíveis:
OWNERSHIP,
PORTABILITY
Exemplo:

"OWNERSHIP"

updatedAt
string<date-time>
obrigatório

Timestamp when the claim was last updated

Exemplo:

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