A API de Pessoas Com Deficiencia disponibiliza a seguinte operação:
1.2.1-Registros de pessoa com deficiência
Consulta de Pessoa com Deficiência pelo CPF: Permite consultar se uma pessoa possui deficiência, ou não, passado a informação de seu CPF,
GET /cpf/{cpf}
Escopo (OAuth 2.0): não aplicável
Path Param:
| CPF | CPF da pessoa a ser pesquisada. (Obrigatório) |
Response: Caso seja encontrado um registro de nascimento a API retornará o código HTTP 200 e os dados descritos a seguir em formato JSON:
| nomeCidadao | Nome do cidadão registrado na base de dados |
| cpf | CPF do cidadão passado na chamada |
| possuiDeficiencia | Variável boleana que informa se a pessoa tem deficiência ou não. Os valores possíveis são: “true”, quando a pessoa tem deficiência, ou “false”, quando a pessoa não tem deficiência. |
Caso seja identificado algum erro no processo de validação da matrícula a API retornará o código HTTP 400 e os dados descritos a seguir em formato JSON:
| Código | 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 o CPF 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 documentação disponível na seção 2 deste documento. |