latestOpenAPI 3.0.02026-08-102034118.0 KB

8f580eff2157

Consumer Loan

Create consumer loan application

Creates a consumer loan application and assigns it to the person with the person_id specified in the request URL. The payload of the request includes all the required financial information and account data about the customer, which the credit scorer uses to initiate a series of credit checks to determine the customer's credit risk and eligibility.

post/v1/persons/{person_id}/consumer_loan_applications

Path parameters

person_idstring required

The person_id of the customer applying for the loan.

Request body

sellerstring nullable

The name of the seller of the financed good.

payout_descriptionstring nullable

Additional details around the loan payout.

solarisbank_scoringstring nullable

Solaris' score for the customer.

recipient_ibanstring nullable

The IBAN of the recipient's account. This account will be debited with a SEPA Direct Debit (SDD) in the amount of the loan's monthly installment. Unless stated otherwise in your configurations, the loan will also be paid out to this account.

payout_account_namestring nullable

The name of the payout account holder (i.e., the account to which the loan will be paid out). You may only use this field if your configurations allow it via allow_loan_specific_payout_account_ibans.

requested_interest_ratenumber float nullable

The requested monthly interest rate to apply to the loan.

requested_loan_terminteger required

The number of months over which the loan will be repaid.

payout_account_ibanstring nullable

The IBAN (different from recipient_iban) to which the loan will be paid out. You may only use this field if your configurations allow it via allow_loan_specific_payout_account_ibans.

moved_in_last_two_yearsboolean required

Field to indicate whether the customer has moved and changed addresses in the last two years.

credit_record_idstring required

The unique ID of a customer's credit record.

loan_purposestring required

The purpose of the loan.

delayed_payout_strategy'none' | 'after_revocation'

Field to indicate the payout strategy to be applied to the loan. If set to none, then the loan payout will happen automatically.

living_situation'LIVING_WITH_PARENTS' | 'LIVING_IN_RENTED_HOUSE' | 'LIVING_IN_OWN_HOUSE' required

The customer's living situation.

partner_scorestring nullable

The score assigned to the customer by your internal scoring flow.

financed_goodstring nullable

The financed good that was purchased using the loan.

repayment_day_of_month1 | 15 required

The day of the month when the customer pays the loan installment.

number_of_dependentsinteger required

The number of dependents the customer has.

employment_sincestring date nullable

The date when the customer started their current employment.

partner_reference_numberstring required

Your internal reference number for the customer.

number_of_kidsinteger nullable

The number of kids the customer has.

is_joint_applicationboolean nullable

A field to indicate whether the application is a joint application or not.

employment_untilstring date nullable

The date when the customer ended an employment.

solarisbank_risk_classinteger nullable

The risk class assigned to the customer by Solaris.

Example request

{
  "private_insurance_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "recipient_iban": "DE92370601930002130041",
  "existing_credit_repayment_excluding_mortgage": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "mortgage": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "requested_interest_rate": 0.02,
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "loan_purpose": "Buying a car.",
  "living_situation": "LIVING_IN_RENTED_HOUSE",
  "repayment_day_of_month": 1,
  "employment_since": "2019-08-24",
  "cash_price": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "requested_loan_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "net_income_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "additional_costs": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "rent": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "living_situation_amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "requested_emi": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  }
}

Response

Application

loan_decision'REJECTED' | 'OFFERED' | 'OFFERED_ALTERNATIVE' required

Solaris' decision on the consumer loan application.

idstring required

The unique ID of the loan offer.

customer_category'AMBER' | 'GREEN' | 'RED' nullable

The customer's risk category as scored by Solaris' scoring system.

Example response

{
  "offer": {
    "type": "original",
    "subsidized": false,
    "monthly_installment": {
      "value": 10000000,
      "unit": "cents",
      "currency": "EUR"
    },
    "loan_term": 36,
    "loan_amount": {
      "value": 10000000,
      "unit": "cents",
      "currency": "EUR"
    },
    "interest_rate": 0.12,
    "id": "105a0fa505f44afea4b433d170b83d87cofr",
    "effective_interest_rate": 0.13,
    "approximate_total_loan_expenses": {
      "value": 10000000,
      "unit": "cents",
      "currency": "EUR"
    },
    "annual_percentage_rate": 0.13
  },
  "loan_decision": "OFFERED",
  "id": "9b3147c5498b405d9402630bc308ad0ecofr",
  "customer_category": "GREEN"
}