Obter informações por chave PIX

Consulta Bank Account pelo identificador informado na rota.

Visão geral

Autenticação e pré-requisitos

Requer autenticação. Envie o token no header Authorization: Bearer {{token}} (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar X-Api-Key. Todo tráfego é HTTPS e a credencial nunca vai na URL nem em query string.

Pré-requisitos: a rota exige identificador(es) de recurso já existente(s):

key — Chave PIX
id — —

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`key`	path	`string`	obrigatório	Chave PIX	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`id`	path	`string`	obrigatório	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`registrationNumber`	`string`	opcional	—	—	`"12345678909"`
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`keyType`	`string`	opcional	—	`NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount`	`"NaturalRegistrationNumber"`
`keyTypeDisplay`	`string`	opcional	—	—	`"texto"`
`keyValue`	`string`	opcional	—	—	`"texto"`
`accountNumber`	`string`	opcional	—	—	`"texto"`
`accountAgency`	`string`	opcional	—	—	`"texto"`
`accountOpeningDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`accountType`	`string`	opcional	—	`CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional`	`"CheckingAccount"`
`accountTypeDisplay`	`string`	opcional	—	—	`"texto"`
`personType`	`string`	opcional	—	`Natural`, `Legal`	`"Natural"`
`personTypeDisplay`	`string`	opcional	—	—	`"texto"`
`bankName`	`string`	opcional	—	—	`"Fulano de Tal"`
`ispb`	`string`	opcional	—	—	`"texto"`
`endToEndId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`statistics`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`

Detalhe de `statistics`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`ownerSpi`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`ownerFraudMarkers`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`ownerInfractionReports`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`ownerEntries`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`keySpi`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`keyFraudMarkers`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`keyInfractionReports`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`keyEntries`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`

Exemplo de resposta

{
  "registrationNumber": "12345678909",
  "name": "Fulano de Tal",
  "keyType": "NaturalRegistrationNumber",
  "keyTypeDisplay": "texto",
  "keyValue": "texto",
  "accountNumber": "texto",
  "accountAgency": "texto",
  "accountOpeningDate": "2025-08-11T13:45:00Z",
  "accountType": "CheckingAccount",
  "accountTypeDisplay": "texto",
  "personType": "Natural",
  "personTypeDisplay": "texto",
  "bankName": "Fulano de Tal",
  "ispb": "texto",
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "statistics": {
    "ownerSpi": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "d90": 0,
      "m12": 0,
      "m60": 0
    },
    "ownerFraudMarkers": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "applicationFraudsD90": 0,
      "applicationFraudsM12": 0,
      "applicationFraudsM60": 0,
      "muleAccountsD90": 0,
      "muleAccountsM12": 0,
      "muleAccountsM60": 0,
      "scammerAccountsD90": 0,
      "scammerAccountsM12": 0,
      "scammerAccountsM60": 0,
      "otherFraudsD90": 0,
      "otherFraudsM12": 0,
      "otherFraudsM60": 0,
      "unknownFraudsD90": 0,
      "unknownFraudsM12": 0,
      "unknownFraudsM60": 0,
      "totalFraudTransactionAmountD90": 0,
      "totalFraudTransactionAmountM12": 0,
      "totalFraudTransactionAmountM60": 0,
      "distinctFraudReportersD90": 0,
      "distinctFraudReportersM12": 0,
      "distinctFraudReportersM60": 0
    },
    "ownerInfractionReports": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "openReports": 0,
      "openReportsDistinctReporters": 0,
      "rejectedReportsD90": 0,
      "rejectedReportsM12": 0,
      "rejectedReportsM60": 0
    },
    "ownerEntries": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "registeredAccounts": 0
    },
    "keySpi": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "d90": 0,
      "m12": 0,
      "m60": 0
    },
    "keyFraudMarkers": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "applicationFraudsD90": 0,
      "applicationFraudsM12": 0,
      "applicationFraudsM60": 0,
      "muleAccountsD90": 0,
      "muleAccountsM12": 0,
      "muleAccountsM60": 0,
      "scammerAccountsD90": 0,
      "scammerAccountsM12": 0,
      "scammerAccountsM60": 0,
      "otherFraudsD90": 0,
      "otherFraudsM12": 0,
      "otherFraudsM60": 0,
      "unknownFraudsD90": 0,
      "unknownFraudsM12": 0,
      "unknownFraudsM60": 0,
      "totalFraudTransactionAmountD90": 0,
      "totalFraudTransactionAmountM12": 0,
      "totalFraudTransactionAmountM60": 0,
      "distinctFraudReportersD90": 0,
      "distinctFraudReportersM12": 0,
      "distinctFraudReportersM60": 0
    },
    "keyInfractionReports": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "openReports": 0,
      "openReportsDistinctReporters": 0,
      "rejectedReportsD90": 0,
      "rejectedReportsM12": 0,
      "rejectedReportsM60": 0
    },
    "keyEntries": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "distinctAccountsD90": 0,
      "distinctAccountsM12": 0,
      "distinctAccountsM60": 0
    }
  }
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	—

Exemplos

curl -X GET "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Key/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"

var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Key/3fa85f64-5717-4562-b3fc-2c963f66afa6";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const resp = await fetch(`${baseUrl}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Key/3fa85f64-5717-4562-b3fc-2c963f66afa6`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads