O endpoint /api/AuxilioEmergencial permite consultar informações sobre o programa Auxílio Emergencial, criado pelo governo brasileiro para mitigar os impactos econômicos da pandemia de COVID-19. Essa API retorna detalhes dos beneficiários e pagamentos realizados, auxiliando em análises de risco e crédito.
Auxílio Emergencial
Auxílio Emergencial, também chamado de Caixa Auxílio Emergencial ou coronavoucher, foi um programa do governo federal brasileiro de renda mínima aos mais vulneráveis durante a pandemia de COVID-19. O objetivo do auxílio financeiro foi mitigar os impactos econômicos causados pela pandemia de COVID-19 no Brasil.
Casos de Uso
- Integração com Auxílio Emergencial
- Validação e padronização de dados cadastrais
- Automação de consultas para decisões operacionais
- Integração com fluxos de risco, crédito e compliance
Aplicações
- Onboarding de Clientes e Fornecedores
- Análise de Risco/Crédito
Benefícios
- Documentação de Auxílio Emergencial acessível e atualizada
- Reduz custos e erros manuais
- Aumenta confiabilidade das decisões
- Integração simples e escalável
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/AuxilioEmergencialEndpoint
GET https://apiv3.directd.com.br/api/AuxilioEmergencial?CPF={0}&NIS={1}&Token=Seu_TokenDescrição: Endpoint para realizar consultas Auxílio Emergencial.
Nota: Esta consulta não gera comprovantes.
Campos Retornados
- CPF: CPF do indivíduo
- Data: Data do registro
- Enquadramento: Enquadramento do registro.
- Lista de Benefícios: Lista os dados do benefício de bolsa família consultado
- Município: Município/cidade referente ao registro
- NIS: Código NIS (Número de Identificação Social) do titular
- Nome: Nome do indivíduo/registro
- Número da Parcela: Informa o número referente à parcela
- Número do Registro: Número de registro
- Situação: Situação do registro em questão
- UF: Unidade Federativa (estado) referente ao registro
- Valor: Valor da parcela
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
NIS | string | Sim | O parâmetro NIS pode ser enviado com ou sem formatação. |
CPF | string | Sim | O parâmetro CPF pode ser enviado com ou sem formatação. |
TOKEN | string | Sim | O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br |
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"enviarCallback": false,
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"nome": "string",
"nis": "string",
"cpf": "string",
"beneficios": [
{
"numeroRegistro": 0,
"data": "string",
"situacao": "string",
"enquadramento": "string",
"valor": "string",
"numeroParcela": 0,
"municipio": "string",
"uf": "string"
}
]
}
}Erros Comuns
| Código | Descrição |
|---|---|
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. |
Notas Importantes
- Informe apenas um único documento por requisição
- Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
- Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228