Skip to main content
POST
Open a PIX key claim

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json
accountId
string
obrigatório

The CRM account id of the claimer.

Exemplo:

"acc-123"

key
string
obrigatório

The PIX key to claim.

Exemplo:

"11122233300"

Resposta

Created

status
integer<int64>
obrigatório

Numeric eKeyStatus.

Exemplo:

5

type
integer<int64>
obrigatório

Numeric eKeyType.

Exemplo:

0

claimId
string

The created/associated claim id.

Exemplo:

"claim-123"

key
string

The PIX key value.

Exemplo:

"11122233300"

statusDescription
string

Human-readable eKeyStatus label.

Exemplo:

"CLAIMER_PENDING_OWNER_GIVEAWAY"