Orientações e respostas da equipe da Direct Data

Benefícios Sociais - Pessoa Física

São recursos financeiros transferidos diretamente da União para o cidadão que participa de programas sociais específicos. Assim, as pessoas inscritas nessas iniciativas recebem, diretamente da União, valores monetários periódicos. A API retorna se o indivíduo consultado recebeu algum dos benefícios sociais nos últimos 12 meses, com exceção do auxilio emergencial e auxílio reconstrução, que consideram todo o período do benefício.
  • Auxílio Emergencial: Benefício temporário criado durante a pandemia de COVID-19 para apoiar trabalhadores informais e famílias de baixa renda.
  • Auxílio Reconstrução: Ajuda financeira destinada a famílias afetadas por desastres naturais para reconstrução de moradias.
  • Bolsa Família: Programa de transferência de renda para famílias em situação de pobreza, condicionado a contrapartidas em saúde e educação.
  • BPC: Benefício que paga um salário mínimo a idosos e pessoas com deficiência de baixa renda, sem exigência de contribuição à Previdência.
  • Garantia-Safra: Auxílio para agricultores familiares que enfrentam perdas de safra devido a condições climáticas adversas.
  • Seguro-Defeso: Benefício pago a pescadores artesanais durante o período de proibição da pesca para proteger espécies em reprodução.

Casos de Uso

  • Avaliação socioeconômica para crédito e benefícios
  • Validação de elegibilidade em programas sociais
  • Análise de risco de fraude em cadastros
  • Composição de perfil para marketing responsável

Aplicações

  • Onboarding de Clientes e Fornecedores
  • Análise de Risco/Crédito

Benefícios

  • Dados oficiais e atualizados
  • Apoia decisões justas com contexto socioeconômico
  • Integração simples com autenticação por token
  • Conformidade com políticas de uso responsável de dados

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.

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br/api/BeneficiosSociais

Endpoint

GET https://apiv3.directd.com.br/api/BeneficiosSociais?CPF={0}&Token=Seu_Token

Descrição: Endpoint para realizar consultas Benefícios Sociais - Pessoa Física.

Nota: Esta consulta não gera comprovantes.

Campos Retornados

  • Auxílio Emergencial: Informa sobre o auxílio emergencial
  • CPF: CPF do indivíduo
  • Data de Nascimento: Data de nascimento do indivíduo
  • Flag Auxílio Reconstrução: Informa se o indivíduio possui auxílio reconstrução ou não. True(verdadeiro) ou false(falso).
  • Flag Bolsa Família: Informa se o indivíduio possui bolsa família ou não. True(verdadeiro) ou false(falso).
  • Flag BPC: Informa se o indivíduio possui o benefício de prestação continuada (BPC) ou não. True(verdadeiro) ou false(falso).
  • Flag Garantia Safra: Informa se o indivíduio possui garantia safra ou não. True(verdadeiro) ou false(falso).
  • Flag Possui Óbito: Retorna se o indivíduo veio a óbito ou não. True(verdadeiro) ou false(falso)
  • Flag Seguro Defeso: Informa se o indivíduio possui seguro defeso ou não. True(verdadeiro) ou false(falso).
  • Flag Tem Óbito: Retorna se o indivíduo veio a óbito ou não. True(verdadeiro) ou false(falso)
  • NIS: Código NIS (Número de Identificação Social) do titular
  • Nome: Nome do indivíduo/registro
  • Nome da Mãe: Nome da mãe do indivíduo

Parâmetros

ParâmetroTipoObrigatórioDescrição
CPFstring
Sim

O parâmetro CPF pode ser enviado com ou sem formatação.

TOKENstring
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",
    "dataNascimento": "string",
    "nomeMae": "string",
    "obito": true,
    "auxilioEmergencial": true,
    "auxilioReconstrucao": true,
    "bolsaFamilia": true,
    "bpc": true,
    "garantiaSafra": true,
    "seguroDefeso": true
  }
}

Erros Comuns

CódigoDescriçã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

  • 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