Bolsa Família

Retorna as parcelas de recebidos e sacados do Bolsa Família a partir do NIS que é enviado para a consulta de Benefícios do Portal da Transparência.

Casos de Uso

Integração com Bolsa Família
Onboarding KYC e validação de identidade
Análise de risco/crédito com dados cadastrais e socioeconômicos
Prevenção a fraude em abertura de conta e cadastro

Aplicações

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

Benefícios

Documentação de Bolsa Família acessível e atualizada
Dados atualizados e padronizados
Aumento de aprovação com menos atrito
Conformidade com políticas internas e LGPD

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.

URL Base

A API está hospedada no seguinte endereço:

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

Endpoint

GET https://apiv3.directd.com.br/api/BolsaFamilia?Nis={0}&MesReferencia={1}&AnoReferencia={2}&MesCompetencia={3}&AnoCompetencia={4}&Token=Seu_Token

Descrição: Endpoint para realizar consultas Bolsa Família.

Nota: Esta consulta não gera comprovantes.

Campos Retornados

Ano de Competência: Ano de competência da parcela
Código: Código do registro
Código ID: Código de identificação
Competência: Dados da data de competência da parcela do Bolsa Família
CPF: CPF do indivíduo
Dados do Saque: Informa os dados do saque do Bolsa Família
Data: Data do registro
IBGE: Dados do IBGE do município
Lista de Benefícios: Lista os dados do benefício de bolsa família consultado
Mês de Competência: Mês de competência da parcela
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
País: País onde o registro é localizado
Referência: Dados da data de referência da parcela do Bolsa Família
Região: Dados da região onde o município se situa
UF: Unidade Federativa (estado) referente ao registro
Valor: Valor da parcela

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`ANOCOMPETENCIA`	string	Sim	O parâmetro ANOCOMPETENCIA deve conter os 4 dígitos. Ex: 2024.
`MESCOMPETENCIA`	string	Sim	O parâmetro MESCOMPETENCIA deve ser de 01 até 12.
`ANOREFERENCIA`	string	Sim	O parâmetro ANOREFERENCIA deve conter os 4 dígitos. Ex: 2024.
`MESREFERENCIA`	string	Sim	O parâmetro MESREFERENCIA deve ser de 01 até 12.
`NIS`	string	Sim	O parâmetro NIS 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": {
    "nis": "string",
    "cpf": "string",
    "nome": "string",
    "beneficios": [
      {
        "numeroRegistro": 0,
        "dataMesCompetencia": "string",
        "dataMesReferencia": "string",
        "valor": "string",
        "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