## Portal da Transparência / Bolsa Família Retorna as 50 primeiras parcelas de recebidos e sacados do Bolsa Família a partir do CPF ou NIS enviado para a consulta de Benefícios do Portal da Transparência. ### URL do site - https://portaldatransparencia.gov.br/beneficios/bolsa-familia ### Requisição URL para POST: `https://api.infosimples.com/api/v2/consultas/portal-transparencia/bolsa` | Parâmetro | Descrição | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | token* | Chave de autenticação da API. É com o token que a API reconhece e autoriza quem está fazendo a consulta. | | cpf** | CPF do beneficiário. | | nis** | NIS do beneficiário. | | municipio** | Nome do município. | | data_inicio* | Data de início no formato ISO 8601. Por exemplo, 22 de Abril de 1985 é representado em ISO 8601 da forma "1985-04-22". Preste atenção que é necessário incluir zeros, o formato "1985-4-22" seria inválido. | | data_fim* | Data de fim no formato ISO 8601. Por exemplo, 22 de Abril de 1985 é representado em ISO 8601 da forma "1985-04-22". Preste atenção que é necessário incluir zeros, o formato "1985-4-22" seria inválido. | > * Parâmetro obrigatório. > ** Parâmetro opcional. Pode ser necessário informar algum dos parâmetros opcionais para que a consulta funcione adequadamente. ### Exemplos de respostas (OK) ```json { "code": 200, "code_message": "A requisição foi processada com sucesso.", "errors": [], "header": { "api_version": "v2", "service": "portal-transparencia/bolsa", "parameters": { "cpf": "11111111111", "data_fim": "1111-11-11", "data_inicio": "1111-11-11", "municipio": "São Paulo" }, "client_name": "Minha Empresa", "token_name": "Token de Produção", "billable": true, "price": "0.2", "requested_at": "2021-07-02T13:34:39.000-03:00", "elapsed_time_in_milliseconds": 2413, "remote_ip": "111.111.111.111", "signature": "U2FsdGVkX18IUDTlS8DNsJ2V9NMHKU/Fln2ERvPGlD7YNDE3vQn0hUcJpknPGfyO60PUTu/3K9klUPIGRJt11g==" }, "data_count": 1, "data": [ { "attempts": 1, "code": 200, "data": { "beneficiario": "Nome de Exemplo", "cpf": "***.111.111-**", "municipio": "São Paulo", "nis": "1.111.111.111-1", "normalizado_valor": 91, "recebidos": [ { "mes_folha": "06/2021", "mes_referencia": "06/2021", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "05/2021", "mes_referencia": "05/2021", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "04/2021", "mes_referencia": "04/2021", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "03/2021", "mes_referencia": "03/2021", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "02/2021", "mes_referencia": "02/2021", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "01/2021", "mes_referencia": "01/2021", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "12/2020", "mes_referencia": "12/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "11/2020", "mes_referencia": "11/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "10/2020", "mes_referencia": "10/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "09/2020", "mes_referencia": "09/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "08/2020", "mes_referencia": "08/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "07/2020", "mes_referencia": "07/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "06/2020", "mes_referencia": "06/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "05/2020", "mes_referencia": "05/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "04/2020", "mes_referencia": "04/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "03/2020", "mes_referencia": "03/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "02/2020", "mes_referencia": "02/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "01/2020", "mes_referencia": "01/2020", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "12/2019", "mes_referencia": "12/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "11/2019", "mes_referencia": "11/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "10/2019", "mes_referencia": "10/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "09/2019", "mes_referencia": "09/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "08/2019", "mes_referencia": "08/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "07/2019", "mes_referencia": "07/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "06/2019", "mes_referencia": "06/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "05/2019", "mes_referencia": "05/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "04/2019", "mes_referencia": "04/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "03/2019", "mes_referencia": "03/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "02/2019", "mes_referencia": "02/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "01/2019", "mes_referencia": "01/2019", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "12/2018", "mes_referencia": "12/2018", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "11/2018", "mes_referencia": "11/2018", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "10/2018", "mes_referencia": "10/2018", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "09/2018", "mes_referencia": "09/2018", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "08/2018", "mes_referencia": "08/2018", "uf": "SP", "municipio": "São Paulo", "dependentes": "1", "valor": "91,00", "normalizado_valor": 91 } ], "sacados": [ { "mes_folha": "03/2021", "mes_referencia": "03/2021", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "02/2021", "mes_referencia": "02/2021", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "01/2021", "mes_referencia": "01/2021", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "12/2020", "mes_referencia": "12/2020", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "11/2020", "mes_referencia": "11/2020", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "10/2020", "mes_referencia": "10/2020", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "09/2020", "mes_referencia": "09/2020", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "03/2020", "mes_referencia": "03/2020", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "02/2020", "mes_referencia": "02/2020", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "01/2020", "mes_referencia": "01/2020", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "12/2019", "mes_referencia": "12/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "11/2019", "mes_referencia": "11/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "10/2019", "mes_referencia": "10/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "09/2019", "mes_referencia": "09/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "08/2019", "mes_referencia": "08/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "07/2019", "mes_referencia": "07/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "06/2019", "mes_referencia": "06/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "05/2019", "mes_referencia": "05/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "04/2019", "mes_referencia": "04/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "03/2019", "mes_referencia": "03/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "02/2019", "mes_referencia": "02/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "01/2019", "mes_referencia": "01/2019", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "12/2018", "mes_referencia": "12/2018", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "11/2018", "mes_referencia": "11/2018", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 }, { "mes_folha": "10/2018", "mes_referencia": "10/2018", "uf": "SP", "municipio": "São Paulo", "data_saque": "11/11/1111", "valor": "91,00", "normalizado_valor": 91 } ], "uf": "SP", "valor": "91,00" }, "site_receipt": null } ], "site_receipts": [] } ``` ### Arquivo de visualização de consulta O arquivo de visualização de consulta (`site_receipts`) disponibilizado no retorno da API **pode ser sintetizado pela Infosimples** usando as informações originais da fonte quando o arquivo emitido pela fonte não for adequado para visualização. ### Exemplos de códigos para integração com a API #### Python ```python # Testado com: Python 3.10.19, Python 3.14.0 import requests url = 'https://api.infosimples.com/api/v2/consultas/portal-transparencia/bolsa' args = { "cpf": "VALOR_DO_PARAMETRO_CPF", "nis": "VALOR_DO_PARAMETRO_NIS", "municipio": "VALOR_DO_PARAMETRO_MUNICIPIO", "data_inicio": "VALOR_DO_PARAMETRO_DATA_INICIO", "data_fim": "VALOR_DO_PARAMETRO_DATA_FIM", "token": "INFORME_AQUI_O_TOKEN_DA_CHAVE_DE_ACESSO", "timeout": "300" } response = requests.post(url, args) response_json = response.json() response.close() if response_json['code'] == 200: print("Retorno com sucesso: ", response_json['data']) elif response_json['code'] in range(600, 799): mensagem = "Resultado sem sucesso. Leia para saber mais: \n" mensagem += "Código: {} ({})\n".format(response_json['code'], response_json['code_message']) mensagem += "; ".join(response_json['errors']) print(mensagem) print("Cabeçalho da consulta: ", response_json['header']) print("URLs com arquivos de visualização (HTML/PDF): ", response_json['site_receipts']) ``` ## Estamos prontos para ajudar Ainda tem alguma dúvida ou precisa de ajuda na sua integração? Entre em contato em [suporte@infosimples.com.br](mailto:suporte@infosimples.com.br) e receba ajuda da nossa equipe técnica altamente qualificada.