Skip to main content
GET
/
v1
/
claims
/
{claimId}
Retrieve claim
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/claims/{claimId} \
  --header 'Authorization: Bearer <token>'
{
  "claimId": "claim_abc123xyz",
  "key": "+5511987654321",
  "bankId": "12345678"
}

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.

Query Parameters

​
account_id
string<uuid>

Account identifier.

Response

Claim details retrieved successfully

​
claimId
string
required

Unique identifier for the claim.

Example:

"claim_abc123xyz"

​
key
string
required

Pix key value.

Example:

"+5511987654321"

​
bankId
string
required

Bank ISPB code of the current key owner.

Example:

"12345678"