create-client-from-onboarding

Requisição

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

string

opcional

Padrão:

application/json

Content-Type

string

opcional

Padrão:

application/json

Parâmetros Bodyapplication/json

voucher

string

requerido

Voucher fornecido pelo cliente da Inovanti IP

calculation_method

string

requerido

Método de calculo confome a tabela de Enum OperationCalcMethodEnum

released_value

string

requerido

Valor da simulação

first_due_date

string

requerido

Data para o primeiro pagamento

number_of_installments

integer

requerido

Número de parcelas

periodicity

string

requerido

Periodicidade de pagamentos conforme a tabela de Enum OperationFrequencyEnum

modality

string

requerido

Modalidade de pagamento conforme a tabela de Enum OperationModalityEnum

Exemplo

{
    "client_id": 7,
    "voucher": "TZH5V6CW",
    "taxid_number": "57248397091", // 10369642481 - CPF Murilo para teste onboarding
    "organization_uuid": "c0b61bfd-0eda-5694-87c3-d049a9684b19",
    "physical": {
        "birth_date": "1975-01-30",
        "mother_name": "Aparecida das graças de Carvalho Kania",
        "general_registration_type": "cnh",
        "general_registration_number": "123456",
        "general_registration_organ": "SSP",
        "general_registration_federal_unit": "PR",
        "general_registration_emission": "2020-01-01",
        "nationality": "Brasileiro",
        "naturalness": "Londrina"
    },
    "banks": [
        {
            "bank_ispb": "00416968",
            "agency": "0001",
            "account": "123456",
            "account_digit": "1",
            "account_type": "CC",
            "key_pix": "4ca519ef-0ccc-4c41-b58b-c88f1f47d8ab"
        }
    ]
}

Respostas

🟢200Success

application/json

Body

object {0}

Exemplo

{
  "user_uuid": "677a35cd-cd49-4339-8a25-1aef24803ee0",
  "requested_amount": 1000,
  "calculating_from": "requested",
  "calculation_method": "price_table",
  "payment_frequency": "monthly",
  "person_type": "physical",
  "modality": "FI",
  "interest_rate": 0.0499,
  "num_payments": 12,
  "first_payment_date": "2025-01-17",
  "last_payment_date": "2026-01-17",
  "disbursement_date": "2024-12-19",
  "issue_date": "2024-12-19",
  "loan_details": {
    "financed_amount": 1028.77,
    "operation_fess": {
      "tac_amount": 7,
      "tac_percentage": 0.007,
      "other_costs": 0
    },
    "iof": {
      "iof_fixed": 3.9093427425370484,
      "daily": 17.889012793418594,
      "iof_days": 365,
      "iof_total": 21.8
    },
    "annual_interest_rate": 0.0499,
    "annual_effective_interest_rate": 0.7938049935216254,
    "monthly_effective_interest_rate": 0.06615041612680211,
    "total_amount_owed": 1392.12,
    "disbursement_amount": 1000,
    "payment_amount": 116.01,
    "schedule": [
      {
        "payment": 116.01,
        "iof": 0.15,
        "balance": 964.1,
        "interest": 51.34,
        "principal": 64.67,
        "period": 1,
        "running_day": 28,
        "payment_date": "2025-01-17"
      },
      {
        "payment": 116.01,
        "iof": 0.33,
        "balance": 896.21,
        "interest": 48.11,
        "principal": 67.9,
        "period": 2,
        "running_day": 59,
        "payment_date": "2025-02-17"
      },
      {
        "payment": 116.01,
        "iof": 0.51,
        "balance": 824.92,
        "interest": 44.72,
        "principal": 71.29,
        "period": 3,
        "running_day": 87,
        "payment_date": "2025-03-17"
      },
      {
        "payment": 116.01,
        "iof": 0.72,
        "balance": 750.08,
        "interest": 41.16,
        "principal": 74.84,
        "period": 4,
        "running_day": 118,
        "payment_date": "2025-04-17"
      },
      {
        "payment": 116.01,
        "iof": 0.95,
        "balance": 671.5,
        "interest": 37.43,
        "principal": 78.58,
        "period": 5,
        "running_day": 148,
        "payment_date": "2025-05-17"
      },
      {
        "payment": 116.01,
        "iof": 1.21,
        "balance": 589,
        "interest": 33.51,
        "principal": 82.5,
        "period": 6,
        "running_day": 179,
        "payment_date": "2025-06-17"
      },
      {
        "payment": 116.01,
        "iof": 1.48,
        "balance": 502.39,
        "interest": 29.39,
        "principal": 86.62,
        "period": 7,
        "running_day": 209,
        "payment_date": "2025-07-17"
      },
      {
        "payment": 116.01,
        "iof": 1.79,
        "balance": 411.45,
        "interest": 25.07,
        "principal": 90.94,
        "period": 8,
        "running_day": 240,
        "payment_date": "2025-08-17"
      },
      {
        "payment": 116.01,
        "iof": 2.12,
        "balance": 315.97,
        "interest": 20.53,
        "principal": 95.48,
        "period": 9,
        "running_day": 271,
        "payment_date": "2025-09-17"
      },
      {
        "payment": 116.01,
        "iof": 2.47,
        "balance": 215.73,
        "interest": 15.77,
        "principal": 100.24,
        "period": 10,
        "running_day": 301,
        "payment_date": "2025-10-17"
      },
      {
        "payment": 116.01,
        "iof": 2.87,
        "balance": 110.49,
        "interest": 10.77,
        "principal": 105.24,
        "period": 11,
        "running_day": 332,
        "payment_date": "2025-11-17"
      },
      {
        "payment": 116.01,
        "iof": 3.28,
        "balance": 0,
        "interest": 5.51,
        "principal": 110.49,
        "period": 12,
        "running_day": 362,
        "payment_date": "2025-12-17"
      }
    ]
  }
}

🟠401Não autorizado