Debitado do seu saldo a cada chamada cobrada. Autenticação pelo header X-API-Key. Veja como obter a chave.
Consulta informações sobre beneficiários do programa de proteção de renda para agricultores familiares que enfrentaram perdas de colheita. Através deste endpoint, você acessa dados sobre as garantias financeiras concedidas a produtores rurais afetados por problemas climáticos adversos, como secas prolongadas ou enchentes.
Este serviço é especialmente útil para validar se um agricultor possui registros de benefício, permitindo integração com processos de avaliação de crédito, análise de risco e verificação de cadastros. A consulta padroniza e normaliza os dados relacionados a beneficiários, facilitando decisões operacionais e automatizando fluxos de negócio.
Data em que a consulta foi realizada, no formato dd/MM/yyyy HH:mm:ss.
found
boolean
Indica se foram localizados registros de benefício associados ao CPF consultado.
message
string
Mensagem descritiva sobre o resultado da consulta. Pode conter informações sobre o status, dados do beneficiário ou motivo pelo qual nenhum registro foi encontrado.
Quando a consulta retorna sucesso (found: true), a resposta inclui detalhes como nome do beneficiário, número de identificação social (NIS), lista de benefícios com datas de concessão, valores das parcelas, município e estado de origem do registro.
Exemplo — 200 OK
{
"data": null,
"found": false,
"message": "Nenhum registro encontrado"
}
Schema da resposta (JSON Schema)
JSON Schema
{
"type": "object",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"retorno": {
"type": [
"object",
"null"
],
"properties": {
"cpf": {
"type": [
"string",
"null"
],
"description": "CPF do indivíduo consultado."
},
"nis": {
"type": [
"string",
"null"
],
"description": "Número de Identificação Social do indivíduo."
},
"nome": {
"type": [
"string",
"null"
],
"description": "Nome do indivíduo consultado."
},
"beneficios": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"uf": {
"type": [
"string",
"null"
],
"description": "Unidade Federativa referente ao benefício."
},
"data": {
"type": [
"string",
"null"
],
"description": "Data do registro do benefício."
},
"valor": {
"type": [
"string",
"null"
],
"description": "Valor da parcela ou benefício."
},
"municipio": {
"type": [
"string",
"null"
],
"description": "Município referente ao benefício."
},
"numeroRegistro": {
"type": [
"number",
"null"
],
"description": "Número sequencial do registro do benefício."
}
}
},
"description": "Lista de benefícios registrados."
}
},
"description": "Dados retornados pela consulta."
},
"metaDados": {
"type": [
"object",
"null"
],
"properties": {
"ip": {
"type": [
"string",
"null"
],
"description": "Endereço IP da requisição."
},
"data": {
"type": [
"string",
"null"
],
"description": "Data e hora de execução da consulta."
},
"chave": {
"type": [
"string",
"null"
],
"description": "Chave de autenticação ou identificação."
},
"usuario": {
"type": [
"string",
"null"
],
"description": "Usuário que realizou a consulta."
},
"mensagem": {
"type": [
"string",
"null"
],
"description": "Mensagem de status da consulta."
},
"apiVersao": {
"type": [
"string",
"null"
],
"description": "Versão da API utilizada."
},
"resultado": {
"type": [
"string",
"null"
],
"description": "Descrição textual do resultado."
},
"assincrono": {
"type": [
"boolean",
"null"
],
"description": "Indicador se a consulta foi processada de forma assíncrona."
},
"consultaUid": {
"type": [
"string",
"null"
],
"description": "Identificador único da consulta."
},
"resultadoId": {
"type": [
"number",
"null"
],
"description": "Identificador numérico do resultado."
},
"consultaNome": {
"type": [
"string",
"null"
],
"description": "Nome da consulta realizada."
},
"enviarCallback": {
"type": [
"boolean",
"null"
],
"description": "Indicador se será enviado callback."
},
"urlComprovante": {
"type": [
"string",
"null"
],
"description": "URL para acessar o comprovante gerado."
},
"tempoExecucaoMs": {
"type": [
"number",
"null"
],
"description": "Tempo total de execução em milissegundos."
},
"gerarComprovante": {
"type": [
"boolean",
"null"
],
"description": "Indicador se será gerado comprovante."
}
},
"description": "Metadados e informações de execução da consulta."
}
},
"description": "Dados da consulta."
},
"found": {
"type": [
"boolean",
"null"
],
"description": "Indicador se registros foram encontrados na consulta."
},
"message": {
"type": [
"string",
"null"
],
"description": "Mensagem descritiva do resultado da consulta."
}
}
}
Códigos de erro
Código
Mensagem
Quando acontece
400
Requisição Inválida
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
Envie apenas um CPF por requisição.
O CPF pode ser fornecido com ou sem formatação — o sistema aceita ambos os formatos e processa automaticamente.
Esta consulta retorna apenas dados de consulta e não gera documentação comprobatória adicional.
Em caso de problemas na consulta, verifique se o CPF está correto e tente novamente. Se o erro persistir, entre em contato com o suporte técnico do gateway.
A consulta é processada de forma síncrona, retornando o resultado imediatamente na resposta.
Os códigos de status HTTP (como 400, 401, 403, 404, 408, 500, 503) indicam diferentes cenários: requisição inválida, autenticação falha, autorização negada, recurso não encontrado, timeout ou problemas no servidor.
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.