Documentação

Quickstart

1. Crie uma conta e gere uma chave em Dashboard → Chaves de API.

2. Envie sua chave no cabeçalho Authorization.

curl https://api.dadosbr.dev/v1/pessoa \
  -H "Authorization: Bearer dbr_live_SEU_TOKEN"

Autenticação

Toda chamada exige um token Bearer no cabeçalho Authorization. Chaves são geradas e revogadas no Dashboard.

Endpoints

MétodoCaminhoDescrição
GET/v1/pessoaGera um perfil completo
GET/v1/cpfGera apenas um CPF válido
GET/v1/enderecoGera um endereço com CEP existente
POST/v1/pessoa/loteGera um lote de perfis (até 1.000)
GET/v1/cpf/{cpf}Consulta CPF exato na base autorizada
POST/v1/base/searchBusca cadastral por prefixo e filtros (até 20)
POST/v1/base/nextEntrega um registro sem repetir no consumer

Erros e limites

Respostas de erro seguem o formato padrão { "error": { "code": ..., "message": ... } }. Os planos limitam requisições por segundo — veja os planos para os valores por plano.

Endpoints de geração retornam synthetic: true e não comprovam titularidade. Endpoints /v1/cpf/{cpf} e /v1/base/* consultam a base cadastral autorizada, retornam synthetic: false e exigem scopes e campos liberados para o consumer.