Pular para o conteúdo principal

2.4.1. Aprovação

Esta seção documenta os endpoints responsáveis pela efetivação da aprovação de saldo de empréstimos consignados INSS. Esses endpoints permitem confirmar as condições simuladas, validar informações contratuais, registrar o aceite da operação e concluir a aprovação da proposta, observando as regras de elegibilidade, margem consignável e políticas vigentes.

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.

Fluxo de Trabalho Recomendado​

Para operar contratos de empréstimo, siga este fluxo:

  1. Buscar Contratos pelo ID (GET /v3/loans/simulation/{{simulation_id}})

    • Utilize a busca para listar os contratos disponíveis e aplicar filtros
    • O objetivo principal é obter o id (UUID) do contrato desejado

  2. Obter Detalhes (GET /v3/loans/:id)

    • Com o id em mãos, chame esta rota para ver os dados completos
    • ⚠️ Atenção: O retorno fornece informações cruciais como rule.id (necessário para recálculos)

  3. Operar sobre o Contrato (POST /v3/loans/:id/recalculation)

    • Utilize o id na URL e os dados obtidos no passo anterior (como rule.id) no corpo da requisição
    • Realize simulações ou alterações nas condições do empréstimo

Formatos de Dados​

  • Protocolo: HTTPS
  • Requests e Responses: JSON (application/json)
  • Identificadores: UUID v4 (ex: b3b0e362-8aa2-4b3c-b8cd-8a9142eafe64)
  • Datas: Formato ISO 8601 (ex: 2025-11-13T14:44:00Z)

GET 2.1.2.2. Obter Empréstimo por ID​

/v3/loans/:id

Retorna todas as informações técnicas, financeiras e cadastrais de um empréstimo específico.

Parâmetros de Rota (Path)​

VariávelDescrição
:idO UUID do empréstimo (obtido na rota de Busca)

Pontos de Atenção no Retorno​

O JSON de resposta contém campos importantes para outras operações:

  • rule.id: O ID da tabela/regra atual. Necessário para fazer recálculos.
  • status.key: O status atual do contrato (ex: awaiting_portability).

Exemplo de Requisição e Resposta​

Visualizar cURL
curl --location 'https://integration.ajin.io/v3/loans/b3b0e362-8aa2-4b3c-b8cd-8a9142eafe64' \
--header 'apikey: {{apikey}}'

POST Recalcular Empréstimo​

/v3/loans/:id/recalculation

Permite simular uma alteração nas condições do empréstimo, como mudança de taxa de juros ou inclusão/remoção de seguro.

Parâmetros de Rota (Path)​

VariávelDescrição
:idO UUID do empréstimo que será simulado

Parâmetros do Body​

CampoTipoObrigatórioDescrição
ruleIdstring (UUID)SimID da tabela de produto
hasInsurancebooleanSimDefine se a simulação deve incluir seguro (true) ou não (false)
refinance.ratenumberSimA nova taxa de juros mensal desejada para o recálculo (ex: 1.8)

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "ruleId": "0e0e25c7-ce99-4f09-97a7-194e92e51016",
    "hasInsurance": false,
    "refinance": {
        "rate": 1.8
    }
}

POST Aceitar Termos​

/v3/loans/:id/accept

Confirma e aplica as novas condições negociadas ao contrato.

Importante

Os valores enviados aqui (ruleId, hasInsurance, refinance.rate) devem ser exatamente os mesmos que foram validados previamente na rota de Recálculo (/recalculation).

Parâmetros de Rota (Path)​

VariávelDescrição
:idUUID do contrato que sofrerá a alteração

Parâmetros do Body​

CampoTipoObrigatórioDescrição
ruleIdstring (UUID)SimID da tabela de produto
hasInsurancebooleanSimtrue para manter/incluir seguro, false para remover
refinance.ratenumberSimA taxa final acordada (ex: 1.8)
reformalizebooleanSimtrue dispara nova formalização digital (assinatura). false apenas ajusta valores internos

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "ruleId": "0e0e25c7-ce99-4f09-97a7-194e92e51016",
    "hasInsurance": false,
    "refinance": {
        "rate": 1.8 
    },
    "reformalize": false
}