Consumer Splitpay

This guide explains the integration process of Solaris' Splitpay product for retail customers (Consumers) as a standalone solution, including the mandatory information you must collect from your customers and the necessary endpoints and webhooks you must integrate into your solution.

Introduction

Product specifications

Consumer Splitpay are currently only available for customers in Germany with a German bank account. Check the overview page for more details on the product specifications.

User journey

Your customers can apply for splitpay by completing the following steps:

  • Enter their desired amount which they want to turn into an installment loan on your frontend to receive an anonymous offer.
  • Apply for a credit line officially and provide the mandatory information.
  • Consent to Solaris' terms and conditions and the credit scoring process, which will be done in relation to their credit line application.
  • If their application is approved, they'll receive the binding credit line offer (SECCI form) and contract, which they must review before the identification process.
  • Complete the identification process and sign the credit line contract.
  • The credit line limit will be available for the customer to use in the form of single installment loans. For each amount the customer uses, an installment loan will be created and serviced separately, and the remaining credit line limit will be recalculated accordingly.

Credit scoring

Solaris uses an automated credit scoring system (Splitpay scorer) to make informed credit decisions on consumer credit line applications. The scorer collects and analyzes different information, such as the customer's self-declared financial information, credit data, transaction history, and outstanding loans to assess their creditworthiness and determine their risk level and credit eligibility.

Based on different credit checks done throughout the application lifecycle, the scorer estimates the probability of default (PD) and then determines whether to offer a credit line and the limit to be granted.

How does the scorer interact with the consumer credit line service?

The consumer credit line service and its related endpoints handle consumer credit line requests and collect the required information about the applicants, such as self-declared financial information, credit records, and account snapshots. Throughout the lifecycle of a consumer credit line application, the scorer provides different responses based on the information provided during each stage of the application.

The scorer performs different credit checks throughout the application lifecycle, such as:

  • Initial scoring: In this stage, the scorer evaluates the self-declared information the applicant provided in the credit line application and the credit record obtained from external credit bureaus, such as SCHUFA. Based on this information, the scorer gives decision either to offer a credit line right away or to require a verification step through an account snapshot.
  • Verification: The scorer uses the account snapshot to verify the financial information provided in the credit line application. This is the final check, after which the scorer provides the final decision.

System prerequisites

Before integrating Solaris' Consumer Splitpay, you must implement the following requirements:

1. Technical setup:

Set up your environment and get your authentication keys. For step-by-step instructions, check the Technical setup guide.

2. Legal and compliance screens:

Build the necessary legal and compliance screens in your sign-up flow to collect your customers' consent to the necessary legal and compliance requirements.

Create the following screens and record your customers' consent on each screen as a UTC timestamp (e.g., 2019-01-01T00:00:00Z). Afterward, you must pass each timestamp in its respective field to Solaris.

  • Collect the customer's consent to Solaris's Terms and Conditions and store the timestamp in the terms_conditions_signed_at field.
  • Collect the customer's consent to data processing and store the timestamp in the data_terms_signed_at field.
  • Collect the customer's economic interest declaration and store the timestamp in the own_economic_interest_signed_at field.

For step-by-step instructions, check the Legal and compliance screens guide.

note

The mentioned fields are part of the person resource, in which you will store all customer data points.


Webhooks

Solaris recommends subscribing to the following webhook events to better automate your processes:

  • IDENTIFICATION: The status of a person identification has changed.
  • PERSON_CHANGED: One or more attributes of the person object changed. Contains only person_id and no payload.
  • PERSON_DELETED: Solaris deletes all personal data related to the given person from its system according to GDPR regulations. You are legally required to delete all personal information related to the customer specified in the payload as soon as you receive this webhook notification.
  • PERSON_MOBILE_NUMBER_CREATED: A mobile number was created for a customer, but has not yet been verified.
  • ACCOUNT_SNAPSHOT: The status of a customer's account snapshot has changed.
  • PERSON_CREDIT_RECORD: The status of a customer's credit record has changed.
  • CREDIT_LINE_APPLICATION: The status of a consumer credit line application has changed.
  • CREDIT_LINE: The status of a consumer credit line has changed.
  • LOAN: The status of a loan has changed.
  • REPAYMENT_PLAN: Sends updates about a repayment plan related to a loan.

For detailed instructions on implementing Solaris webhooks, check the webhooks documentation.


Integration flow

Integration steps

Important
  • This guide includes the integration process for Consumer Splitpay as a standalone solution, i.e., the credit limit will be added to an external account.
  • For existing customers who already have a current account with Solaris and wish to apply for a credit line, skip Step 1.

Integrate Solaris' Consumer Splitpay by completing the following steps:

User registration and credit line application creation

  1. Customers interested in a credit line request an anonymous installment plan for a given amount on your frontend.
  2. Calculate an anonymous installment plan for the customer by completing Step 0. Afterward, the customer apply for a credit line and provide the necessary information.
  3. Collect the mandatory customer data and consent to the legal and regulatory requirements in your sign-up flow, and create a person resource for your customer by completing Step 1.
  4. Create a credit record for the customer by completing Step 2.
  5. Create a consumer credit line application by completing Step 3.
  6. If required, create an account snapshot by completing Step 4.

Customer identification and credit line creation

If Solaris rejects the application, notify the customer of the rejection on your frontend.

note

Please note that the application could be rejected for different reasons and during various application stages. For example, the application could be rejected in the initial scoring or the verification stage.

If Solaris approves the application:

  1. Notify the customer of the approval on your frontend.
  2. Complete the steps related to contracting signing, such as sending the SECCI form and the final contract in Step 5.
  3. Complete the customer identification and e-signing process in Step 6.
  4. Redirect the customer to complete the identification process.
  5. After successful customer identification and e-signing, Solaris creates the credit line and activates it for the customer.

Credit line usage and servicing

  1. Whenever a customer uses an amount from the credit line limit, an installment loan for this amount will be created and serviced separately, and the remaining amount of the credit line limit will be recalculated. You can find all related endpoints to usage and servicing in Step 7.

You can find detailed descriptions of these steps and their related endpoints in the following sections.


Step 0: Generate an anonymous installment plan

