Homologado CENPROT
Central de Ajuda/Catálogo de APIs/Cadastral/Bolsa Família

Cadastral

Auxílio Emergencial
Auxílio Reconstrução
Benefício de Prestação Continuada - BPC
Benefícios Sociais - Pessoa Física
Bolsa Família
Cadastro - Pessoa Física - Básica
Cadastro - Pessoa Física - Plus
Cadastro - Pessoa Jurídica - Básica
Cadastro - Pessoa Jurídica - Plus
Cadastro + Receita Federal - Pessoa Física
CNH - Carteira Nacional de Habilitação
CNH - Carteira Nacional de Habilitação Plus
CONFEA/CREA - Conselho Federal de Engenharia e Agronomia
Correios - Busca CEP
CVM - Comissão de Valores Mobiliários
CVM - Processos Administrativos Sancionadores
Enriquecimento de Lead
Gás do Povo
Identity Verification - Argentina
Ministério do Trabalho - PIS
OAB - Cadastro Nacional dos Advogados
Óbito
Portal da Transparência - Indicadores Pessoa Física
Portal da Transparência - Indicadores Pessoa Jurídica
Portal da Transparência - Servidores - Completa
Portal da Transparência - Servidores - Remuneração
Portal da Transparência - Servidores do Poder Executivo Federal
Portal da Transparência - Servidores Viagens e despesas
Registration Data - Argentina
Registration Data - Brazil
Registration Data - México
Seguro Defeso
Similarity - Argentina
Similarity - Brazil
Similarity - México
Vínculo Empregatício

Bolsa Família

Disponível
Abrangência: Federal · PF · Fonte: Online

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.

Endpoint
https://apiv3.directd.com.br/api/BolsaFamilia?Nis={0}&MesReferencia={1}&AnoReferencia={2}&MesCompetencia={3}&AnoCompetencia={4}
Preço por consulta
R$ 0,36
Público-alvo
PF
Versão
v3

Parâmetros

NomeTipoObrig.Descrição
NISstringNão
O parâmetro NIS pode ser enviado com ou sem formatação.
MESREFERENCIAstringNão
O parâmetro MESREFERENCIA deve ser de 01 até 12.
ANOREFERENCIAstringNão
O parâmetro ANOREFERENCIA deve conter os 4 dígitos. Ex: 2024.
MESCOMPETENCIAstringNão
O parâmetro MESCOMPETENCIA deve ser de 01 até 12.
ANOCOMPETENCIAstringNão
O parâmetro ANOCOMPETENCIA deve conter os 4 dígitos. Ex: 2024.

Campos retornados

CampoDescrição
CPFCPF do indivíduo
NomeNome do indivíduo/registro
Lista de BenefíciosLista os dados do benefício de bolsa família consultado
Código IDCódigo de identificação
Dados do SaqueInforma os dados do saque do Bolsa Família
DataData do registro
ValorValor da parcela
CompetênciaDados da data de competência da parcela do Bolsa Família
Ano de CompetênciaAno de competência da parcela
Mês de CompetênciaMês de competência da parcela
ReferênciaDados da data de referência da parcela do Bolsa Família
PaísPaís onde o registro é localizado
IBGEDados do IBGE do município
CódigoCódigo do registro
RegiãoDados da região onde o município se situa
UFUnidade Federativa (estado) referente ao registro
MunicípioMunicípio/cidade referente ao registro
NISCódigo NIS (Número de Identificação Social) do titular

Esta página foi útil?

curl -X GET \
  "https://apiv3.directd.com.br/api/BolsaFamilia?Nis=valor&MesReferencia=valor&AnoReferencia=valor&MesCompetencia=valor&AnoCompetencia=valor&TOKEN=SEU_TOKEN"
Exemplo de resposta
200 OK
{
  "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"
      }
    ]
  }
}
Falar com suporte