Skip to main content
POST
Open a PIX key claim

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json
accountId
string
requerido

The CRM account id of the claimer.

Ejemplo:

"acc-123"

key
string
requerido

The PIX key to claim.

Ejemplo:

"11122233300"

Respuesta

Created

status
integer<int64>
requerido

Numeric eKeyStatus.

Ejemplo:

5

type
integer<int64>
requerido

Numeric eKeyType.

Ejemplo:

0

claimId
string

The created/associated claim id.

Ejemplo:

"claim-123"

key
string

The PIX key value.

Ejemplo:

"11122233300"

statusDescription
string

Human-readable eKeyStatus label.

Ejemplo:

"CLAIMER_PENDING_OWNER_GIVEAWAY"