A API de Renda Familiar disponibiliza os seguintes recursos e operações:
Enquadramento Renda
Consultar o enquadramento da renda familiar por lista de CPF: Permite consultar o enquadramento de acordo com a média de renda das pessoas de uma lista de CPFs no período definido pela competência de referência e quantidade de meses.
POST /enquadramentos-renda
EntradaEnquadramentoRendaFamiliar{
description: Parâmetros de entrada para uma solicitação de enquadramento
de renda familiar
listaCpf* [...]
rendaMediaDeclarada* number($float)
example: 1500.99
Renda média declarada para os CPFs avaliados
quantidadeMeses* integer
example: 10
minimum: 1
Quantidade de meses que vão compor o enquadramento de
renda
competenciaReferencia string($Formato ISO-8601 <YYYY-MM>)
example: 2019-04
Competência de referência para a consulta.
Valor padrão: Competência corrente menos 2 meses
Path Param:
| Lista de cpf | Lista de CPF separados por vírgulas (obrigatório) |
| Renda média declarada | Renda média declarada para os CPFs avaliados (obrigatório) |
| Quantidade de Meses | Quantidade de meses que vão compor o enquadramento de renda (obrigatório) |
| Competencia Referência | Competência de referência para a consulta. Valor mais recente aceito: Competência corrente menos 2 meses (opcional) |
Response: Caso sejam encontrados dados o cálculo, a API retornará o código HTTP 200 e os dados descritos a seguir em formato JSON:
| Faixa de renda familiar | |
| Código | Código da faixa de renda enquadrada |
| Descrição | exemplo: Renda média no CNIS menor ou igual que 1 salário-mínimo |
| Indicador Comparação | Indicador de comparação da renda familiar declarada com o CNIS |
| Código | Código de comparação da renda familiar declarada com o CNIS |
| Descrição | Descrição de comparação da renda familiar declarada com o CNIS |
Caso seja identificado erro no processo de validação do CPF a API retornará o código HTTP 400 e os dados descritos a seguir em formato JSON:
| codigo | Código da mensagem. |
| erro | Breve descrição da mensagem. |
| descricao | Descrição completa da mensagem com solução. |
A consulta poderá retornar um dos códigos HTTP descritos a seguir, em caso de insucesso na realização da consulta:
| 404 | Não foi encontrado um registro para o parâmetro informado |
| 401 | O access token expirou. É preciso gerar um novo token. Os tokens tem validade de 1 hora |
| 500 | Ocorreu um erro interno na API durante a realização da consulta. Caso o problema persista, entre em contato com a Dataprev, conforme descrito na seção 3 |