Freelancer Splitpay

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

This guide explains the integration process for Solaris' Freelancer Splitpay product, including the mandatory information you need to collect from your customer and the necessary endpoints and webhooks you need to integrate into your solution.

Introduction

Product specifications

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

Solaris' Freelancer Splitpay solution enables self-employed persons to convert transactions that are not older than 90 days into installment loans instantly within a credit line agreement. Additionally, freelancer Splitpay offers high-volume credit lines, ranging from 2,000 to 50,000 EUR, and longer loan terms from 3 to 24 months.

The product is offered to freelancers who are registered as:

• Freier Beruf/Freiberufler (freelancer or self-employed)
• Gewerbebetrieb (commercial enterprise)

Credit scoring

Solaris uses an automated credit scoring system (Splitpay Freelancer Scorer) to make informed credit decisions on freelancer credit line applications. The scorer collects and analyzes different information, such as the customer's 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), determining whether a credit line is offered and the limit granted.

How the scorer interacts with the credit line service

The credit line service and its related endpoints handle Splitpay 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 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:

• Pre-check: Based on the self-declared information the applicant provides when applying for a credit line.
• Initial scoring: Based on the credit record obtained from external credit bureaus, such as SCHUFA.
• Verification: Based on 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. Some applications could also skip the final verification check.

System prerequisites

Before integrating Solaris' Freelancer 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:

1. Terms and Conditions
2. Customer information
3. Economic interest

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

Integration overview

Integrate Solaris' Freelancer Splitpay by completing the following steps:

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

Sequence diagram

The following sequence diagram gives an overview of the integration flow for the Freelancer Splitpay solution:

Webhooks

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

• ACCOUNT_SNAPSHOT
• IDENTIFICATION
• PERSON_CHANGED
• PERSON_DELETED
• PERSON_MOBILE_NUMBER_CREATED
• PERSON_MOBILE_NUMBER_DELETED
• LOAN

Credit Line Specific Events

• FREELANCER_CREDIT_LINE_APPLICATION
• CREDIT_LINE

Mandatory features

You must integrate all the mandatory features for Freelancer Splitpay highlighted in the Onboarding requirements guide before going live with your solution.

Step 1: Generate an anonymous installment plan

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, 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:

Request URL

POST /v1/freelancers/anonymous_credit_line_installment_plans

View full API reference

If 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.

Step 2: Collect customer data and create person resource

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:

• Person resource API reference
  • POST Create person
  • GET Retrieve a person
  • PATCH Update person

Related webhook events

• PERSON_CHANGED
• PERSON_DELETED

POST Create person

Call this endpoint to create a person resource for your customer, and add the following mandatory data points in the request body:

Mandatory data points for freelancers in Germany

• salutation
• first_name
• last_name
• address
  • line_1
  • line_2
  • postal_code
  • city
  • country
• mobile_number
• birth_date
• birth_city
• birth_country
• nationality
• employment_status
• terms_conditions_signed_at
• data_terms_signed_at
• own_economic_interest_signed_at
• tax_information
  • marital_status
• business_trading_name
• Business Address
• business_purpose
• nace_code
• website_social_media (if available)
• expected_monthly_revenue_cents
• vat_number (becomes mandatory for self-employed persons with expected annual revenue of more than 17.500€)

Request URL

POST /v1/persons

View full API reference

PATCH update person

This endpoint updates one or more properties on a person resource. You can only update the following properties using this endpoint:

• title
• salutation
• address (line_1, line_2, postal_code, city, state, country)
• contact_address (line_1, line_2, postal_code, city, state, country)
• employment_status
• job_title
• email
• tax_information (tax_assessment, marital_status)
• fatca_relevant
• fatca_crs_confirmed_at
• business_purpose
• industry
• industry_key
• own_economic_interest_signed_at
• aml_confirmed_on (only with today or tomorrow's date)
• expected_monthly_revenue_cents
• vat_number
• website_social_media
• business_trading_name
• nace_code
• business_address_line_1
• business_address_line_2
• business_postal_code
• business_city
• business_country
• annual_income_range
• data_terms_signed_at
• branch
• birth_province
• birth_post_code
• socioprofessional_category
• purpose_of_account_opening
• main_income_source
• work_country
• work_province
• self_declared_as_pep
• international_operativity_expectation
• registration_number

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"
  }
}

• API Reference: Update person

Step 3: Create freelancer credit line application

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

POST Create freelancer credit line application

Call this endpoint to create a freelancer 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:

• annual_turnover
• corporate_name
• foundation_date
• legal_form
• monthly_net_profit
• monthly_non_mortgage_credit_expense
• monthly_private_fixed_cost
• recipient_iban
• tax_id

Request URL

POST /v1/freelancers/persons/{person_id}/credit_line_applications

View full API reference

Scoring 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 rejects applications that don't meet the minimum credit eligibility criteria.

Rejected application

If the application is rejected, the application status changes to rejected, and you must abort the customer onboarding process.

Approved application

If the application passes the pre-check, the application status changes to credit_record_pending, and you must create a credit record and link it to the application as described in the following step.

GET Retrieve freelancer credit line application

This endpoint returns the current status and details of an existing freelancer 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 FREELANCER_CREDIT_LINE_APPLICATION to receive status updates on the application.

Request URL

GET /v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}

View full API reference

Application status flow

The following diagram describes the status flow of a freelancer credit line application:

Step 4: Create credit record

In this step, you must create a freelancer 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 mandatory for Lending integrations, as it is used for credit scoring to determine the customer's creditworthiness and eligibility.

Create a credit record

