v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Retornar informações do DICT utilizando uma chave cadastrada no Pix

Essa API possibilita a realização da busca de uma chave Pix, para obter suas informações bancárias e estatísticas antifraude.

post/dict/v2/key

Headers

IncludeStatisticsboolean

Quando enviado o IncludeStatistics como True, retornará as estatísticas da chave.

Request body

payerIdstring required

PayerId identificador do usuário final vinculado ao PSP. Deve o documento do usuário, em 14 dígitos, preenchidos com zero a esquerda.

keystring required

Chave Pix a ser consultada. Poderá ser dos tipos CPF/CPNJ, e-mail, EVP (aleatória) ou telefone (com o código de país "+55")

endToEndIdstring

Identificador de transações para quem for iniciador ITP

Response

200

keystring

keyTypestring

endtoendidstring

creationDatestring

keyOwnershipDatestring

openClaimCreationDatestring

Example response

{
  "key": "e821c5e3-7743-40ab-aa00-868f7a171155",
  "keyType": "EVP",
  "account": {
    "accountNumber": "105156485",
    "accountType": "TRAN",
    "participant": "30306294",
    "openingDate": "2023-04-05T15:13:00"
  },
  "owner": {
    "type": "NATURAL_PERSON",
    "taxIdNumber": "12345678901",
    "name": "Fulano de Tal",
    "tradeName": "Empreiteira S/A"
  },
  "endtoendid": "E12345456677",
  "creationDate": "2023-03-30T16:10:11",
  "keyOwnershipDate": "2023-03-30T16:10:11",
  "openClaimCreationDate": "2023-03-30T19:12:05",
  "statistics": {
    "ownerStatistics": {
      "spi": {
        "watermark": "2024-05-29T12:33:41.814Z"
      },
      "fraudMarkers": {
        "watermark": "2024-05-29T12:33:41.814Z"
      },
      "infractionReports": {
        "watermark": "2024-05-29T12:33:41.814Z"
      },
      "entries": {
        "watermark": "2024-05-29T12:33:41.814Z"
      }
    },
    "keyStatistics": {
      "spi": {
        "watermark": "2024-05-29T12:33:41.814Z"
      },
      "fraudMarkers": {
        "watermark": "2024-05-29T12:33:41.814Z"
      },
      "infractionReports": {
        "watermark": "2024-05-29T12:33:41.814Z"
      },
      "entries": {
        "watermark": "2024-05-29T12:33:41.814Z"
      }
    }
  }
}