Enquadramento Renda
Consultar o enquadramento da renda por CPF: Permite consultar o enquadramento de acordo renda da pessoa no período definido pela competência de referência e 12 meses.
Entrada {
| description: | Parâmetros de entrada para obter um enquadramento de renda |
| cpf* | CPF parâmetro para pesquisa da renda |
| competenciaReferencia | string($Formato ISO-8601 <YYYY-MM>) example: 2019-04 Competencia de referência para a consulta. Valor padrão: Competência corrente menos 2 meses |
Path Param:
| Cpf | CPF (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 | |
| Código | Código da faixa de renda enquadrada |
| Valor mínimo da faixa | Limite mínimo da faixa em R$ |
| Valor máximo da faixa | Limite máximo da faixa em R$ |
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 |