💡A API INSS (Instituto Nacional do Seguro Social) permite verificar se o CPF informado é de uma entidade que possui aposentadoria no Instituto Nacional do Seguro Social.
Introdução
A API INSS fornece:
- Verificação de status de aposentadoria
- Confirmação de dados cadastrais
- Validação de beneficiários
- Informações para análise de crédito
- Dados para compliance
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br
Endpoint
INSS
GET /api/InstitutoNacionalSeguroSocial
Descrição: Endpoint para realizar a consulta INSS - Instituto Nacional do Seguro Social. Obs: esta consulta não possui comprovante.
Autenticação
Para acessar esta API, é necessário fornecer um token de autenticação.
Regras de Autenticação:
- O token deve ser enviado como parâmetro na URL da requisição.
- O token é obrigatório para realizar consultas.
- Em caso de dúvidas sobre o token, entre em contato com: suporte@directd.com.br
Campos da API
Dados do Beneficiário
- CPF: Número do CPF do beneficiário
- Nome: Nome completo do beneficiário
- Flag Possível Aposentado: Indicador se o CPF consultado possui aposentadoria
- Status: Status atual do beneficiário
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CPF | string | Sim | CPF do beneficiário. Pode ser enviado com ou sem formatação. |
| TOKEN | string | Sim | Token de autenticação necessário para a consulta. |
Exemplos de Requisição
Usando cURL
curl 'https://apiv3.directd.com.br/api/InstitutoNacionalSeguroSocial?CPF=12345678900&TOKEN=seu_token_aqui'
Respostas
Sucesso (200)
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"cpf": "string",
"nome": "string",
"possivelAposentado": true,
"status": "string"
}
}
Outros Códigos de Resposta
| Código | Descrição |
|---|---|
| 201 | Sucesso: a requisição async foi criada com sucesso e está em processamento. |
| 202 | Em Processamento: a requisição async ainda está em processamento. |
| 400 | Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos. |
| 401 | Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso. |
| 403 | Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível. |
| 404 | Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado. |
| 408 | Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido. |
| 500 | Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte. |
| 503 | Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte. |
Aplicações
- Análise de Risco/Crédito
- Compliance/ESG
- Verificação de Beneficiários
- Due Diligence
- Validação de Dados Cadastrais
Notas Importantes
- O valor da consulta é de R$ 0,36
- A API está na versão v3
- Esta consulta não possui comprovante
- Para suporte técnico, entre em contato com suporte@directd.com.br
- Fonte: Fornecedor Externo