Orientações e respostas da equipe da Direct Data

/api/AuxilioEmergencial

💡 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.

Introdução

A API Auxílio Emergencial oferece informações detalhadas sobre os benefícios recebidos por indivíduos, incluindo:

• CPF e NIS do beneficiário;
• Detalhes das parcelas, como data, valor e situação;
• Localização do município e estado do beneficiário.

Essa API é ideal para onboarding de clientes e fornecedores e análise de risco/crédito.

URL Base

https://apiv3.directd.com.br

Endpoint

GET /api/AuxilioEmergencial

Autenticação

A autenticação é feita utilizando um TOKEN. Sem um token válido, o acesso será negado (401).

Regras de Autenticação

1. O TOKEN deve ser incluído como parâmetro obrigatório.
2. Caso o token seja inválido ou expirado, entre em contato pelo e-mail: suporte@directd.com.br.

Campos da API

Dados Retornados

• Nome: Nome completo do beneficiário.
• NIS: Número de Identificação Social do beneficiário.
• CPF: CPF do beneficiário.
• Número do Registro: Identificador único do pagamento.
• Data: Data do pagamento.
• Situação: Status do pagamento (Ex.: Pago, Cancelado).
• Enquadramento: Tipo de benefício enquadrado.
• Valor: Valor do pagamento.
• Número da Parcela: Número da parcela paga.
• Município: Localidade do beneficiário.
• UF: Estado do beneficiário.

Parâmetros

Exemplo de Requisição

Usando cURL

curl -X 'GET' \
  'https://apiv3.directd.com.br/api/AuxilioEmergencial?CPF=12345678945&TOKEN=68ADA2C3-8016-47DA-ADE6-13AE239308FE' \
  -H 'accept: application/json'

Respostas

Sucesso (200)

A consulta foi realizada com sucesso e retorna os dados do beneficiário.

{
  "metaDados": {
    "consultaNome": "Auxílio Emergencial",
    "consultaUid": "direct-123456",
    "mensagem": "Consulta realizada com sucesso.",
    "resultado": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 200
  },
  "retorno": {
    "nome": "João da Silva",
    "nis": "12345678901",
    "cpf": "12345678945",
    "beneficios": [
      {
        "numeroRegistro": 1,
        "data": "01/01/2024",
        "situacao": "Pago",
        "enquadramento": "Auxílio Emergencial Básico",
        "valor": "R$ 600,00",
        "numeroParcela": 1,
        "municipio": "São Paulo",
        "uf": "SP"
      }
    ]
  }
}

Códigos de Resposta

Notas Importantes

• Apenas um documento (CPF ou NIS) deve ser enviado por consulta.
• Este endpoint não gera comprovantes.
• Para dúvidas ou suporte, entre em contato pelo e-mail: suporte@directd.com.br.