Introdução

A API Bureau 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 ou reutilize um pacote de datasets por ID

​

Escolha o body correto

Sync e async usam a mesma URI em cada modo. A diferença está no corpo da requisição:

​

Como Funciona

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

​

1. Consulta Síncrona

No endpoint POST /bureau/api/v1/bureau/person/sync, você envia os dados da consulta e recebe o resultado diretamente na resposta HTTP. Informe:

• key com CPF ou CNPJ da entidade consultada
• datasets ou datasetPackageId, conforme a forma de selecionar os datasets
• refreshData para forçar atualização dos dados (opcional)

​

2. Consulta Assíncrona

No endpoint POST /bureau/api/v1/bureau/person/async, você envia os dados da consulta e recebe a confirmação com requestId e createdAt. O resultado final é entregue no webhook informado. Além dos campos da consulta, informe:

• webhookUrl para receber o resultado processado
• webhookBasicAuth para autenticação do webhook (opcional)

​

Próximos Passos