v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Consulta lista de reivindicação/portabilidade de chave Pix

get/pix/dict/claim/list

Query parameters

DateFromstring

Data de Inicio que deseja buscar

DateTostring

Data Fim que deseja buscar

LimitPerPagestring

Limite de resultados por página

Pagestring

Página que deseja visualizar

Statusstring

Status da Claim Available values : OPEN, WAITING_RESOLUTION, CONFIRMED, CANCELLED, COMPLETED

claimTypestring

Tipo da Claim: Available values : OWNERSHIP, PORTABILITY

Response

200

versionstring

statusstring

Example response

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "claims": [
      {
        "id": "8bbc0ba5-2aee-44a0-a3c9-b897802a9f66",
        "claimType": "OWNERSHIP",
        "key": "fulanodetal@gmail.com",
        "keyType": "EMAIL",
        "claimerAccount": {
          "participant": "30306294",
          "branch": "0001",
          "account": "30053913742139",
          "accountType": "TRAN"
        },
        "claimer": {
          "personType": "NATURAL_PERSON",
          "taxId": "34335125070",
          "name": "João da Silva Junior"
        },
        "donorParticipant": "30306294",
        "status": "OPEN",
        "createTimestamp": "2023-05-01T13:05:09",
        "completionPeriodEnd": "2023-05-01T13:05:09",
        "resolutionPeriodEnd": "2023-05-01T13:05:09",
        "lastModified": "2023-05-01T13:05:09",
        "donorAccount": {
          "account": "30053913742139",
          "branch": "0001",
          "taxId": "34335125070",
          "name": "João da Silva Junior"
        }
      }
    ]
  }
}