To create a credit record, you must choose a source in the request body:

1. source: solarisBank (Automated) Solaris retrieves the customer's record directly from SCHUFA. This is the standard recommended process.

2. 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 file field.

Endpoints:

Depending on your customer type, use one of the following endpoints:

Retail Customers

POST /v1/persons/{person_id}/credit_records

• API Reference: Create retail credit record

Freelancers

POST /v1/freelancers/persons/{person_id}/credit_records

• API Reference: Create freelancer credit record

GET Retrieve a credit record

Call 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}

• API Reference: Retrieve credit record

PUT Link credit record to freelancer credit line application

This endpoint links the credit record you created for the customer to their existing credit line application. You must add the credit_record_id in the payload of this endpoint.

Request example

// PUT /v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}/credit_record
{
  "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}

View full API reference

Scoring results:

After linking the credit record to the application, the application status changes to initial_scoring_pending, triggering the credit scoring system to start the credit checks.

Approved application:

• If the application passes the credit scoring, the application status goes directly to offered if no account snapshot or identification is needed. In this case, proceed to step 6 to generate the relevant contract for the customer and trigger the KYC flow.
• Alternatively, the status can go to account_snapshot_verification_pending if 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 credit scoring fails, the status will change to rejected and you must abort the onboarding process.

Step 5: Create account snapshot and link it to the application (Optional)

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:

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 specific period. It is mandatory for Lending integrations, as it is used for credit scoring to verify the customer's financial data.

Create an account snapshot

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_snapshots

• API Reference: Create snapshot

Method 1: FinTecSystems (FTS)

Use this method to integrate the FTS wizard.

1. Integrate the FTS wizard in your solution (see FTS Documentation).
2. Call the endpoint with source: FIN_TECH_SYSTEMS. Optionally, include the iban.
3. Use the returned wizard_session_key to initialize the FTS wizard.
4. 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
}

Method 2: Finreach

Use this method to integrate the FinX widget.

1. Integrate the FinX widget (see FinX Documentation).
2. Call the endpoint with source: FINREACH.
3. Redirect the customer to the URL provided in the location field.

Request:

{
  "source": "FINREACH"
}

Response:

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

Method 3: Partner (Manual Upload)

Use this method if you have your own connection to a third-party provider and want to upload the data directly.

• Set source to PARTNER.
• 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": [
      { … }
    ]
  }
}

Method 4: Solaris (Internal)

Use this method if the customer already has a Solaris account.

• Set source to SOLARISBANK.
• Include the account_id of the Solaris account.

Request:

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

Response:

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

GET Retrieve account snapshot

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}

• API Reference: Retrieve snapshot

PUT Link account snapshot to freelancer credit line application

Use this endpoint to link the customer's account snapshot created in the previous step 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/freelancers/persons/{person_id}/credit_line_applications/{application_id}/account_snapshot
{
  "account_snapshot_id": "6c8f81a234df4052a9cde197577347b7snap"
}

View full API reference

Step 6: Create credit line contract and complete the customer identification

In this step, you need to create the credit line contract, which the customer might sign during the identification process.

PUT Set contract agreement date for freelancer credit line application

Call this endpoint to create the credit line contract when the application status changes to offered.

This endpoint will trigger the identification process automatically and you will not need to initiate the identification process manually for the customer. The application status should change to identification_creation_pending, which means the identification creation process has been triggered, but the resource has not been created yet.

Request URL

PUT /v1/freelancers/persons/{person_id}/credit_line_applications/{freelancer_application_id}/contract_agreement

View full API reference

GET Retrieve the identification ID

When the application status changes to identification_pending, it means that the identification resource has been created for the customer. You must call the GET Retrieve freelancer credit line application method to get the identification_id, which you will need to retrieve the identification details.

GET Retrieve the identification details

Once you obtain the identification_id from the previous endpoint, call the following method to get the video identification details, such as IDnow reference and URL, to which you need to redirect your customer to complete the video identification process with IDnow.

Request URL

GET /v1/persons/{person_id}/identifications/{identification_id}

View full API reference

Identification and screening results

In 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 identification_completed.

Failed identification

If the identification and e-signing process fails, the credit line application status changes to rejected, and you must abort the onboarding process.

Successful screening

Once the application status reaches identification_completed, 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.

GET Retrieve the credit line ID

Once the video identification process has been completed successfully, Solaris will create the credit line. You can track the credit line creation process by calling the same GET freelancer 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.

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

POST Generate available 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_plans

View 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.

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}/loans

View 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.

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

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

View full API reference

PATCH Update the internal payout account tied to a credit line

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_account

View full API reference

PATCH Update the reference account tied to a credit line

This 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_account

View 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

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

View full API reference

Credit line account statements

Due 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.

GET Download annual account statement for a credit line

Call this endpoint to download an annual account statement for a credit line.

View full API reference

GET Download closing account statement for a credit line

Call this endpoint to download a closing account statement for a credit line.

View full API reference

Account closure and Credit line termination

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.

Loan servicing

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

Loan Servicing Endpoints

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

GET Retrieve a loan schedule

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_schedule

• API Reference: Retrieve loan schedule

GET Retrieve repayment history

Call 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_history

• API Reference: Retrieve repayment history

Next steps

Congratulations! You have successfully integrated Solaris' Freelancer 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.

Useful resources

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

• Freelancer 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

Appendix I: Enums

Freelancer credit line application status

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

Freelancer credit line status

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

Credit line loan status

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

Document types

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

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.

IDnow provides a reason whenever the identification has a canceled or aborted status. No reason is disclosed for the final failed status.