Orientações e respostas da equipe da Direct Data

/api/BeneficiosSociais

💡 O endpoint /api/BeneficiosSociais permite consultar se um cidadão recebeu benefícios sociais nos últimos 12 meses, com exceção do auxílio emergencial e auxílio reconstrução, que consideram todo o período do benefício. A API retorna informações sobre diversos programas sociais do governo federal.

Introdução

A API Benefícios Sociais - Pessoa Física oferece informações sobre benefícios sociais recebidos por cidadãos, incluindo:

• Auxílio Emergencial
• Auxílio Reconstrução
• Bolsa Família
• BPC (Benefício de Prestação Continuada)
• Garantia-Safra
• Seguro-Defeso

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

Preço

• Valor por consulta: R$ 0,75

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br

Endpoint

GET /api/BeneficiosSociais

Esse endpoint retorna informações sobre os benefícios sociais recebidos por uma pessoa física.

Regras

1. Apenas um CPF deve ser enviado por requisição.
2. Esta consulta não gera comprovante PDF.
3. Para auxílio emergencial e reconstrução, considera todo o período do benefício.
4. Para os demais benefícios, considera os últimos 12 meses.

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.
• CPF: Número do CPF.
• NIS: Número de Identificação Social.
• Data de Nascimento: Data de nascimento do beneficiário.
• Nome da Mãe: Nome completo da mãe do beneficiário.
• Flag Possui Óbito: Indica se há registro de óbito.
• Flag Auxílio Emergencial: Indica se recebeu Auxílio Emergencial.
• Flag Auxílio Reconstrução: Indica se recebeu Auxílio Reconstrução.
• Flag Bolsa Família: Indica se recebeu Bolsa Família.
• Flag BPC: Indica se recebeu BPC.
• Flag Garantia Safra: Indica se recebeu Garantia-Safra.
• Flag Seguro Defeso: Indica se recebeu Seguro-Defeso.

Parâmetros

Exemplo de Requisição

Usando cURL

  'https://apiv3.directd.com.br/api/BeneficiosSociais?CPF=12345678909&TOKEN=seu_token_aqui'

Respostas

Exemplo de Resposta (200)

{
  "metaDados": {
    "consultaNome": "Benefícios Sociais - Pessoa Física",
    "consultaUid": "direct-123456",
    "chave": "string",
    "usuario": "string",
    "mensagem": "string",
    "ip": "string",
    "resultadoId": 0,
    "resultado": "string",
    "apiVersao": "v3",
    "gerarComprovante": false,
    "urlComprovante": "string",
    "assincrono": true,
    "data": "dd/MM/yyyy HH:mm:ss",
    "tempoExecucaoMs": 0
  },
  "retorno": {
    "nome": "string",
    "nis": "string",
    "cpf": "string",
    "dataNascimento": "string",
    "nomeMae": "string",
    "possuiObito": true,
    "obito": true,
    "auxilioEmergencial": true,
    "auxilioReconstrucao": true,
    "bolsaFamilia": true,
    "bpc": true,
    "garantiaSafra": true,
    "seguroDefeso": true
  }
}

Notas Importantes

• O CPF é obrigatório para realizar a consulta.
• Esta API não gera comprovantes PDF.
• O token é necessário em todas as requisições.
• Para auxílio emergencial e reconstrução, são considerados todos os períodos.
• Para os demais benefícios, são considerados apenas os últimos 12 meses.
• Em caso de dúvidas ou problemas, entre em contato pelo e-mail: suporte@directd.com.br.