Skip to main content
POST
Open a PIX key claim

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
accountId
string
required

The CRM account id of the claimer.

Example:

"acc-123"

key
string
required

The PIX key to claim.

Example:

"11122233300"

Response

Created

status
integer<int64>
required

Numeric eKeyStatus.

Example:

5

type
integer<int64>
required

Numeric eKeyType.

Example:

0

claimId
string

The created/associated claim id.

Example:

"claim-123"

key
string

The PIX key value.

Example:

"11122233300"

statusDescription
string

Human-readable eKeyStatus label.

Example:

"CLAIMER_PENDING_OWNER_GIVEAWAY"