Pular para o conteúdo principal

Criação de Operação

info

Descrição​

Cria o contrato de empréstimo INSS

Endpoint​

POST /inss/v1/operation

Headers​

{
  "Authorization": "Bearer {TOKEN_DO_LOGIN}",
}



1. Params 'client'​

{
  "client": {
    "document_number": "12345678909",
    "person_name": "IVOLANDO MIRANDA",
    "mother_name": "Ivolanda Testes",
    "birth_date": "1961-02-07",
    "profession": "",
    "nationality": "Brasileiro",
    "marital_status": "single",
    "email": "teste@teste.com",
    "country_code": "055",
    "area_code": "11",
    "phone_number": "911111111",
    "street": "STREET API",
    "state": "BA",
    "city": "API CITY",
    "neighborhood": "NEIGHBORHOOD API",
    "number": "1",
    "postal_code": "45600000",
    "complement": "",
    "bank_account": {
      "ispb_number": "60701190",
      "bank_code": "341",
      "account_type": "checking_account",
      "branch_number": "0155",
      "account_number": "000059923",
      "account_digit": "6",
      "pix_transfer_type": "manual"
},

O objeto “bank_account” pode ser pego no retorno do endpoint balance, precisamente em: “disbursement_bank_account”.



2. Params 'operation'​

{
"operation": {
    "IN100": true,
    "credit_type": "checking_account",
    "assistance_type": "retirement_by_age",
    "simulation_type": "installment_face_value",
    "benefit_state": "SP",
    "cod_tabela": "200010",
    "number_of_installments": 84,
    "first_due_date": "2026-01-26",
    "issue_amount": 12444.67,
    "disbursement_date": "2025-12-03",
    "limit_days_to_disburse": 3,
    "benefit_number": 2052711150,
    "disbursed_amount": 12007.6,
    "installment_face_value": 300
  },
}

Observações:​

É necessário definir dentro de "simulation_type" : "installment_face_value" ou "disbursed_amount". Também será necessário informar a variável de ambos, junto do simulation_type : "disbursed_amount" e "installment_face_value"


Exemplo :​

    {
    ...
      "simulation_type": "installment_face_value",
      "disbursed_amount": 10937.67,
      "installment_face_value":324.32,
    ...   
    }


3. Payload​

{
  "operation": {
    "IN100": true,
    "credit_type": "checking_account",
    "assistance_type": "retirement_by_age",
    "simulation_type": "installment_face_value",
    "benefit_state": "SP",
    "cod_tabela": "200010",
    "number_of_installments": 84,
    "first_due_date": "2026-01-26",
    "issue_amount": 12444.67,
    "disbursement_date": "2025-12-03",
    "limit_days_to_disburse": 3,
    "benefit_number": 2052711150,
    "disbursed_amount": 12007.6,
    "installment_face_value": 300
  },
  "client": {
    "document_number": "12345678909",
    "person_name": "IVOLANDO MIRANDA",
    "mother_name": "Ivolanda Testes",
    "birth_date": "1961-02-07",
    "profession": "",
    "nationality": "Brasileiro",
    "marital_status": "single",
    "email": "teste@teste.com",
    "country_code": "055",
    "area_code": "11",
    "phone_number": "911111111",
    "street": "STREET API",
    "state": "BA",
    "city": "API CITY",
    "neighborhood": "NEIGHBORHOOD API",
    "number": "1",
    "postal_code": "45600000",
    "complement": "",
    "bank_account": {
      "ispb_number": "60701190",
      "bank_code": "341",
      "account_type": "checking_account",
      "branch_number": "0155",
      "account_number": "000059923",
      "account_digit": "6",
      "pix_transfer_type": "manual"
    }
  }
}

Observações:​

1 - cod_tabela - pode ser puxado na listagem de produtos no endpoint abaixo: GET → /inss/v1/operation/tabela_produto

2 - assistance_type - deve-se informar a descrição, que pode ser encontrado na aba de Enumeradores na documentação.

3 - in100 - É o fluxo necessário para criação da operação, o mesmo recebe dados boolean - True or False, sendo True para fluxo "Com IN100" e False para "Sem IN100"

4 - number_of_installments refere-se ao número de parcelas da proposta simulada.

5 - installment_face_value refere-se ao valor de abatimento de parcela e deve ser definido entre 84 ou 96 parcelas.

6 - disbursed_amount refere-se ao valor desembolsado da proposta simulada.

7 - issue_amount é o valor total de emissão, o mesmo pode ser obtido na resposta da simulação.

Dados relevantes:

{
  “debt_key”: Chave da operação,
  “link_form”: Link de formalização,
  “num_contrato”: Número da operação (0142115893/T),
  “dsc_situacao_emprestimo”: Status da Operação,
}
info

Resposta​

Obs: A debt_key é utilizada para acompanhamento