Debitado do seu saldo a cada chamada cobrada. Autenticação pelo header X-API-Key. Veja como obter a chave.
Permite consultar dados de beneficiários do programa de auxílio emergencial. O endpoint retorna informações cadastrais e histórico de parcelas de beneficiários registrados, viabilizando análises de histórico de benefícios, validação de dados e integração com processos de avaliação de risco e crédito.
Use este endpoint para:
Validação de dados: Padronizar e confirmar informações cadastrais de indivíduos
Automação de consultas: Recuperar dados de benefícios para alimentar decisões operacionais
Processos de compliance e risco: Integrar dados históricos em fluxos de análise de crédito e avaliação de perfil de cliente
a requisição está incorreta ou os parâmetros são inválidos.
401
Não Autenticado
o usuário não forneceu as credenciais corretas para acessar o recurso.
403
Não Autorizado
o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível.
404
Não Encontrado
o servidor não encontrou uma representação atual do recurso solicitado.
408
Tempo Esgotado
o servidor não conseguiu retornar a requisição no prazo estabelecido.
500
Falha ao Realizar Consulta
o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte.
503
Consulta em Manutenção
a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte.
Observações
Uma requisição por documento: Submeta apenas um CPF por chamada à API
Sem geração de comprovantes: Esta consulta retorna dados informativos e não gera documentos de comprovação
Atualização de dados: As informações refletem o estado histórico das parcelas do programa
Suporte: Em caso de dúvidas ou problemas na integração, entre em contato com nosso time de suporte
Integrar
OpenAPI (JSON) ↗ — importe a URL
no Postman ou no Insomnia para gerar a coleção com todos os endpoints. Também dá para consultar
pelo chat: conecte via MCP. Esta página em Markdown.