v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Cadastra nova reivindicação/portabilidade de chave Pix

post/pix/dict/claim

Request body

keystring

Chave que deseja realizar a reivindicação/portabilidade

keyTypestring

Tipo da chave

accountstring required

Número da conta que ira realizar a solicitação de portabilidade ou reivindicação de chave

claimTypestring required

Tipo de operação

Response

200

versionstring

statusstring

Example response

{
  "version": "1.0.0",
  "status": "OPEN",
  "body": {
    "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",
    "createTimestamp": "2023-05-01T13:05:09",
    "completionPeriodEnd": "2023-05-01T13:05:09",
    "resolutionPeriodEnd": "2023-05-01T13:05:09",
    "lastModified": "2023-05-01T13:05:09",
    "confirmReason": "USER_REQUESTED",
    "cancelReason": "FRAUD",
    "cancelledBy": "DONOR",
    "donorAccount": {
      "account": "30053913742139",
      "branch": "0001",
      "taxId": "34335125070",
      "name": "João da Silva"
    }
  }
}