Sign in
latestOpenAPI 3.0.02026-08-102737124.3 KB

06b62340347d

Consumer Credit Line

Create a consumer credit line application

Creates a consumer credit line application and assigns it to the person with the person_id included in the request URL. The payload of this endpoint includes all the required financial information and account data about the applicant, which the credit scorer uses to initiate a series of credit checks. See the Consumer Splitpay guide for the list of mandatory properties.

post/v1/persons/{person_id}/credit_line_applications

Path parameters

person_idstring required

The person ID of the customer applying for the credit line.

Request body

repayment_day_of_month1 | 15 nullable

The day of the month when the customer repays the monthly installment.

recipient_ibanstring nullable

The IBAN of the customer's account to use for the account snapshot.

pre_selected_by_partnerboolean nullable

Field to indicate whether the customer is already pre-selected based on your internal scoring flow.

partner_scorestring nullable

Field to enter your internal scoring of the customer.

partner_reference_numberstring nullable

Field to enter your internal reference number for the customer.

number_of_dependentsinteger nullable

The number of persons depending on the customer's income, e.g., family members.

moved_in_last_two_yearsboolean nullable

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

marriage_status'MARRIED' | 'UNMARRIED' | 'DIVORCED' | 'UNKNOWN' nullable

The customer's marital status.

living_situation'LIVING_WITH_PARENTS' | 'LIVING_IN_RENTED_HOUSE' | 'LIVING_IN_OWN_HOUSE' nullable

The customer's living situation.

identification_idstring nullable

The unique ID of a customer's identification resource.

employment_sincestring date nullable

The date when the customer began their current employment.

credit_record_idstring nullable

The unique ID of a customer's credit record.

Example request

{
  "requested_credit_limit": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "repayment_day_of_month": 1,
  "recipient_iban": "DE92370601930002130041",
  "private_insurance_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "partner_reference_number": "AGHD02130041",
  "number_of_dependents": 2,
  "net_income_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "marriage_status": "MARRIED",
  "living_situation_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "living_situation": "LIVING_IN_RENTED_HOUSE",
  "identification_id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
  "existing_credit_repayment_excluding_mortgage": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "employment_since": "2019-11-01",
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}

Response

Application

status_descriptionstring nullable

Additional details about the credit line application status.

status'initial_scoring_pending' | 'account_snapshot_pending' | 'account_snapshot_verification_pending' | 'identification_pending' | 'offered' | 'esign_pending' | 'esign_complete' | 'esign_failed' | 'credit_line_creation_pending' | 'credit_line_created' | 'expired' | 'deleted' | 'rejected' | 'scoring_pending' required

The status of a consumer credit line application.

signing_idstring nullable

The ID of the signing resource, created after the customer's identification and e-signing process has been triggered.

recipient_ibanstring nullable

The IBAN of the customer's account to use for the account snapshot.

reasonstring nullable

The reason(s) for rejecting a credit line application.

person_idstring required

The person ID of the customer applying for the credit line.

partner_reference_numberstring nullable

The partner reference number.

offered_interest_ratenumber nullable

The offered interest rate to apply to the credit line.

marriage_status'MARRIED' | 'UNMARRIED' | 'DIVORCED' | 'UNKNOWN' nullable

The customer's marital status.

identification_idstring nullable

The unique ID of a customer's identification resource.

idstring required

The unique ID of a consumer credit line application.

employment_status'EMPLOYED' | 'UNEMPLOYED' | 'PUBLIC_SECTOR_EMPLOYEE' | 'PROFESSIONAL_SOLDIER' | 'FREELANCER' | 'HOUSEWORK' | 'APPRENTICE' | 'MANAGEMENT' | 'RETIRED' | 'STUDENT' | 'SELF_EMPLOYED' | 'MILITARY_OR_COMMUNITY_SERVICE' nullable

The customer's employment status.

decision'REJECTED' | 'OFFERED' nullable required

Solaris' decision on the credit line application.

credit_line_idstring nullable

The unique ID of a credit line, generated after a credit line is created.

Example response

{
  "status": "account_snapshot_pending",
  "signing_id": "7c63600ddddec4f2668893af39c1b814csig",
  "recipient_iban": "DE92370601930002130041",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "partner_reference_number": "ABHP244919",
  "offered_limit": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "offered_interest_rate": 2.5,
  "net_disposable_income": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "marriage_status": "UNMARRIED",
  "identification_id": "9e2e85c62230a652325964282c84559fcidt",
  "id": "35eee37033c5436f9cbff6df1f88e097ccla",
  "employment_status": "EMPLOYED",
  "decision": "OFFERED",
  "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln"
}