POST
/
v1
/
claims
Create Claim
curl --request POST \
  --url http://localhost:4011/v1/claims \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "12345678901",
  "accountId": "0198f132-090a-7e01-85cb-839462585613"
}'
{
  "key": "11122233344",
  "type": 0,
  "status": "<any>",
  "claimId": "claim-abcd1234-5678-9012-3456-789012345678",
  "statusString": "OPEN"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Body

application/json
​
key
string
required

Pix key to claim

Example:

"12345678901"

​
accountId
string<uuid>
required

Account ID making the claim

Example:

"0198f132-090a-7e01-85cb-839462585613"

Response

Claim initiated successfully

​
key
string

Claimed Pix key

Example:

"11122233344"

​
type
enum<integer>

Pix key type enumeration (0- REGISTRATION_NUMBER, 1- TAX_IDENTIFIER, 2- EMAIL, 3- PHONE, 4- RANDOM).

Available options:
0,
1,
2,
3,
4
​
status
any
​
claimId
string

Unique claim identifier

Example:

"claim-abcd1234-5678-9012-3456-789012345678"

​
statusString
string

Human-readable claim status

Example:

"OPEN"