Skip to main content
POST
cURL with fictitious data

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key
string
required

Client-generated key used to retry exactly the same request safely.

Required string length: 1 - 64
X-Account-Id
string
required

UUID of the account associated with the operation.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Body

application/json
key
string
required

The Pix key being claimed

Example:

"+5511987654321"

type
string
required

Claim type: PORTABILITY or OWNERSHIP

Example:

"OWNERSHIP"

Response

Created

accountId
string
required
Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

bacenId
string
required
Example:

"claim-bacen-001"

claimId
string
required
Example:

"019606c3-5d6e-7f80-1b23-456789012cde"

claimer
object
required
createdAt
string
required
Example:

"2026-05-19T14:30:00Z"

donorParticipant
string
required
Example:

"12345678"

keyType
string
required
Example:

"PHONE"

keyValue
string
required
Example:

"+5511987659999"

lastModified
string
required
Example:

"2026-05-19T14:32:11Z"

status
string
required
Example:

"WAITING_RESOLUTION"

type
string
required
Example:

"PORTABILITY"

updatedAt
string
required
Example:

"2026-05-19T14:32:11Z"

cancelReason
string
cancelledBy
string
completionPeriodEnd
string
Example:

"2026-06-18T03:00:00Z"

confirmReason
string
correlationId
string
Example:

"a9f13566e19f5ca51329479a5bae60c5"

requestId
string
Example:

"e7c1a2b3-4d5e-6f70-8a90-1b2c3d4e5f60"

resolutionPeriodEnd
string
Example:

"2026-05-25T03:00:00Z"