Orientações e respostas da equipe da Direct Data

/api/BolsaFamilia

💡 O endpoint /api/BolsaFamilia permite consultar as parcelas recebidas e sacadas do Bolsa Família com base no NIS (Número de Identificação Social). A consulta é alimentada pelo Portal da Transparência e fornece informações detalhadas sobre os benefícios recebidos.

Introdução

A API Bolsa Família oferece informações sobre benefícios do programa Bolsa Família, incluindo:

• Identificação do beneficiário pelo NIS e CPF;
• Detalhes das parcelas recebidas, como data, valor, município e estado;
• Análise de dados por competência e referência.

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

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br

Endpoint

GET /api/BolsaFamilia

Esse endpoint retorna informações detalhadas sobre os benefícios recebidos por um beneficiário do Bolsa Família.

Regras

1. Apenas um NIS deve ser enviado por requisição.
2. Este endpoint não permite a geração de comprovantes.

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

• NIS: Número de Identificação Social do beneficiário.
• CPF: CPF do beneficiário.
• Nome: Nome completo do beneficiário.
• Lista de Benefícios:
  • Número do Registro: Identificador único do benefício.
  • Data Mês de Competência: Mês/ano da competência do benefício.
  • Data Mês de Referência: Mês/ano de referência para o pagamento.
  • Valor: Valor recebido no benefício.
  • Município: Cidade onde o benefício foi sacado.
  • UF: Estado onde o benefício foi sacado.

Parâmetros

Parâmetros da Requisição

Exemplo de Requisição

Usando cURL

curl -X 'GET' \
  'https://apiv3.directd.com.br/api/BolsaFamilia?NIS=12345678901&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.

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Bolsa Família",
    "consultaUid": "direct-123456",
    "mensagem": "Consulta realizada com sucesso.",
    "resultado": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 150
  },
  "retorno": {
    "nis": "12345678901",
    "cpf": "98765432100",
    "nome": "Maria Silva",
    "beneficios": [
      {
        "numeroRegistro": 1,
        "dataMesCompetencia": "01/2024",
        "dataMesReferencia": "12/2023",
        "valor": "R$ 600,00",
        "municipio": "São Paulo",
        "uf": "SP"
      }
    ]
  }
}

Erros Comuns

Exemplo de Erro 400

{
  "metaDados": {
    "consultaNome": "Bolsa Família",
    "mensagem": "Parâmetro Inválido! NIS: 12345678901",
    "resultado": "Documento Entrada Inválida",
    "apiVersao": "v3"
  },
  "retorno": null
  }

Notas Importantes

• Apenas um 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.