Skip to main content
GET
/
v1
/
claims
List claims
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/claims \
  --header 'Authorization: Bearer <token>'
{
  "claims": [
    {
      "claimType": "PORTABILITY",
      "key": "+5511987654321",
      "bankId": "12345678",
      "claimId": "claim_abc123xyz",
      "stClaim": "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).

Query Parameters

​
account_id
string<uuid>

Account identifier.

​
status
string

Filter by claim status. Possible values: OPEN, CONFIRMED, COMPLETED, CANCELLED, AWAITING_RESOLUTION.

Response

List of claims retrieved successfully

​
claims
object[]
required

List of claims associated with the account.