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.
Consumer Splitpay is available for customers in Germany and France with a valid bank account. Check the overview page for more details on the product specifications.
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.
Before integrating Solaris' Consumer Splitpay, 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. The Legal and compliance screens guide contains step-by-step instructions on how to create these screens and what they must contain.
The following screens are required to onboard B2C customers for lending standalone products:
Consent timestamps
You must record the customer's consent on each screen as a UTC timestamp (e.g., 2019-01-01T00:00:00Z) and pass it to Solaris in the following fields:
- Solaris Terms and Conditions:
terms_conditions_signed_at - Data Processing Terms:
data_terms_signed_at - Economic Interest Declaration:
own_economic_interest_signed_at
These fields are part of the person resource where all customer data points are stored.
- 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 2.
Integrate Solaris' Consumer Splitpay by completing the following steps:
| Stage | Step | Description |
|---|---|---|
| Customer registration | Step 1 - Optional | Generate an anonymous installment plan for a given amount for the customer. |
| Customer registration | Step 2 | 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. |
| Credit line application | Step 3 | Create a credit record for the customer. |
| Credit line application | Step 4 | Create a credit line application for the customer and include all mandatory data points required for the scorer. |
| Credit line application | Step 5 - Optional | Create an account snapshot for the customer and link it to the credit line application. |
| Customer identification & contract signing | Step 6 | Send the customer the SECCI form and the credit line final contract. |
| Customer identification & contract signing | Step 7 | Trigger the KYC and e-signing flow for the customer, and redirect the customer to complete the identification process with IDnow and sign the relevant contracts. Ensure that the customer is successfully identified and passes the risk screening before proceeding with the following steps. |
| Credit line usage & servicing | Step 8 | 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. Implement all the relevant endpoints in this step. |
You can find detailed descriptions of these steps and their related endpoints in the following sections.
The following sequence diagram gives an overview of the integration flow for the Consumer Splitpay solution:
Solaris recommends subscribing to the following webhook events to better automate your processes. For detailed instructions on implementing Solaris webhooks, check the webhooks documentation.
General Events
Credit Line Specific Events
1. Application Updates CREDIT_LINE_APPLICATION
This webhook is triggered during the credit line application process in the following scenarios:
Status Triggers
credit_line_created: Upon the creation of a credit line.offered: Upon scorer approval.rejected: Upon scorer rejection.account_snapshot_verification_succeeded:identification_pending: Ifused_esigning_provider=BANK.offered: Ifused_esigning_provider=BANK.
rejected: Based onaccount_snapshot_verification_failed.esign_failed: Based onsigning_failed.rejected: Based onesign_completedwithscreening_finished_with_confirmed_match.rejected: Based onsamsung_fix_reject.expired: When an application expires.deleted: On non-customer GDPR deletion.
2. Lifecycle Updates CREDIT_LINE
This webhook is triggered for events occurring after the credit line has been created:
Status Triggers
open: Onmandate_created.accepted: Onscreening_status_changed_to_accepted.closed: On credit linerevoked.
Block Triggers
locking_statusBLOCK onscreening_status_changed_to_potential_match.locking_statusBLOCK onscreening_status_changed_to_declined.locking_statusBLOCK onid_now_canceled.locking_statusBLOCK onlocking_status_changed:true.
Loan Triggers
- Loan Opened: On
credit_line_loan_contract_details_retrieved. - Loan Repaid: On
credit_line_loan_repaid.
Limit Triggers
- Limit Changed: Credit line with
updated_data.
You must integrate all the mandatory features for B2C Splitpay highlighted in the Onboarding requirements guide before going live with your solution.
In this step, you will 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, and applicable interest rates.
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.
Request URL
POST /v1/anonymous_credit_line_installment_plansIf the customer decides to apply for a credit line, you need to collect the mandatory information from the customer on your frontend by completing the following steps in this guide.
In this step, you have to collect the mandatory data points from the customer in your sign-up flow, including all the timestamps of the customer's consent to the legal and compliance screens.
Afterward, pass all the data points to Solaris by creating a person resource to represent your customer.
API reference
For a complete list of endpoints, properties, and examples related to the person resource, visit the following links:
Related webhook events
- Review the special requirements in the Onboarding requirements guide.
- Submit information exactly as it appears in official documents.
- Sandbox Testing: Ensure that each person you create has unique values for
first_name,last_name,birth_city, andbirth_date. If you create over 1000 identical person resources, the API will return a400error. - Privacy: Do not use real personal data when testing in Sandbox.
Create a person resource to represent your customer. You must include the following data points in the request body to satisfy the requirements for German Consumer Loans.
Mandatory fields for retail customers in Germany:
salutationfirst_namelast_nameemailmobile_numberbirth_datebirth_citybirth_countrynationalityemployment_statusaddress:line_1line_2(optional)postal_codecitycountry
tax_information:marital_status
terms_conditions_signed_atdata_terms_signed_atown_economic_interest_signed_at
Request URL
POST /v1/personsThis endpoint updates one or more properties on a person resource. You can only update the following properties using this endpoint:
titlesalutationaddress(line_1,line_2,postal_code,city,state,country)contact_address(line_1,line_2,postal_code,city,state,country)employment_statusjob_titleemailtax_information(tax_assessment,marital_status)fatca_relevantfatca_crs_confirmed_atbusiness_purposeindustryindustry_keyown_economic_interest_signed_ataml_confirmed_on(only with today or tomorrow's date)expected_monthly_revenue_centsvat_numberwebsite_social_mediabusiness_trading_namenace_codebusiness_address_line_1business_address_line_2business_postal_codebusiness_citybusiness_countryannual_income_rangedata_terms_signed_atbranchbirth_provincebirth_post_codesocioprofessional_categorypurpose_of_account_openingmain_income_sourcework_countrywork_provinceself_declared_as_pepinternational_operativity_expectationregistration_number
Restricted Updates:
- Fields not mentioned in this list can only be updated via Customer Support.
Freelancer & Self-Employed Requirements (B2C):
- If a customer changes their
employment_statustoFREELANCERorSELF_EMPLOYED, you must include one of the following in the request to avoid an error:- The customer's
nace_code(Recommended for data quality). - Set
industryandindustry_keytonull.
- The customer's
Request URL
PATCH /v1/persons/{id}Request example
{ "email": "new.email@example.com", "address": { "line_1": "New Street", "line_2": "1", "postal_code": "10119", "city": "Berlin", "country": "DE" } }
In this step, you must create a consumer credit record and link it to the person resource of the relevant customer.
The credit record contains the customer's credit data and history. Creating a credit record is mandatory for Lending integrations, as it is used for credit scoring to determine the customer's creditworthiness and eligibility.
Regional Availability:
- Germany: The credit record is required. Information is retrieved from SCHUFA (German credit bureau).
- France, Italy, Spain: A credit record is not required. Instead, creating a tax identification for the customer substitutes this requirement.
To create a credit record, you must choose a source in the request body:
source: solarisBank(Automated) Solaris retrieves the customer's record directly from SCHUFA. This is the standard recommended process.source: partner(Manual Upload) You collect the credit record manually from SCHUFA or third-party providers and upload it to Solaris.- Requirement: You must Base64-encode the file and pass the content in the
filefield.
- Requirement: You must Base64-encode the file and pass the content in the
Endpoints:
Depending on your customer type, use one of the following endpoints:
Retail Customers
POST /v1/persons/{person_id}/credit_recordsFreelancers
POST /v1/freelancers/persons/{person_id}/credit_recordsCall this endpoint to check the status and validity of an existing credit record.
Request URL
GET /v1/persons/{person_id}/credit_records/{credit_record_id}Expiry Logic: If the status of the retrieved credit record is expired, you must create a new record for the customer before proceeding with a loan 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:
Call this endpoint to create a consumer credit line application for your customer. You must add the following mandatory properties in the request body, which the credit scorer uses to initiate a series of credit checks:
Mandatory properties:
requested_credit_limitcredit_record_idemployment_sinceliving_situationliving_situation_amountexisting_credit_repayment_excluding_mortgagemarriage_statusmoved_in_last_two_yearsnet_income_amountnumber_of_dependentsprivate_insurance_amountrecipient_ibanrepayment_day_of_month
The application status changes to initial_scoring_pending after calling this endpoint.
Request URL
POST /v1/persons/{person_id}/credit_line_applicationsScoring results:
This 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.
Approved application
- If the application passes the initial scoring and no account snapshot or identification is needed, then the application status goes directly to
offered. In this case, proceed to step 6 to generate the relevant contracts for the customer. - Alternatively, the status can go to
account_snapshot_verification_pendingif an account snapshot is required. In this case, complete step 5 to create an account snapshot and link it to the application.
Rejected application
If the application is rejected, the application status changes to rejected, and you must abort the customer onboarding process.
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
GET /v1/persons/{person_id}/credit_line_applications/{credit_line_application_id}The following diagram describes the status flow of a consumer credit line application:
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 need to create an account snapshot for the customer and link it to their credit line application by calling the following endpoints:
The account snapshot contains a breakdown of the customer's account information, such as balance, transactions, bookings, and recurrent repayment amounts over a specific period. It is mandatory for Lending integrations, as it is used for credit scoring to verify the customer's financial data.
Call the endpoint below to create a snapshot. You must specify the source field to determine the integration method.
Request URL
POST /v1/persons/{person_id}/account_snapshotsUse this method to integrate the FTS wizard.
- Integrate the FTS wizard in your solution (see FTS Documentation).
- Call the endpoint with
source: FIN_TECH_SYSTEMS. Optionally, include theiban. - Use the returned
wizard_session_keyto initialize the FTS wizard. - The customer enters their credentials in the wizard.
Request:
{ "source": "FIN_TECH_SYSTEMS" }
Response:
{ "wizard_session_key": "Hm7jUSC7XU2nQjPqJO8dl39eDkdjtOdCtywcmv3x", "location": null, "id": "8df2a8ba713c43dc9cb481b9cceed487snap", "account_id": null }
Use this method to integrate the FinX widget.
- Integrate the FinX widget (see FinX Documentation).
- Call the endpoint with
source: FINREACH. - Redirect the customer to the URL provided in the
locationfield.
Request:
{ "source": "FINREACH" }
Response:
{ "wizard_session_key": null, "location": "https://ui.solaris-i.prod.finleap.cloud?token=xxxxxx", "id": "8df2a8ba713c43dc9cb481b9cceed487snap", "account_id": null }
Use this method if you have your own connection to a third-party provider and want to upload the data directly.
- Set
sourcetoPARTNER. - Include the full data structure in
snapshot_data.
Request:
{ "source": "PARTNER", "snapshot_data": { "account": { "bank_name": "", "bic": "", "country_id": "", "description": "", "holder": "John Smith", "iban": "DE92370601930002130041", "joint_account": false }, "balance": { "balance": 3720.2, "currency": "EUR", "date": "2022-02-03", "limit": 0 }, "date": "2022-02-03", "days": 90, "turnovers": [ { … } ] } }
Use this method if the customer already has a Solaris account.
- Set
sourcetoSOLARISBANK. - Include the
account_idof the Solaris account.
Request:
{ "source": "SOLARISBANK", "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc" }
Response:
{ "wizard_session_key": null, "location": null, "id": "0a3f28733f9a4842842aae2804f80eb4snap", "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc" }
Call this endpoint to check the status and validity of an existing snapshot.
Request URL
GET /v1/persons/{person_id}/account_snapshots/{account_snapshot_id}- If the status is
expired, you must create a new snapshot. - Subscribe to the
ACCOUNT_SNAPSHOTwebhook for status updates.
After creating an account snapshot, use this endpoint to link the customer's account snapshot to their existing credit line application.
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.
If the verification step fails, the status will change to rejected and you must abort the onboarding process.
Request example
// PUT /v1/persons/{person_id}/credit_line_applications/{application_id}/account_snapshot
{
"account_snapshot_id": "6c8f81a234df4052a9cde197577347b7snap"
}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:
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
GET /v1/persons/{person_id}/credit_line_applications/{application_id}/pre_contractAfter 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.
It is recommended to share the final contract with the customer via email or direct download prior to the identification process.
Request URL
GET /v1/persons/{person_id}/credit_line_applications/{application_id}/contractThe 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.
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 once the status of the consumer credit line application changes to esign_pending.
This guide explains the integration process with video identification as the identification method. For an overview of other available KYC methods, check the customer KYC products overview page and consult with your Partner Manager.
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 will need to retrieve the 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
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.
{
"id": "97b07d67783856a08312f38bf7b7ef2ecidt",
"reference": "TST-NGGWH",
"url":"[https://go.test.idnow.de/solarisbankesignsandbox/identifications/:id](https://go.test.idnow.de/solarisbankesignsandbox/identifications/:id)",
"status": "pending",
"completed_at": null,
"method": "idnow",
"proof_of_address_type": null,
"proof_of_address_issued_at": null,
"address": null,
"documents": []
}- For a list of possible values for IDnow
statusand their descriptions, check the appendix. - Additionally, subscribe to the
IDENTIFICATIONwebhook event to get IDnow status updates. - Check the video identification guide for more endpoints related to KYC with IDnow.
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
GET /v1/persons/{person_id}/identifications/{id}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
GET /v1/persons/{person_id}/documents/{id}/fileIn this step, the customer will be identified through our KYC partner IDnow and internally screened by Solaris for risk metrics:
Successful identification
Once the customer completes the identification and e-signing process successfully, the credit line application status changes to esign_complete.
Failed identification
If the identification and e-signing process fails, the credit line application status changes to esign_failed. In this case, the customer can attempt to identify again depending on the reason for failure from IDnow.
Successful screening
Once the application status reaches esign_complete, the screening process will be triggered. If successful, the status will change to credit_line_creation_pending triggering the final steps of the onboarding process, which is the credit line and account creation.
Failed screening
If the screening process fails, the application status will change to rejected, and you must abort the onboarding process.
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.
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.
Additionally, Solaris will create an account for the customer, which will be used in the scope of the credit line agreement. The account_id will also be included in the payload.
This step includes all the relevant endpoints you need to integrate into your solution to use and service credit lines.
After a customer is granted a credit line, they can use the limit in the form of single installment loans.
For example, if Solaris 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 subsequent installment plans.
A credit line must be created before requesting installment plans.
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.
This endpoint generates possible installment plans for a given amount. The API call returns an array of possible installment plans for the given amount, including the term, monthly installment amount, and applicable interest rate.
Request example:
POST /v1/persons/{person_id}/credit_lines/{credit_line_id}/available_installment_plansThis 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.
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.
Request URL
POST /v1/persons/{person_id}/credit_lines/{credit_line_id}/loansThis section includes the different endpoints you need to integrate in your solution for servicing and maintaining credit lines for your customers.
This endpoint returns the details of the credit line, such as the used amount, active loans, available limit, etc.
Request URL
GET /v1/persons/{person_id/}credit_lines/{credit_line_id}This endpoint updates the internal payout account (Solaris account) used for a credit line loan payout.
Request example
PATCH /v1/persons/{person_id}/credit_lines/{credit_line_id}/payout_accountThis endpoint updates the reference account (external account) used for a credit line loan payout.
PATCH /v1/persons/{person_id}/credit_lines/{credit_line_id}/reference_accountThe 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
PUT /v1/persons/{person_id}/credit_lines/{credit_line_id}/revokeDue to regulatory requirements, you need to generate annual account statements for credit lines for all of your customers with an active credit line. As long as the credit line remains active, you must share the annual statement with the customer every year as a PDF file, either via email or direct download through your frontend.
Additionally, in case of terminated credit lines, you need to generate a closing account statement and share it with the customer after the termination and account closure process has been completed.
Call this endpoint to download an annual account statement for a credit line.
Call this endpoint to download a closing account statement for a credit line.
If a customer requests to close their account, any associated credit line will be terminated as well. The termination process is managed internally by Solaris and may vary depending on your specific configuration with Solaris. If your customer wishes to terminate an existing credit line independently, please contact your Partner Manager for more information about the process.
For more information about account closure requests, check the related Account Closure guide.
For customers in France, credit lines cannot be offered with an unlimited term. Credit lines are offered for a period of 12 months and must be explicitly renewed by the customer.
The process for credit lines renewals is as follows:
- Solaris will notify you about the credit line renewal via the webhook event CREDIT_LINE.
- You must notify the customer of the renewal request.
- Call the endpoint PATCH Send confirmation to Solaris about customer renewal notification to inform Solaris that you have notified the customer, and include the notification date in the request body.
- In case the customer doesn't want to renew the credit line, call the endpoint POST Cancel credit line renewal to initiate the termination process. Please note that all credit line obligations must be repaid before terminating the credit line and closing the account.
- If the customer doesn't cancel the renewal, the credit line will be automatically renewed.
This section includes the different endpoints you need to integrate in your solution for servicing and maintaining loans for your customers.
Implement these endpoints to manage the active loan lifecycle, including retrieving status, schedules, and history.
Key Endpoints:
- GET Retrieve a loan
- GET Index all loans
- GET Retrieve a loan schedule
- GET Retrieve repayment history
- GET Retrieve credit line mandate
Call this endpoint to retrieve the latest repayment schedule for a specific loan. The response includes:
- Loan balance: The remaining amount to be paid.
- Loan installments: A list of past and future scheduled payments.
Request URL
GET /v1/loans/{loan_id}/repayment_scheduleCall this endpoint to view the history of all payments made towards the loan. The response includes:
- SEPA Direct Debits (SDD): Automatic monthly installments pulled from the reference account.
- SEPA Credit Transfers (SCT): Manual transfers made by the customer for partial or full early repayment (if applicable).
Request URL
GET /v1/loans/{loan_id}/repayment_historyCongratulations! You have 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.
Check the following links for additional related guides and API reference documentation:
- Consumer Credit Line API Reference Documentation
- Loan Servicing API Reference documentation
- Person Signings API Reference Documentation
- Video Identification Guide
- SEPA Transfers Overview
- SEPA Direct Debit Transfers
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. |
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 credit line 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. 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. |
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. |
The following table includes the possible values for the field document_type and their descriptions.
| Enum | Description |
|---|---|
ANNUAL_FINANCIAL_STATEMENT | A business or company's annual financial statement. |
KYC_REPORT | The KYC report generated after successful customer identification. |
ID_DOCUMENT | A person's identification document, such as a passport or ID card. |
SIGNATURE | A signature sample. |
PICTURE | A picture or 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_APPLICATION | A document proving the application for registration (Gründungsurkunde), used for companies "in formation". |
REGISTER_CHECK | A register check. |
REGISTER_EXTRACT | A commercial register excerpt or similar document. |
FOUNDATION_DOCUMENT | The foundation document of a company or business. |
SCHUFA_COMPACT_REPORT | A compact SCHUFA report. |
SCHUFA_GWG_REPORT | A GWG (Money Laundering Act) 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 shareholder agreement. |
SHAREHOLDERS_LIST | A list of shareholders. |
TRADING_LICENSE | A trading license. |
TRANSPARENCY_REGISTER_EXTRACT | An extract from the 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. |
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 have been generated. Redirect the customer to the URL to complete the identification. |
pending_failed | The identification is currently under review by the provider. You cannot offer banking services to the customer at this stage. |
successful | The video identification was successful. The customer can be onboarded. Note that the customer's data might have been updated during the identification session. |
aborted | The customer aborted the identification process. They can retry using the same URL. |
canceled | The provider canceled the video identification. The customer should retry using the same URL. |
failed | The identification was unsuccessful. You cannot onboard the customer or offer any banking services to them. |
expired | The identification link has expired (validity period passed). You must create a new identification request. |
IDnow provides a reason whenever the identification has a canceled or aborted status. No reason is disclosed for the final failed status.