Pular para o conteúdo principal

2.3.1. Consulta de IN100

A consulta de IN100 (Instrução Normativa nº 100) é o procedimento de verificação de informações previdenciárias de um beneficiário diretamente na base de dados do INSS. O objetivo principal é obter dados atualizados sobre a situação do benefício, margens consignáveis disponíveis e eventuais bloqueios, servindo como base técnica essencial para a análise de viabilidade e pré-digitação de propostas de crédito consignado ou cartões de benefício.

Importante

Ressaltamos que o endpoint de criação de proposta atua como o gatilho direto para a consulta da IN100. Uma vez que os dados do cliente são inseridos e processados nesta etapa, os dados retornados já contemplarão essa validação. Recomenda-se não desenvolver fluxos que tentem validar a IN100 separadamente antes da submissão inicial.

Autenticação​

Para realizar requisições aos nossos endpoints, é necessário utilizar uma API Key válida. Esta chave é o identificador que garante a segurança e o controle de acesso às operações da plataforma.

KeyValue
apikey{{apikey}}
aviso

Importante: Mantenha sua API Key em segurança. Ela é pessoal, intransferível e dá acesso direto às operações de crédito e dados de clientes da sua conta.

POST Consultar Dados do Benefício​

/v3/query-inss-balances/finder

Antes de iniciar o processo de simulação, é necessário realizar a consulta IN100 do benefício para garantir que está ativo e cumpre as regras do banco. Esse processo requer a autorização do cliente, obtida através de um link gerado pela API.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
identitystringSimCPF do titular do benefício
benefitNumberstringSimNúmero do benefício INSS
lastHoursnumberNãoReutiliza uma consulta já realizada nas últimas N horas
timeoutnumberNãoTempo máximo de espera pela resposta em segundos

Exemplo de Requisição e Resposta​

Visualizar Body
{
  "identity": "{{identity}}",
  "benefitNumber": "{{inss_benefit}}",
  "lastHours": 1,
  "timeout": 120
}

POST Consultar Dados do Benefício com Representante Legal​

/v3/query-inss-balances/finder

Mesma consulta IN100, porém indicando um representante legal vinculado ao titular do benefício.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
identitystringSimCPF do titular do benefício
benefitNumberstringSimNúmero do benefício INSS
lastHoursnumberNãoReutiliza uma consulta já realizada nas últimas N horas
timeoutnumberNãoTempo máximo de espera pela resposta em segundos
legalRepresentative.identitystringSimCPF do representante legal

Exemplo de Requisição e Resposta​

Visualizar Body
{
  "identity": "{{identity}}",
  "benefitNumber": "{{inss_benefit}}",
  "lastHours": 1,
  "timeout": 120,
  "legalRepresentative": {
    "identity": "{{legalRepresentativeIdentity}}"
  }
}

GET Selecionar Consulta de Dados do Benefício​

/v3/query-inss-balances/{{query_inss_balance_id}}

Retorna o resultado completo de uma consulta IN100 previamente iniciada, incluindo saldos, reservas, dados do benefício e informações do representante legal, quando houver.

Parâmetros de Rota (Path)​

VariávelDescrição
{{query_inss_balance_id}}UUID da consulta retornado no endpoint de criação (id)

Exemplo de Requisição e Resposta​

Visualizar cURL
curl --location -g 'https://integration.ajin.io/v3/query-inss-balances/{{query_inss_balance_id}}' \
--header 'apikey: {{apikey}}'

POST Consultar Dados do Benefício e Aguardar Retorno​

/v3/query-inss-balances/finder/await

Inicia a consulta IN100 e aguarda de forma síncrona o retorno completo dos dados do benefício, sem necessidade de polling.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
identitystringSimCPF do titular do benefício
benefitNumberstringSimNúmero do benefício INSS

Exemplo de Requisição e Resposta​

Visualizar Body
{
  "identity": "{{identity}}",
  "benefitNumber": "{{inss_benefit}}"
}