In this step, you should enable your customers to request an anonymous installment plan before applying for a credit line by integrating the following endpoint in your sign-up flow. Your customers enter the desired amount they want to convert into installments and they receive an initial installment plan, including the monthly installment amount, loan duration, and applicable interest rates.

POST Create an anonymous credit line installment plan

This endpoint generates an anonymous credit line installment plan for a specific amount, allowing potential customers to receive an initial offer before applying for a credit line. You must add the following properties in the request body:

  • amount: The total amount the customer wants to turn into an installment loan.
  • loan_type: A field to indicate the loan type. Possible values are bullet or installment_plan.
  • interest_rate: (Optional) Only if a specific interest rate should apply to the credit line as Solaris offers fixed interest rates for each partner depending on contractual and commercial agreements with Solaris.

Request example

Copy
Copied
POST /v1/anonymous_credit_line_installment_plans
{
  "loan_type": "installment_plan",
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 100000
  },
  "interest_rate": 0.11 
}

Response example

The API call returns different possible installment plans for the given amount for different loan terms.

Copy
Copied
OK 200
{
    "installment_plans": [
        {
            "total": {
                "value": 102589,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 3,
            "monthly_installment": {
                "value": 34196,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 103054,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 4,
            "monthly_installment": {
                "value": 25763,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        }
    ]
}

Click here to view the full API reference

After the customer decides to apply for a credit line, you must then collect the mandatory information from the customer on your frontend. Such information includes:

  • The mandatory personal information required to create a person resource in Step 1.
  • All the UTC timestamps of the customer's consent to the legal and regulatory requirements in System prerequisites.
  • The mandatory additional information required to create a credit line application resource in Step 3.

Step 1: Collect customer data and create person resource

The customer must provide the mandatory data points in your sign-up flow, including all the timestamps of the customer's consent to the legal and compliance screens. Afterward, you pass all the data points to Solaris by creating a person resource to represent your customer.

What is a person resource?

The person resource represents the customer's personal and financial data at Solaris. It contains all mandatory customer data, as well as links to other resources created for the customer (e.g., accounts, tax identifications).

API reference

Visit the following link to find all the endpoints related to the person resource, including related properties and examples.

Related webhook events

Important points about the person resource
  • The mandatory data points for this endpoint depend on various factors, such as the product, customer type (e.g., retail customers, freelancers, legal representatives, or beneficial owners), and country.
  • You must submit the information exactly as it appears in official documents.
  • Solaris validates the values entered for the fields first_name and last_name. Please ensure your solution applies the following sanitization rules to these fields:

    • It must not be longer than 50 characters.
    • It must not start with a whitespace.
    • It must not include any symbols or emojis.
  • When testing this process on Sandbox, please ensure that you create as many unique person resources as possible (i.e., unique values for first_name, last_name, birth_city, and birth_date). If you create more than 1000 identical person resources, then the API will return a 400 error.

Note about branching

Solaris may restrict the residency countries that are allowed for customers onboarding to a specific branch. If you attempt to create a customer with a residency country that is not allowed for the given branch, the API will return a 400 error and provide a list of allowed residency countries.

Example:

Copy
Copied
{
    "errors": [
        {
            "id": "24b0e02a-341d-40bc-9e52-0d9f8cc8c6eb",
            "status": 400,
            "code": "invalid_model",
            "title": "Invalid Model",
            "detail": "country Residency Country is not allowed for this branch,allowed residency country values for branch \"null\" are [\"DE\", \"FR\"]",
            "source": {
                "field": "country",
                "message": "Residency Country is not allowed for this branch,allowed residency country values for branch \"null\" are [\"DE\", \"FR\"]"
            }
        }
    ]
} 

Please contact your Partner Manager for information about which residency countries are allowed for your branch(es).

Address validation

Your solution must implement address validation to ensure that your system rejects non-existent or wrong address entries before the customer goes through the identification flow. In addition, please note the following best practices:

  • Select a reliable provider to ensure the accuracy and actuality of data.
  • Address validation must happen in real-time when the customer enters their address during the onboarding flow.
  • The system can make auto-complete suggestions to the customer when entering the address. Additionally, it must reject non-existent or wrong entries.
  • If the address validation fails, the customer can enter a nearby address and proceed with the identification flow. However, the customer must submit a proof of address afterward to customer support, such as a rental contract, electricity bill, or certificate of residence in Germany (i.e., Meldebescheinigung).

POST Create person

Call the following endpoint to create a person resource for your customer. Collect the following mandatory data points from the customer in your sign-up flow and add them to the request body:

note

The following data points are required for retail customers in Germany.

  • salutation (Check the appendix for possible enums)
  • first_name (including all middle names as printed on the ID document)
  • last_name (including all name parts as printed on the ID document)
  • birth_date
  • birth_city
  • birth_country (ISO 3166-1 alpha-2 codes
  • nationality (ISO 3166-1 alpha-2 codes
  • address (Street, Number, City, Postal Code, Country, State).
  • contact_address (OPTIONAL To be used only if the customer's current address is younger than two years.)
  • mobile_number The mobile number will be verified during the identification process.
  • iban (Only if the customer will be identified using the Bankident KYC method)
  • employment_status (Check the appendix for possible enums)
  • data_terms_signed_at (UTC timestamp)
  • terms_conditions_signed_at (UTC timestamp)
  • own_economic_interest_signed_at (UTC timestamp)
  • tax_information

    • tax_assessment (Indicates whether the customer files their taxes jointly or separately. Possible values are: NONE JOINT, or SEPARATE)
    • marital_status (Check the appendix for possible enums)
attention

Please note that Solaris validates the values entered for the fields first_name and last_name. Please ensure your solution applies the following sanitization rules to these fields:

  • It must not be longer than 50 characters.
  • It must not start with a whitespace.
  • It must not include any symbols or emojis.

Request URL

Copy
Copied
POST /v1/persons

Response example

The API returns a person object with a unique id, the person_id. You will need this id to append the person resource with additional information in the remaining steps of this guide.

Copy
Copied
{
  "id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "salutation": "MR",
  "first_name": "Peter",
  "last_name": "Mustermann",
  "address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "contact_address": {
    "line_1": "Musterstrasse",
    "line_2": "Musterstrasse",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "mobile_number": "49301234567",
  "birth_date": "1972-12-24",
  "birth_city": "Berlin",
  "birth_country": "DE",
  "nationality": "DE",
  "employment_status": "EMPLOYED",
  "tax_information": {
    "tax_assessment": "SEPARATE",
    "marital_status": "MARRIED"
  },
  "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
  "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
  "flagged_by_compliance": false,
  "screening_progress": "SCREENED_ACCEPTED",
  "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
  "aml_follow_up_date": "2017-01-15",
  "aml_confirmed_on": "2017-01-30",
  "risk_classification_status": "NORMAL_RISK",
  "customer_vetting_status": "NO_MATCH",
}

Click here to view the full API reference


Step 2: Create customer credit record

In this step, you must create a consumer credit record and link it to the person resource of the relevant customer.

What is a credit record?

The credit record contains the customer's credit data and history. Creating a credit record is usually required in lending products integrations as it's used for credit scoring to determine the customer's creditworthiness and eligibility.

Important
  • The credit record is only valid for onboardings in Germany since the information is retrieved from SCHUFA, which is a German credit bureau.
  • For lending onboardings in other countries, such as France, Italy, and Spain, creating a tax identification for the customer substitutes a credit record.

Integrate the following endpoints to create credit records for your retail customers.

API reference

Visit the following link to find all the endpoints related to the credit record resource, including related properties and examples.

POST Create a credit record for a retail customer

This endpoint creates a credit record for the customer with the person_id specified in the request URL. You can collect this information manually through SCHUFA or other third-party service providers or via Solaris. You must add the following attributes in the request body:

  • source: The source of the file. Possible values are partner or solarisBank.
  • file: The file of the credit record Base64-encoded. Only required If source is set to partner.

Request URL

Copy
Copied
POST /v1/persons/{person_id}/credit_records
{
  "source": "solarisBank",
  "file": null
}

Response example

The API call returns an object with a unique ID, which is the credit_record_id and the status of the credit record, set initially to available.

Copy
Copied
  { 
  "status": "available",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2020-20-03T18:01:48.000Z"
  }

GET Retrieve a customer's credit record

This endpoint returns the information about a customer's existing credit record, including the status and validity of the credit record. Add the person_id and the credit_record_id in the request URL. If the status of the credit record is expired, you must create a new one for the customer.

Additionally, subscribe to the webhook event PERSON_CREDIT_RECORD to receive notifications when the status of a credit record changes.

Request URL

Copy
Copied
GET /v1/persons/{person_id}/credit_records/{credit_record_id}

Response example

Copy
Copied
  {
  "status": "available",
  "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd",
  "created_at": "2020-20-03T18:01:48.000Z"
  }

Step 3: Create consumer credit line application

After collecting the mandatory personal information from the customer and creating a person resource, you must collect additional information from the customer related to the credit line application, and pass them to Solaris using the following endpoint.

POST Create consumer credit line application

This endpoint 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.

Mandatory properties:

Add the following mandatory properties in the request body:

  • credit_record_id: The unique ID of the customer's credit record, created in the previous step.
  • employment_since: The date when the customer began their current employment.
  • living_situation: The customer's living situation, whether living in a rented or owned flat. Possible values are LIVING_WITH_PARENTS, LIVING_IN_RENTED_HOUSE or LIVING_IN_OWN_HOUSE.
  • living_situation_amount: The amount of the customer's living expenses, e.g., rent, mortgage, utilities, etc.
  • marriage_status: The customer's marital status. Possible values are MARRIED, UNMARRIED,DIVORCED or UNKNOWN.
  • moved_in_last_two_years: Field to indicate whether the customer has moved and changed addresses in the last two years.
  • net_income_amount: The customer's monthly net income.
  • number_of_dependents: The number of persons depending on the customer's income, e.g., family members.
  • private_insurance_amount: The amount of the private insurance the customer pays monthly.
  • partner_reference_number: Field to enter your internal reference number for the customer.
  • recipient_iban: The IBAN of the customer's account to use for the account snapshot.
  • repayment_day_of_month: The day of the month when the customer repays the monthly installment. Possible values are 1 or 15.

Request example

Copy
Copied
POST /v1/persons/{person_id}/credit_line_applications
{
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd", 
  "employment_since": "2020-03-30",
  "living_situation": "LIVING_WITH_PARENTS", 
  "living_situation_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "marriage_status": "MARRIED", 
  "moved_in_last_two_years": true,
  "net_income_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "number_of_dependents": 0, 
  "partner_reference_number": "string", 
  "private_insurance_amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "recipient_iban": "DE92370601930002130041", 
  "repayment_day_of_month": 1 
}

Response example

The API call returns an object with a unique ID, the application_id for the consumer credit line application, including the application status, set initially to initial_scoring_pending and the remaining attributes, which will be populated during the application lifecycle.

Additionally, the API call triggers the credit scoring system, which initiates the initial scoring based on the self-declared information passed in the payload and the credit record, and rejects applications that don't meet the minimum credit eligibility criteria.

Rejected application payload

Copy
Copied
201 Created
{
    "status_description": null,
    "status": "rejected",
    "recipient_iban": "DE13110101014386274299",
    "reason": "rejected by scorer",
    "person_id": "bb909167b48218dca2d7241c6c92bbf3cper",
    "offered_limit": null,
    "offered_interest_rate": 0.01,
    "net_disposable_income": null,
    "mandate_reference_number": null,
    "identification_id": null,
    "id": "ae316977bbb948ab8a2774f16101ead4fcla",
    "decision": "REJECTED",
    "credit_line_id": null
}

Accepted application payload

If the application passes the initial scoring, the application status goes directly to offered if no account snapshot or identification is needed.

Copy
Copied
201 Created
{
    "status_description": null,
    "status": "offered",
    "signing_id": null,
    "recipient_iban": "DE92370601930002130041",
    "reason": null,
    "person_id": "cb513418bb310a3793f3f93103f64175cper",
    "offered_limit": {
        "value": 470000,
        "unit": "cents",
        "currency": "EUR"
    },
    "offered_interest_rate": 0.11,
    "net_disposable_income": {
        "value": 43726,
        "unit": "cents",
        "currency": "EUR"
    },
    "marriage_status": "MARRIED",
    "identification_id": null,
    "id": "878447efcc524cecae48d31496501df8ccla",
    "employment_status": "EMPLOYED",
    "decision": "OFFERED",
    "credit_line_id": null
}

Click here to view the full API reference

GET Retrieve consumer credit line application

This endpoint returns the current status and details of an existing consumer credit line application. For a list of possible values of the application status and their descriptions, check the appendix.

Additionally, subscribe to the webhook event CREDIT_LINE_APPLICATION to receive status updates on the application.

Request URL

Copy
Copied
GET /v1/persons/{person_id}/credit_line_applications/{credit_line_application_id}

Click here to view the full API reference


Step 4: Create account snapshot and link it to the application

After the application passes the initial scoring, the application status could change directly to offered, which means the verification step is not required.

If the application status changes to account_snapshot_pending, then the final verification step is required to complete the credit scoring process. In this case, you must create an account snapshot for the customer and link it to their credit line application by using the endpoints in this step.

What is an account snapshot?

The account snapshot contains a breakdown of the customer's account information, such as balance, transactions, bookings, and recurrent repayment amounts over a certain period of time. Creating an account snapshot is usually required in lending products integrations as it's used for credit scoring to verify the customer's financial data.

Integrate the following endpoints to create account snapshots for your customers.

API reference

Visit the following link to find all the endpoints related to the account snapshot resource, including related properties and examples.

POST Create an account snapshot for a customer

This endpoint creates an account snapshot for the customer with the person_id specified in the request URL. You can create an account snapshot in different ways by specifying the source of the account snapshot.

1. Account snapshot via FinTech systems

You can create an account snapshot via FIN_TECH_SYSTEMS by completing the following steps:

  1. Integrate the FIN_TECH_SYSTEMS wizard container in your solution by following their documentation.
  2. Call the following endpoint and add the following properties in the request body:

    • source: FIN_TECH_SYSTEMS
    • iban: (Optional) you can add the IBAN of the customer's account.
  3. The API call will return a wizard_session_key, which you must enter in the FIN_TECH_SYSTEMS wizard container to start the account snapshot session.
  4. The customer enters their bank credentials to initiate the account snapshot.

Request example

Copy
Copied
POST /v1/persons/{person_id}/account_snapshots
{
    "source": "FIN_TECH_SYSTEMS"
}

Response example

The API call returns a resource with a unique ID, the account_snapshot_id, as well as the wizard_session_key.

Copy
Copied
{
    "wizard_session_key": "Hm7jUSC7XU2nQjPqJO8dl39eDkdjtOdCtywcmv3x",
    "location": null,
    "id": "8df2a8ba713c43dc9cb481b9cceed487snap",
    "account_id": null
}

2. Account snapshot via Finreach

You can create an account snapshot via FinX by completing the following steps:

  1. Integrate the FinX widget in your solution by following their documentation.
  2. Call the following endpoint and add the following properties in the request body:

    • source: FINREACH
  3. The API call will return a location, which is a URL to which you must redirect your customer to enter their bank credentials to initiate the account snapshot.

Request example

Copy
Copied
POST /v1/persons/{person_id}/account_snapshots
{
  "source": "FINREACH"
}

Response example

The API call returns a resource with a unique ID, the account_snapshot_id, as well as URL to which you must redirect the customer.

Copy
Copied
{
    "wizard_session_key": null,
    "location": "https://ui.solaris-i.prod.finleap.cloud?token=xxxxxx",
    "id": "8df2a8ba713c43dc9cb481b9cceed487snap",
    "account_id": null
}

3. Account snapshot via partner

If you want to upload the details of an account snapshot you've created (e.g., if you already have your own connection with FIN_TECH_SYSTEMS or FINREACH), specify the source of the account snapshot file as partner and add the account snapshot data in the snapshot_data field.

Request example

Copy
Copied
POST /v1/persons/{person_id}/account_snapshots
{
    "source": "PARTNER",
    "snapshot_data": {
    "account": {
        "bank_name": "",
        "bic": "",
        "country_id": "",
        "description": "",
        "holder": "John Smith",
        "iban": "DE92370601930002130041",
        "joint_account": false
    },
    "balance": {
        "balance": 3720.20,
        "currency": "EUR",
        "date": "2022-02-03",
        "limit": 0
    },
    "date": "2022-02-03",
    "days": 90,
    "turnovers": [
        {
            "amount": 4000.05,
            "booking_date": "2022-02-01",
            "counter_bic": "",
            "counter_holder": "Salary company",
            "counter_iban": "DE89500105177323343587",
            "currency": "EUR",
            "purpose": [
                "LOHN / GEHALT 01/22"
            ],
            "tags": [],
            "CrifCategory": "RE_05"
        },
        {
            "amount": 4000.05,
            "booking_date": "2022-01-02",
            "counter_bic": "",
            "counter_holder": "Salary company",
            "counter_iban": "DE89500105177323343587",
            "currency": "EUR",
            "purpose": [
                "LOHN / GEHALT 12/21"
            ],
            "tags": [],
            "CrifCategory": "RE_05"
        },
        {
            "amount": 4000.05,
            "booking_date": "2021-12-01",
            "counter_bic": "",
            "counter_holder": "Salary company",
            "counter_iban": "DE89500105177323343587",
            "currency": "EUR",
            "purpose": [
                "LOHN / GEHALT 11/21"
            ],
            "tags": [],
            "CrifCategory": "RE_05"
        },
              {
            "amount": 4000.05,
            "booking_date": "2021-11-05",
            "counter_bic": "",
            "counter_holder": "Salary company",
            "counter_iban": "DE89500105177323343587",
            "currency": "EUR",
            "purpose": [
                "LOHN / GEHALT 10/21"
            ],
            "tags": [],
            "CrifCategory": "RE_05"
        }
    ]
}
}

Response example

The API call returns a resource with a unique ID, the account_snapshot_id.

Copy
Copied
{
  "wizard_session_key": null,
  "location": null,
  "id": "0a3f28733f9a4842842aae2804f80eb4snap",
  "account_id": null
}

4. Account snapshot via Solaris

You can create an account snapshot via Solaris for internal accounts by specifying the source as SOLARISBANK and adding the customer's account_id in the request body.

Request example

Copy
Copied
{
  "source": "SOLARISBANK",
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc"
}

Response example

The API call returns a resource with a unique ID, the account_snapshot_id.

Copy
Copied
POST /v1/persons/{person_id}/account_snapshots
{
  "wizard_session_key": null,
  "location": null,
  "id": "0a3f28733f9a4842842aae2804f80eb4snap",
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc"
}

GET Retrieve a customer's account snapshot

This endpoint returns the information about a customer's existing account snapshot, including the status and validity of the account snapshot. Add the person_id and the account_snapshot_id in the request URL. If the status of the account snapshot is expired, you must create a new one for the customer.

Additionally, subscribe to the webhook event ACCOUNT_SNAPSHOT to receive notifications when the status of an account snapshot changes.

Request URL

Copy
Copied
GET /v1/persons/{person_id}/account_snapshots/{account_snapshot_id}

PUT Link account snapshot to consumer credit line application

After creating an account snapshot, use this endpoint to link the customer's account snapshot to their existing credit line application. You must add the account_snapshot_id in the request body.

The credit scorer uses the account snapshot for the final verification check to verify the financial information shared about the customer. After the final verification is completed, the credit scorer gives the final decision on the credit line application.

Request example

Copy
Copied
PUT /v1/persons/{person_id}/credit_line_applications/{application_id}/account_snapshot
{
	"account_snapshot_id": "6c8f81a234df4052a9cde197577347b7snap"
}

Click here to view the full API reference

After linking the account snapshot to the application, the application status changes to account_snapshot_verification_pending, triggering the final verification step in the credit scoring process. After successful snapshot verification, the application status should change to offered and you can proceed with the remaining steps.

note

Please note that the application could be rejected at this stage if it did not pass the final verification check.


Step 5: Send SECCI form and credit line contract

Before prompting the customer to sign the final contract of the credit line, you must send the customer the Standard European Consumer Credit Information (SECCI) form. The SECCI form is a standardized credit form that includes the information related to a credit offer, such as creditor details, type of credit, amount, duration, interest rates, credit costs, etc.

In compliance with regulatory requirements, you must first send the customer the SECCI form to review and approve. Afterward, you can send them the final contract which they have to sign during the identification and e-signing process.

Implement the following endpoints to generate the SECCI form and final contract of a credit line.

GET Retrieve the SECCI form of a credit line

Call this endpoint to generate the SECCI form of the credit line as a PDF. You must share this form to the customer before sending the final contract either via email or direct download through your app.

Request URL

Copy
Copied
GET /v1/persons/{person_id}/credit_line_applications/{application_id}/pre_contract

Click here to view the full API reference

GET Retrieve final contract

After the customer reviews and approves the credit line's SECCI form, call this endpoint to generate the final contract, which the customer must sign electronically during the identification process.

note

It's recommended to share the final contract with the customer via email or direct download prior to the identification process.

Request URL

Copy
Copied
GET /v1/persons/{person_id}/credit_line_applications/{application_id}/contract

Click here to view the full API reference

attention

The customer must also sign an SDD mandate, which authorizes Solaris to debit the customer's account for the monthly installments. For more information about SDD mandates, check the SEPA DIRECT DEBIT GUIDE.


Step 6: Complete the customer identification and e-signing process

In the step, you must prompt the customer to complete the identification process, in which the customer will be identified in a video identification session through our provider IDnow. During this session, an identification agent will verify the customer's data against their identification documents, verify their mobile number, and collect the customer's qualified electronic signature (QES) on the credit line contract, SDD mandate, and terms and conditions.

Call the following endpoints to initiate the process for your customer.

GET Retrieve the signing ID

When the application status changes to esign_pending, it means that the identification and e-signing process has been triggered for the customer. You must call the GET Retrieve consumer credit line application method to get the signing_id, which you'll need to retrieve the identification details.

Request URL

Copy
Copied
GET /v1/persons/{person_id/credit_line_applications/{application_id}/

Response example

Copy
Copied
OK 200
{
    "status_description": null,
    "status": "esign_pending",
    "signing_id": "24b42dc457e0cb66f579aa64156e8bbdcsig",
    "recipient_iban": "DE92370601930002130041",
    "reason": null,
    "person_id": "53649aee455d8173ba67e0dc7ec12e0bcper",
    "offered_limit": {
        "value": 470000,
        "unit": "cents",
        "currency": "EUR"
    },
    "offered_interest_rate": 0.11,
    "net_disposable_income": {
        "value": 43726,
        "unit": "cents",
        "currency": "EUR"
    },
    "marriage_status": "MARRIED",
    "identification_id": null,
    "id": "35eee37033c5436f9cbff6df1f88e097ccla",
    "employment_status": "EMPLOYED",
    "decision": "OFFERED",
    "credit_line_id": null
}

GET Retrieve e-signing and identification details

Once you obtain the signing_id from the previous endpoint, call the following method to get the video identification details, such as IDnow reference and URL.

Request URL

Copy
Copied
GET /v1/persons/{person_id}/signings/{signing_id}

Response example

The API call returns the identification details, such as the IDnow reference and url, to which you must redirect your customer to complete the identification process and the documents your customer must e-sign. The payload also includes the IDnow status.

note
  • For a list of possible values of the status of IDnow process and their descriptions, check the appendix.
  • Additionally, subscribe to the IDENTIFICATION webhook event to get IDnow status updates.
Copy
Copied
{
    "id": "24b42dc457e0cb66f579aa64156e8bbdcsig",
    "reference": "TST-BJDHG",
    "url": "https://go.test.idnow.de/solarisbankesignsandbox/identifications/9e2e85c62230a652325964282c84559fcidt/webcam",
    "state": "pending",
    "status": "pending",
    "completed_at": null,
    "method": "idnow",
    "identification_id": "9e2e85c62230a652325964282c84559fcidt",
    "documents": []
}

GET List the IDnow attempts of a person identification

This endpoint returns a list of IDnow attempts within a person identification. Each returned attempt includes the result, the reason (if the attempt was aborted), and the payload from the webhook related to that attempt.

Request URL

Copy
Copied
GET v1/persons/{person_id}/identifications/{id}/idnow_attempts

Click here to view the full API reference.

GET Download a document

This endpoint downloads the file of the document with the id specified in the request URL. Call this endpoint to download the relevant signed documents to share them with the customer.

Request URL

Copy
Copied
GET /v1/persons/{person_id}/documents/{id}/file

Click here to view the full API reference

GET Retrieve the details of a successful identification

This endpoint returns a completed person identification (i.e., the person identification process was successful). If you use the include_documents filter, this method will also return the documents submitted by the customer during the identification process.

Request URL

Copy
Copied
GET /v1/persons/{person_id}/identifications/{id}

Response example

Copy
Copied
// 200 OK
{
  "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
  "reference": "TST-ELCCJ",
  "url": "https://go.test.idnow.de/",
  "status": "successful",
  "completed_at": "2021-09-14T18:18:28.000Z",
  "method": "idnow",
  "proof_of_address_type": "GAS_BILL",
  "proof_of_address_issued_at": "2021-12-03",
  "language": "EN",
  "person_id": "992de312a545bb24a88ddbf57ae8b1ffcper",
  "address": {
    "line_1": "BERLINER STR. 45",
    "line_2": "Erste Etage",
    "postal_code": "14169",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "documents": [
    {
      "id": "448b75fa1c57eecda41d91c66c22faa6cdoc",
      "name": "file1.pdf",
      "content_type": "application/json",
      "document_type": "KYC_REPORT",
      "size": 803580
    },
    {
      "id": "94eb22a9311be9a1fbb698c448b0b337cdoc",
      "name": "file2.jpg",
      "content_type": "image/jpeg",
      "document_type": "SIGNATURE",
      "size": 25349
    }
  ],
  "failure_reason": "string",
  "iban": "DE11010101010101010100",
  "authorization_expires_at": "string",
  "confirmation_expires_at": "string",
  "provider_status_code": 1000
}

Click here to view the full API reference.

After the customer completes the identification, the credit line application status changes to esign_complete.

Please note that in case of a failed identification, the credit line application will also be rejected. :::

GET Retrieve the credit line ID

Once the customer completes the video identification and QES processes, Solaris creates the credit line. You can track the credit line creation process by calling the GET consumer credit line application method.

Request URL

Copy
Copied
GET /v1/persons/{person_id}/credit_line_applications/{credit_line_application_id}

Response example

Once the credit line has been created, the application status changes to credit_line_created, and the credit_line_id will be included in the payload and the full credit line details such as the amount and interest rates.

Copy
Copied
200 OK
{
    "status_description": null,
    "status": "credit_line_created",
    "signing_id": "24b42dc457e0cb66f579aa64156e8bbdcsig",
    "recipient_iban": "DE92370601930002130041",
    "reason": null,
    "person_id": "53649aee455d8173ba67e0dc7ec12e0bcper",
    "offered_limit": {
        "value": 470000,
        "unit": "cents",
        "currency": "EUR"
    },
    "offered_interest_rate": 0.11,
    "net_disposable_income": {
        "value": 43726,
        "unit": "cents",
        "currency": "EUR"
    },
    "marriage_status": "MARRIED",
    "identification_id": null,
    "id": "35eee37033c5436f9cbff6df1f88e097ccla",
    "employment_status": "EMPLOYED",
    "decision": "OFFERED",
    "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln"
}

Step 7: Credit line usage and servicing

This step includes all the relevant endpoints you need to integrate into your solution to use and service credit lines.

Credit line usage

After a customer is granted a credit line, they can use the limit in the form of single installment loans.

For example, if Solrisbank offers a customer a 5,000 EURO credit line limit, they can choose to use 3,000 EURO to pay back the principal and interests in monthly installments over the course of 24 months. An installment loan for this amount and term will be created and serviced separately, leaving the customer with a remaining credit line limit of 2,000, which they can use in

note

A credit line must be created.

POST Generate available installment plans

This endpoint generates possible installment plans for a given amount. Once a customer is granted a credit line, they can convert previous transactions into installments.

You must generate possible installment plans and terms for the given amount and share them with the customer.

Request example:

Copy
Copied
POST /v1/persons/{person_id}/credit_lines/{credit_line_id}/available_installment_plans
{
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "interest_rate": 0.11 //optional, only if a specific interest rate should be calculated otherwise normal interest rate applies
}

Response example:

The API call returns an array of possible installment plans for the given amount, including the term, monthly installment amount, and applicable interest rate.

Copy
Copied
{
    "installment_plans": [
        {
            "total": {
                "value": 314718,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 8,
            "monthly_installment": {
                "value": 39340,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 316135,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 9,
            "monthly_installment": {
                "value": 35126,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 317566,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 10,
            "monthly_installment": {
                "value": 31757,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 318992,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 11,
            "monthly_installment": {
                "value": 28999,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 320423,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 12,
            "monthly_installment": {
                "value": 26702,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 321872,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 13,
            "monthly_installment": {
                "value": 24759,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 323315,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 14,
            "monthly_installment": {
                "value": 23094,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 324758,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 15,
            "monthly_installment": {
                "value": 21650,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 326216,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 16,
            "monthly_installment": {
                "value": 20389,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 327670,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 17,
            "monthly_installment": {
                "value": 19275,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 329122,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 18,
            "monthly_installment": {
                "value": 18285,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 330590,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 19,
            "monthly_installment": {
                "value": 17399,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 332052,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 20,
            "monthly_installment": {
                "value": 16603,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 333520,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 21,
            "monthly_installment": {
                "value": 15882,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 335001,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 22,
            "monthly_installment": {
                "value": 15227,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 336477,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 23,
            "monthly_installment": {
                "value": 14629,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        },
        {
            "total": {
                "value": 337960,
                "unit": "cents",
                "currency": "EUR"
            },
            "term": 24,
            "monthly_installment": {
                "value": 14082,
                "unit": "cents",
                "currency": "EUR"
            },
            "interest_rate": 0.11,
            "effective_interest_rate": 0.1157
        }
    ]
}

Click here to view the full API reference

POST Create a credit line loan

This endpoint creates a loan resource based on an installment plan. The loan is used for bank statements and should shortly describe the purpose of the loan. Additionally, you should assign a reference for the loan and indicate whether a loan for a specific transaction was already created.

Field interest_rate is only required if a particular interest rate applies to the loan.

Request example

Copy
Copied
POST /v1/persons/{person_id}/credit_lines/{credit_line_id}/loans
{
  "amount": {
    "currency": "EUR",
    "unit": "cents",
    "value": 1000
  },
  "interest_rate": 0.11, // optional, only if a specific interest rate should be calculated otherwise normal interest rate applies
  "reference": "string", //Your reference number for the loan
  "purpose": "string", //Purpose of the credit line loan 
  "term": 3
}

Response example

The API call returns an object with a unique ID, the loan_id, and the loan status.

For a list of possible values of the credit line loan status and their descriptions, check the appendices section. Additionally, subscribe to the webhook event LOAN to receive status updates about the loan.

Copy
Copied
{
    "status": "payout_pending",
    "id": "f8930e8d3dfa48e4a898d7a97c0d78b4cloa",
  	"interest_rate": 0.1,
}

Click here to view the full API reference

GET Retrieve a credit line

This endpoint returns the details of the credit line, such as the used amount, active loans, available limit, etc.

Request URL

Copy
Copied
GET /v1/persons/{person_id/}credit_lines/{credit_line_id}

Response example

Copy
Copied
{
    "utilized_amount": {
        "value": 1100,
        "unit": "cents",
        "currency": "EUR"
    },
    "status": "open",
    "recipient_iban": "DE85110101010987654321",
    "person_id": "c77044e6a8e35e3a4deaf7c9a4cc2476cper",
    "mandate_reference_number": "L0123456789ABCD",
    "locking_status": "BLOCK",
    "limit": {
        "value": 50000,
        "unit": "cents",
        "currency": "EUR"
    },
    "latest_disposable_income": {
        "value": 9661,
        "unit": "cents",
        "currency": "EUR"
    },
    "interest_rate": 0.12,
    "id": "d968824ecf0c490fa4e1302705bd677dccln",
    "disposable_income": {
        "value": 10000,
        "unit": "cents",
        "currency": "EUR"
    },
    "created_at": "2019-12-11T17:24:10",
    "annual_percentage_rate": 0.12,
    "active_loans": [
        {
            "id": "36078f1c3e034f6cbf8202da23590e64cloa"
        }
    ],
    "account_id": "01880934bd1531530e2d20a210e4006bcacc",
    "account_iban": "DE25110101002910133758"
}

Click here to view the full API reference


Credit line servicing

This section includes the different endpoints you need to integrate in your solution for servicing and maintaining credit lines for your customers.

PATCH Update the payout account tied to a credit line

This endpoint updates the payout account used for a credit line loan payout. The payout account is an internal account.

Request example

Copy
Copied
PATCH /v1/persons/{person_id}/credit_lines/{credit_line_id}/payout_account
{
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc"
}

Click here to view the full API reference

PUT Terminate a credit line

This endpoint terminates a created credit line for a person's account. Terminating a credit line can be initiated from the customer or Solaris.

You must include the person_id and credit_line_id in the request URL and add the following property in the request body:

  • requested_at: The date when the credit line termination becomes effective.

Request example

Copy
Copied
PUT /v1/persons/dc1a6812a14f6cc338cd084208535bcdcper/credit_lines/c5f22b00baa845869ceb3a7d90d59bffccln/terminate
{
  "requested_at": "2021-08-24"
}

Click here to view the full API reference

PUT Revoke a credit line

The customer can revoke an offered credit line within 14 days from the issuance date. The following endpoint revokes a created credit line for a customer.

Request URL

Copy
Copied
PUT /v1/persons/{person_id}/credit_lines/{credit_line_id}/revoke

Click here to view the full API reference


Loan servicing

This section includes the different endpoints you need to integrate in your solution for servicing and maintaining loans for your customers.

API reference

Visit the following link to find all the endpoints related to servicing and maintaining loans, including related properties and examples.

GET Retrieve a loan schedule

This endpoint retrieves the latest repayment schedule of the loan specified in the request URL. The call will return information about two components:

  • Loan balance
  • Loan installments

For detail descriptions about each field, check the API reference.

Request URL

Copy
Copied
GET /v1/loans/{loan_id}/repayment_schedule

Click here to view the full API reference.

GET Retrieve the repayment history of a loan

This endpoint retrieves the repayment history of the loan specified in the request URL. The call will return information about two components:

  • All SEPA Direct Debits (SDD) that were pulled from the customer's reference account tied to the loan.
  • All SEPA Credit Transfers (SCT) for any partial or full early repayments the customer have made (If applicable).

Request URL

Copy
Copied
GET /v1/loans/{loan_id}/repayment_history

Response example

Copy
Copied
{
  "repayment_history": [
    {
      "amount": {
        "currency": "EUR",
        "unit": "cents",
        "value": 1000
      },
      "date": "2020-07-03",
      "interest_amount": {
        "currency": "EUR",
        "unit": "cents",
        "value": 1000
      },
      "payout_amount": {
        "currency": "EUR",
        "unit": "cents",
        "value": 1000
      }
    }
  ]
}

Click here to view the full API reference.


What's next?

Congratulations! You've successfully integrated Solaris' Consumer Splitpay solution.

Check the following appendices section for additional information on enums and testing data.

For an overview of Solaris' lending products, check the lending products overview page.

Mandatory features

Please note that it's mandatory to implement the following additional features in your solution for regulatory requirements.

Useful resources

Check the following links for additional related guides and API reference documentation:


Appendix I: Enums

Consumer credit line application status

These are the possible values for the field status in the consumer credit line application resource.

Enum Description
initial_scoring_pending The application has been received and currently going through the initial scoring process.
account_snapshot_pending The credit line application passed the initial scoring step, and an account snapshot is needed for the final verification step. Therefore, you must create an account snapshot for the applicant and attach it to the application to continue the process.
account_snapshot_verification_pending An account snapshot has been linked to the credit line application. The account snapshot triggers the final verification step, in which the credit scoring system checks the account history to verify the self-declared financial information.
identification_pending The identification resource has been created for the relevant customer. The identification_id should be available in the payload of the GET Retrieve consumer credit line application method at this point.
offered The account snapshot verification has succeeded, and no identification is required.
esign_pending The e-signing process is created and must be completed by the customer. The signing_id should be available in the payload of the GET Retrieve consumer credit line application method at this point.
esign_complete The e-signing process has been completed successfully.
esign_failed The e-signing process has failed.
credit_line_creation_pending The identification and e-signing processes are completed successfully, but the credit line creation process is still in progress.
credit_line_created The credit line has been created and assigned to the person resource of the customer.
expired Either the credit record or the account snapshot is expired. New ones must be created and linked to the credit line application to resume the process.
deleted The credit line application has been deleted.
rejected The credit line application has been rejected. Rejection could be due to failed credit scoring, account snapshot verification, or identification.

Consumer credit line status

These are the possible values for the field status in the consumer credit line resource.

Enum Description
authorization_pending You must authorize the creation of the credit line. This is not a mandatory stage for all use cases but only happens if you have an internal authorization workflow.
account_creation_pending The customer's account creation is still in progress. The account is required for the loan payout.
mandate_creation_pending The mandate creation process is still in progress. First, you must collect the customer's signature on the mandate, which authorizes the collection of the loan installments from the customer's account.
open The account and mandate have been created and linked to the customer's credit line. The credit line is now open and can be utilized by the customer. Please note that the credit line locking status must be NO_BLOCK for the customer to be able to use the credit line.
closed The credit line has been revoked and is no longer active.

Credit line loan status

These are the possible values for the field status in the credit line loan resource.

Enum Description
payout_pending The loan payout is still in progress.
payout_triggered The loan payout has been triggered.
created The loan payout has been created and can be used by the customer.
repaid The customer has paid all the loan obligations.

Document types

The following table includes the possible values for the field document_type and their descriptions.

Enum Description
ANNUAL_FINANCIAL_STATEMENT A business or a company's annual financial statement.
KYC_REPORT The KYC report generate after a successful customer identification.
ID_DOCUMENT An person's identification document, such as passport or ID.
SIGNATURE A signature example.
PICTURE A picture or a scanned document of any other type.
QES_DOCUMENT A document related to a Qualified Electronic Signature (QES).
SIGNED_CONTRACT A signed contract of any kind.
SIGNED_QES_DOCUMENT A document signed by a Qualified Electronic Signature (QES).
REGISTER_CHECK A register check.
REGISTER_EXTRACT A business or a company's commercial register excerpt or a similar document.
FOUNDATION_DOCUMENT The foundation document of a company or business.
SCHUFA_COMPACT_REPORT A compact SCHUFA report.
SCHUFA_GWG_REPORT A GWG SCHUFA report.
SCHUFA_FULL_REPORT A full SCHUFA report about a person.
SCHUFA_SHORT_REPORT A short SCHUFA report about a person.
CREDIT_AGENCY_REPORT A report issued by a credit agency.
SHARE_HOLDERS_AGREEMENT A business or a company's shareholders agreement.
SHAREHOLDERS_LIST A business or a company's shareholders list.
TRADING_LICENSE A business or a company's trading license.
TRANSPARENCY_REGISTER_EXTRACT An extract of a transparency register.
INVOICE An invoice of any kind.
OTHER Any other type of document.
VIDEO A video of any kind.
VAT_CERTIFICATE VAT registration certificate

Idnow status

The following table includes the possible values for the field status for the video identification process carried out by IDnow and the related description of each status.

Status Description
created The identification resource has been created for the customer.
pending The identification process has been triggered and the video identification URL and reference are generated. You must redirect the customer to the URL to complete the identification process with IDnow.
pending_successful The video identification was successful, but will be reviewed by the identification provider. You can already offer banking services to the customer at this stage. Once reviewed by the provider, the identification will be marked either as resolved positively (successful) or negatively (failed or canceled). A bank account will be automatically blocked if the identification is eventually marked as failed or canceled.
pending_failed The identification is currently under review. You cannot offer banking services to the customer at this stage. The identification might eventually turn to successful, but it is unlikely.
successful The video identification was successful. The customer can be onboarded. Please note that the customer's data might have been updated during the identification session.
aborted The customer aborted the identification process. The customer can still video-identify using the same URL.
canceled The provider canceled the video identification. The customer should video-identify again using the same URL.
failed The identification was unsuccessful. You *cannot onboard the customer or offer any banking services to them.

IDnow provides a reason for the canceled and aborted status. No reason can be disclosed for the final failed status.

Identification documents

  1. List of the accepted passports for videoIdent: here
  2. List of accepted passports for postIdent: here
  3. Search for a identification document: here

List of passports with address

The following table shows the list of documents, that has the address included in the identification document, and allows you to perform identification without the proof of address document.

Document Issuer Country Type (ID/PP)
MLT-BO-02001 Malta ID
MLT-BO-03001 Malta ID
SVK-BO-02001 Slovakia ID
SVK-BO-05001 Slovakia ID
SVK-BO-04001 Slovakia ID
ITA-BO-04003 Italy ID
ITA-BO-03004 Italy ID
ITA-BO-03002 Italy ID
ITA-BO-03001 Italy ID
ITA-BO-03003 Italy ID
DEU-BO-01003 Germany ID
DEU-BO-02001 Germany ID
SGP-BO-01001-A Singapore ID
SGP-BO-01001 Singapore ID
CZE-BO-04001 Czech Republic ID
CZE-BO-04002 Czech Republic ID
IND-AO-01001 India Passport
CHN-AO-04003 China Passport
BGR-AO-01005 Bulgaria Passport
SVN-AO-02001-02003 Slovenia Passport
SVN-AO-02004 Slovenia Passport
SVN-BO-02001 Slovenia ID
SVN-AO-01004 Slovenia Passport
POL-BO-02001-02003 Poland ID
ESP-BO-03001 Spain ID
ESP-BO-05001 Spain ID
HRV-BO-02001 Croatia ID
HRV-AO-02001 Croatia Passport
FRA-BO-02002 France ID
FRA-AO-03001-03003 France Passport
MAR-AO-02001 Morocco Passport