Skip to main content
A API Bureau Person unifica as consultas de Pessoa Física (PF) e Pessoa Jurídica (PJ) em uma única estrutura de serviço. Ela foi desenvolvida para apoiar processos de verificação, análise de crédito, compliance e due diligence, mantendo o mesmo padrão de datasets já usado no Background Check.

​
Características Principais

  • Consulta Síncrona e Assíncrona: Você escolhe receber o resultado direto na resposta (/sync) ou por webhook (/async)
  • Datasets PF e PJ no mesmo serviço: Use os mesmos códigos de datasets, sem separar por APIs diferentes
  • Flexibilidade: Escolha quais datasets consultar, use um pacote por ID e defina atualização de dados (refreshData)

​
Como Funciona

O Bureau Person funciona com dois modos de execução:

​
1. Consulta Síncrona

No endpoint POST /bureau/api/v1/person/sync, você envia os dados da consulta e recebe o resultado diretamente na resposta HTTP. Nesta requisição, você pode especificar:
  • key com CPF ou CNPJ da entidade consultada
  • datasets que deseja consultar (opcional; se não informado, a consulta considera todos os datasets disponíveis para o tipo de documento informado)
  • datasetPackageId para reutilizar um pacote de datasets (opcional)
  • refreshData para forçar atualização dos dados (opcional)

​
2. Consulta Assíncrona

No endpoint POST /bureau/api/v1/person/async, você envia os dados da consulta e recebe a confirmação com requestId e createdAt. O resultado final é entregue no webhook informado. Nesta requisição, além dos campos da consulta, você pode informar:
  • webhookUrl para receber o resultado processado
  • webhookBasicAuth para autenticação do webhook (opcional)

​
Próximos Passos

Consulta Sync

Aprenda como iniciar uma consulta com retorno imediato

Consulta Async

Veja como consultar com retorno assíncrono via webhook

Datasets PF e PJ

Conheça os datasets disponíveis e quando usar cada um