A API tem por finalidade retornar a média da renda familiar por faixas de enquadramento. Estas faixas são customizadas conforme consumidor, de acordo com contrato e condições previamente autorizadas.
O cálculo da renda é baseado em informações do CNIS (Cadastro Nacional de Informações Sociais), por meio de serviço oferecido pela Dataprev para possibilitar a consulta a informações de valores que compõem a renda de cada indivíduo.
O desenvolvimento e regras foram apoiados em definições da Secretaria de Previdência, INSS e MEC, este último com vistas a programas voltados para estudantes do ensino superior.
A API recebe o CPF do cidadão e das pessoas que compõem o grupo familiar e retorna a faixa de enquadramento da média mensal da renda familiar em salários-mínimos, de acordo com especificado previamente.
Ainda compreende mais 2 parâmetros: A quantidade de meses para apuração desta média e a competências a partir da qual será feita a retroação para apuração dos valores.