Skip to main content
POST
/
v1
/
claims
/
{claimId}
/
confirmation
Confirm claim
curl --request POST \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/claims/{claimId}/confirmation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "11122233344",
  "accountId": "12345678-1234-1234-1234-123456789012"
}'
{
  "claimId": "claim_abc123xyz",
  "status": "OPEN"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Path Parameters

​
claimId
string
required

Claim identifier.

Body

application/json
​
key
string
required

Pix key to confirm claim for.

Example:

"11122233344"

​
accountId
string<uuid>
required

Account identifier of the claimer.

Example:

"12345678-1234-1234-1234-123456789012"

Response

Claim confirmed successfully

​
claimId
string
required

Unique identifier for the claim.

Example:

"claim_abc123xyz"

​
status
enum<string>
required

Pix key ownership claim status. String values representing the state of a portability or ownership claim.

Valid values:

  • OPEN = Claim has been initiated and is awaiting action from parties involved
  • CONFIRMED = Claim has been confirmed by the claimer
  • COMPLETED = Claim process successfully completed, key transferred
  • CANCELLED = Claim was cancelled by the claimer or system
  • AWAITING_RESOLUTION = Awaiting resolution or decision from the current key owner
Available options:
OPEN,
CONFIRMED,
COMPLETED,
CANCELLED,
AWAITING_RESOLUTION
Example:

"OPEN"