List Key Claims

Use this endpoint to list key claims with filters and pagination. Returns empty array [] if no claims match the criteria.

GET /v1/dict/claims

List Key Claims

cURL

curl --request GET \
  --url https://api.example.com/v1/dict/claims \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "accountId": "550e8400-e29b-41d4-a716-446655440002",
      "bacenClaimId": "cc91b1b0-8465-44b1-a760-15dd3717ea9b",
      "cancelReason": "FRAUD",
      "cancelledBy": "DONOR",
      "claimer": {
        "document": "52998224725",
        "name": "Antonio Jose Raimundo",
        "type": "NATURAL_PERSON"
      },
      "claimerAccount": {
        "branch": "0001",
        "number": "2227654330",
        "openingDate": "2020-08-17T13:48:36Z",
        "participant": "30306294",
        "type": "TRAN"
      },
      "completionPeriodEnd": "2020-09-14T13:48:55.970Z",
      "confirmReason": "DEFAULT_OPERATION",
      "createdAt": "2020-08-17T13:48:36Z",
      "donorParticipant": "30306294",
      "holderId": "550e8400-e29b-41d4-a716-446655440001",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "[phone]",
      "keyType": "PHONE",
      "resolutionPeriodEnd": "2020-08-24T13:48:55.970Z",
      "status": "OPEN",
      "type": "OWNERSHIP",
      "updatedAt": "2024-01-20T14:45:00Z"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 42
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

limit · integer<int64> · predeterminado: 10

Maximum number of claims per page (1-100)

page · integer<int64> · predeterminado: 1

Page number for pagination

type · string

Filter by claim type: OWNERSHIP, PORTABILITY

status · string[]

Filter by status (comma-separated, OR-matched): OPEN, WAITING_RESOLUTION, CONFIRMED, CANCELLED, COMPLETED

key_value · string

Filter by Pix key value

sort_order · string · predeterminado: asc

Sort direction: asc or desc

bacen_claim_id · string<uuid>

Filter by BACEN claim ID (UUID)

Respuesta

200

application/json

OK

items · object[] · requerido

Array of claims

Show child attributes

limit · integer<int64> · requerido

Number of items per page

Ejemplo:

10

page · integer<int64> · requerido

Current page number

Ejemplo:

1

total · integer<int64> · requerido

Total number of claims matching the filters

Ejemplo:

42