Debitado do seu saldo a cada chamada cobrada. Autenticação pelo header X-API-Key. Veja como obter a chave.
Este endpoint consulta informações sobre beneficiários do programa Auxílio Reconstrução, que oferece suporte a famílias desalojadas ou desabrigadas no Rio Grande do Sul. O serviço retorna dados cadastrais do beneficiário, informações sobre as parcelas concedidas e composição familiar.
A consulta é adequada para processos de validação e padronização de dados cadastrais, automação de verificações operacionais e integração com fluxos de análise de risco, crédito e compliance. O endpoint contribui para reduzir custos manuais, minimizar erros de entrada de dados e aumentar a confiabilidade das decisões baseadas nessas informações.
found — Indicador de sucesso da consulta (beneficiário localizado ou não)
message — Mensagem descritiva do resultado da operação
nome — Nome completo do beneficiário
nis — Número de Identificação Social (NIS) do titular
cpf — CPF do beneficiário consultado
quantidadePessoasFamilia — Quantidade de integrantes cadastrados na unidade familiar
beneficios — Lista dos benefícios concedidos, contendo:
Data do registro
Valor da parcela
Município referente ao registro
UF (estado) referente ao 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 beneficiário."
},
"nis": {
"type": [
"string",
"null"
],
"description": "Número de Identificação Social."
},
"nome": {
"type": [
"string",
"null"
],
"description": "Nome do beneficiário."
},
"beneficios": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"uf": {
"type": [
"string",
"null"
],
"description": "Unidade Federativa do benefício."
},
"data": {
"type": [
"string",
"null"
],
"description": "Data do benefício."
},
"valor": {
"type": [
"string",
"null"
],
"description": "Valor do benefício."
},
"municipio": {
"type": [
"string",
"null"
],
"description": "Município do benefício."
}
}
},
"description": "Lista de benefícios concedidos."
},
"quantidadePessoasFamilia": {
"type": [
"number",
"null"
],
"description": "Quantidade de pessoas na família."
}
},
"description": "Dados retornados da 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 da consulta."
},
"chave": {
"type": [
"string",
"null"
],
"description": "Chave de identificação da consulta."
},
"usuario": {
"type": [
"string",
"null"
],
"description": "Usuário que realizou a consulta."
},
"mensagem": {
"type": [
"string",
"null"
],
"description": "Mensagem informativa da consulta."
},
"apiVersao": {
"type": [
"string",
"null"
],
"description": "Versão da API utilizada."
},
"resultado": {
"type": [
"string",
"null"
],
"description": "Status do resultado."
},
"assincrono": {
"type": [
"boolean",
"null"
],
"description": "Indica se a consulta é assíncrona."
},
"consultaUid": {
"type": [
"string",
"null"
],
"description": "Identificador único da consulta."
},
"resultadoId": {
"type": [
"number",
"null"
],
"description": "Identificador do resultado."
},
"consultaNome": {
"type": [
"string",
"null"
],
"description": "Nome da consulta realizada."
},
"enviarCallback": {
"type": [
"boolean",
"null"
],
"description": "Indica se deve enviar callback."
},
"urlComprovante": {
"type": [
"string",
"null"
],
"description": "URL do comprovante gerado."
},
"tempoExecucaoMs": {
"type": [
"number",
"null"
],
"description": "Tempo de execução em milissegundos."
},
"gerarComprovante": {
"type": [
"boolean",
"null"
],
"description": "Indica se gera comprovante."
}
},
"description": "Metadados da consulta."
}
},
"description": "Dados da consulta de auxílio reconstrução."
},
"found": {
"type": [
"boolean",
"null"
],
"description": "Indica se registros foram encontrados."
},
"message": {
"type": [
"string",
"null"
],
"description": "Mensagem informativa da resposta."
}
}
}
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
Cada requisição deve informar um único documento (CPF)
A consulta retorna dados de beneficiários com status ativo ou histórico no programa
Não há geração de comprovante direto através desta consulta
O processamento ocorre de forma síncrona, com retorno imediato
Em caso de CPF não localizado, o campo found indicará falha e a mensagem descreverá o motivo
Para dúvidas ou problemas de acesso, entre em contato com o 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.