Pular para o conteúdo principal

2.1.1. Contrato Novo

Na modalidade Contrato Novo, é realizada a formalização de uma nova operação de crédito, sem vínculo com contratos anteriores, considerando a margem consignável disponível do cliente. Nessa modalidade, são estabelecidas as condições da operação, tais como valor contratado, prazo, taxa de juros e valor das parcelas, com a geração de um novo instrumento contratual.

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 Listar Produtos por tipo de operação​

/v3/loan-products/search/basic

Este endpoint permite listar os produtos de empréstimo disponíveis filtrando por tipo e operação.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
type.code.eqnumberSimCódigo do tipo de produto a filtrar
operation.code.eqnumberSimCódigo da operação desejada

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "type": {
        "code": {
            "eq": 20
        }
    },
    "operation": {
        "code": {
            "eq": 3
        }
    }
}

POST Listar Tabelas por tipo de operação​

/v3/loan-product-rules/search/basic

Este endpoint permite listar as tabelas de regras de produtos de empréstimo filtrando por tipo de operação.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
offsetnumberSimÍndice inicial para paginação
limitnumberSimQuantidade máxima de registros retornados (Máximo de 20 por página)
operation.code.eqnumberSimCódigo da operação desejada

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "offset": 0,
    "limit": 0, 
    "operation": {
        "code": {
            "eq":  3
        }
    }
}

POST Calculadora de novo contrato de INSS​

/v3/loan-inss-simulations/calculation

Este endpoint permite calcular os valores de um contrato novo de INSS antes de criar a simulação.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
ruleIdstring (UUID)SimID da tabela de produto
hasInsurancebooleanSimtrue para incluir seguro, false para remover
installmentValuenumberSimValor da parcela desejada
loanValuenumberSimValor total do empréstimo
ratenumberSimTaxa de juros mensal
termnumberSimPrazo em meses
referenceCodestring | nullNãoCódigo de referência externo

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "ruleId": "{{RuleId}}",
    "hasInsurance": false,
    "installmentValue": 43.54,
    "loanValue": 1918.35,
    "rate": 1.66,
    "term": 84,
    "referenceCode": null
}

POST Criar uma nova simulação para contrato de INSS​

/v3/loan-inss-simulations

Este endpoint permite criar uma simulação de contrato novo de INSS.

Parâmetros do Body​

Visualizar Parâmetros
CampoTipoObrigatórioDescrição
borrower.namestringSimNome completo do tomador
borrower.identitystringSimCPF do tomador
borrower.benefitstringSimNúmero do benefício INSS
borrower.benefitStatestringSimUF do benefício
borrower.benefitStartDatestring (ISO 8601)SimData de início do benefício
borrower.benefitTypenumberSimCódigo do tipo de benefício
borrower.birthDatestring (ISO 8601)SimData de nascimento
borrower.incomenumberSimRenda mensal do tomador
borrower.phonestringSimTelefone com DDD
borrower.emailstringSimE-mail do tomador
borrower.addressobjectSimEndereço completo
borrower.documentobjectSimDocumento de identificação
items[].ruleIdstring (UUID)SimID da tabela de produto
items[].hasInsurancebooleanSimIndica se há seguro
items[].installmentValuenumberSimValor da parcela
items[].loanValuenumberSimValor total do empréstimo
items[].ratenumberSimTaxa de juros mensal
items[].termnumberSimPrazo em meses
creditBankAccountobjectSimDados bancários para crédito
filesarraySimDocumentos anexados (doc_front, doc_back)
step.codenumberSimEtapa atual da proposta

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "borrower": {
        "name": "{{name}}",
        "identity": "{{identity}}",
        "benefit": "{{inss_benefit}}",
        "benefitState": "SP",
        "benefitStartDate": "1999-01-15",
        "benefitPaymentMethod": 1,
        "benefitType": 42,
        "birthDate": "1965-08-19",
        "motherName": "Maria da Silva",
        "maritalStatus": "Solteiro",
        "sex": "Feminino",
        "income": 1800.50,
        "phone": "{{phone}}",
        "email": "[email protected]",
        "address": {
            "street": "Av. Paulista",
            "number": "552",
            "complement": "Bloco A",
            "district": "Centro",
            "city": "São Paulo",
            "state": "SP",
            "zipCode": "01310930"
        },
        "document": {
            "type": {
                "code": "RG",
                "name": "Registro Geral"
            },
            "number": "12232323",
            "issuingDate": "1990-05-21",
            "issuingEntity": "SSP",
            "issuingState": "SP"
        }
    },
    "items": [
        {
            "ruleId": "{{newRuleId}}",
            "hasInsurance": true,
            "installmentValue": 43.54,
            "loanValue": 1918.35,
            "rate": 1.66,
            "term": 84,
            "referenceCode": null
        }
    ],
    "creditBankAccount": {
        "bank": "001",
        "branch": "1234",
        "number": "123654",
        "digit": "6"
    },
    "step": {
        "code": 0,
        "name": null
    },
    "files": [
        {
            "id": "{{doc_front_id}}",
            "type": "doc_front"
        },
        {
            "id": "{{doc_back_id}}",
            "type": "doc_back"
        }
    ],
    "note": null,
    "brokerId": null,
    "accessId": null
}

GET Obter termo de autorização​

/v3/loan-inss-simulations/{{simulation_id}}/auth-term

Este endpoint retorna o termo de autorização para consulta do benefício INSS. O campo key retornado deve ser utilizado no próximo passo para assinatura do termo.

Exemplo de Requisição e Resposta​

Visualizar cURL
curl --location 'https://integration.ajin.io/v3/loan-inss-simulations/{{simulation_id}}/auth-term' \
--header 'apikey: {{apikey}}'

PUT Assinar termo de autorização​

/v3/signer/{{auth_term_key}}/accept

Este endpoint realiza a assinatura do termo de autorização. Atenção: só deve ser executado se status.key != 'signed' no response do endpoint anterior.

Exemplo de Requisição e Resposta​

Visualizar Body
{
    "position": {
        "latitude": "-235489",
        "longitude": "-466388"
    }
}

POST Gerar Contratos de Empréstimo​

/v3/loan-inss-simulations/{{simulation_id}}/actions

Este endpoint é responsável por transformar uma simulação aprovada em contratos efetivos, iniciando o processo de formalização e assinatura.

Exemplo de Requisição e Resposta​

Visualizar Body
{ 
  "command": "create_loans"
}

GET Consultar Contratos de Empréstimo pelo ID da Simulação​

/v3/loans/simulation/{{simulation_id}}

Este endpoint permite consultar todos os contratos de empréstimo vinculados a uma simulação específica.

Exemplo de Requisição e Resposta​

Visualizar cURL
curl --location 'https://integration.ajin.io/v3/loans/simulation/{{simulation_id}}' \
--header 'apikey: {{apikey}}'