Splitpay (1.0)

Download OpenAPI specification:Download

Consumer Credit Line

Calculate anonymous installment plans for a given amount

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
Security:
Request Body schema: application/json

Anonymous installment plans params

interest_rate
number or null <float>
required
object
Responses
200

Anonymous Installment Plans

400

Bad Request

post/v1/anonymous_credit_line_installment_plans
Request samples
application/json
{
  • "interest_rate": 0,
  • "amount": {
    }
}
Response samples
application/json
{
  • "installment_plans": [
    ]
}

Create consumer credit line application

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

Request
Security:
path Parameters
person_id
required
string

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

Request Body schema: application/json

The application attributes

object or null (SolarisToolkit.Web.Money.Optional)
repayment_day_of_month
integer or null
Default: 1
Enum: 1 15
recipient_iban
string or null
object or null (SolarisToolkit.Web.Money.Optional)
pre_selected_by_partner
boolean or null
partner_score
string or null
partner_reference_number
string or null
number_of_dependents
integer or null
object or null (SolarisToolkit.Web.Money.Optional)
moved_in_last_two_years
boolean or null
marriage_status
string or null
Enum: "MARRIED" "UNMARRIED" "DIVORCED"
object or null (SolarisToolkit.Web.Money.Optional)
living_situation
string or null
Enum: "LIVING_WITH_PARENTS" "LIVING_IN_RENTED_HOUSE" "LIVING_IN_OWN_HOUSE"
identification_id
string or null
object or null (SolarisToolkit.Web.Money.Optional)
employment_since
string or null <date>
credit_record_id
string or null
Responses
201

Application

400

Invalid request

403

Forbidden

404

Not found

409

Conflict

422

Unprocessable Entity

post/v1/persons/{person_id}/credit_line_applications
Request samples
application/json
{
  • "requested_credit_limit": {
    },
  • "repayment_day_of_month": 1,
  • "recipient_iban": "string",
  • "private_insurance_amount": {
    },
  • "pre_selected_by_partner": true,
  • "partner_score": "string",
  • "partner_reference_number": "string",
  • "number_of_dependents": 0,
  • "net_income_amount": {
    },
  • "moved_in_last_two_years": true,
  • "marriage_status": "MARRIED",
  • "living_situation_amount": {
    },
  • "living_situation": "LIVING_WITH_PARENTS",
  • "identification_id": "string",
  • "existing_credit_repayment_excluding_mortgage": {
    },
  • "employment_since": "2019-08-24",
  • "credit_record_id": "string"
}
Response samples
application/json
{
  • "status_description": "string",
  • "status": "string",
  • "signing_id": "string",
  • "scoring_workflow": {
    },
  • "recipient_iban": "string",
  • "reason": "string",
  • "person_id": "string",
  • "offered_limit": {
    },
  • "offered_interest_rate": 0,
  • "net_disposable_income": {
    },
  • "marriage_status": "string",
  • "identification_id": "string",
  • "id": "string",
  • "employment_status": "string",
  • "decision": "REJECTED",
  • "credit_line_id": "string"
}

Retrieve consumer credit line application

Returns the current status and details of an existing consumer credit line application. Alternatively, you can subscribe to the webhook event CREDIT_LINE_APPLICATION to receive status updates on the application.

Request
Security:
path Parameters
person_id
required
string

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

application_id
required
string

The unique credit line application ID assigned to a specific customer.

Responses
200

Application

404

Not Found

get/v1/persons/{person_id}/credit_line_applications/{application_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_line_applications/{application_id}'
Response samples
application/json
{
  • "status_description": "string",
  • "status": "string",
  • "signing_id": "string",
  • "scoring_workflow": {
    },
  • "recipient_iban": "string",
  • "reason": "string",
  • "person_id": "string",
  • "offered_limit": {
    },
  • "offered_interest_rate": 0,
  • "net_disposable_income": {
    },
  • "marriage_status": "string",
  • "identification_id": "string",
  • "id": "string",
  • "employment_status": "string",
  • "decision": "REJECTED",
  • "credit_line_id": "string"
}

List credit line applications

Returns an array of credit line applications.

Request
Security:
query Parameters
page[number]
integer

The number of result pages to return.

page[size]
integer

The size of each result page (maximum amount of results) to return.

filter[person_id]
string

Filter results by person_id.

filter[id]
string

Filter results by application_id.

filter[credit_line_id]
string

Filter results by credit_line_id.

filter[status]
string

Filter results by the application status.

filter[application_date_min]
string

Filter results by the minimum date when the application was created.

filter[application_date_max]
string

Filter results by the maximum date when the application was created.

filter[credit_line_amount]
integer

Filter results by the credit_line_amount.

Responses
200

ConsumerCreditLineWeb.ListCreditLineApplicationsResponse

400

Bad Request

403

Forbidden

get/v1/persons/credit_line_applications
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/credit_line_applications?page%5Bnumber%5D=0&page%5Bsize%5D=0&filter%5Bperson_id%5D=string&filter%5Bid%5D=string&filter%5Bcredit_line_id%5D=string&filter%5Bstatus%5D=string&filter%5Bapplication_date_min%5D=string&filter%5Bapplication_date_max%5D=string&filter%5Bcredit_line_amount%5D=0'
Response samples
application/json
[
  • {
    }
]

Link an account snapshot to a consumer credit line application

Links a customer 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
Security:
path Parameters
person_id
required
string

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

application_id
required
string

The unique credit line application ID assigned to a specific customer.

Request Body schema: application/json

Account Snapshot link

account_snapshot_id
required
string
Responses
204

No Content

404

Not Found

put/v1/persons/{person_id}/credit_line_applications/{application_id}/account_snapshot
Request samples
application/json
{
  • "account_snapshot_id": "string"
}
Response samples
application/json
{
  • "code": "model_not_found",
  • "detail": "Couldn't find 'credit_line' for id 'c5f22b00baa845869ceb3a7d90d59bffccln'.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "404",
  • "title": "Model Not Found"
}

Link customer identification to consumer credit line application

Links a customer identification resource to their credit line application. You must add the identification_id in the request body. To retrieve the identification ID, call the GET Retrieve consumer credit line application. It should be included in the payload as soon as the identification has been created for the customer.

Request
Security:
path Parameters
person_id
required
string

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

application_id
required
string

The unique consumer credit line application ID assigned to a specific customer.

Request Body schema: application/json

The identification id to attach to the application.

identification_id
required
string
Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

422

Unprocessable Entity

put/v1/persons/{person_id}/credit_line_applications/{application_id}/identification
Request samples
application/json
{
  • "identification_id": "string"
}
Response samples
application/json
{
  • "code": "build_pagination_headers_failure",
  • "detail": "Cannot connect to database.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "title": "Failed to build pagination headers."
}

Authorize a credit line

This endpoint enables an additional authorization flow from your side in specific use cases. After Solarisbank approves the credit line application, you can call this endpoint to authorize the credit line internally before it can be issued to the customer.

Request
Security:
path Parameters
person_id
required
string

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

credit_line_id
required
string

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

Responses
204

No Content

404

Not Found

409

Conflict

put/v1/persons/{person_id}/credit_lines/{credit_line_id}/authorization
Request samples
curl -i -X PUT \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/authorization'
Response samples
application/json
{
  • "code": "model_not_found",
  • "detail": "Couldn't find 'credit_line' for id 'c5f22b00baa845869ceb3a7d90d59bffccln'.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "404",
  • "title": "Model Not Found"
}

Download the pre-contractual information for consumer credit line

Generates a SECCI form, which is the overview of the final offer and the contract. This endpoint downloads the SECCI form as a PDF, which you must share with the customer to review the data based on which the final contract is generated.

Request
Security:
path Parameters
person_id
required
string

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

application_id
required
string

The unique consumer credit line application ID assigned to a specific customer.

Responses
200

The binary of the pre-contractual information (SECCI)

404

Not Found

409

Conflict

get/v1/persons/{person_id}/credit_line_applications/{application_id}/pre_contract
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_line_applications/{application_id}/pre_contract'
Response samples
application/json
{
  • "code": "model_not_found",
  • "detail": "Couldn't find 'credit_line' for id 'c5f22b00baa845869ceb3a7d90d59bffccln'.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "404",
  • "title": "Model Not Found"
}

Download the final contract for consumer credit line

Generates the final contract for a consumer credit line, which the customer must e-sign during the identification and e-signing process.

Request
Security:
path Parameters
person_id
required
string

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

application_id
required
string

The unique credit line application ID assigned to a specific customer.

Responses
200

The pdf binary of the contract

404

Not Found

409

Conflict

get/v1/persons/{person_id}/credit_line_applications/{application_id}/contract
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_line_applications/{application_id}/contract'
Response samples
application/json
{
  • "code": "model_not_found",
  • "detail": "Couldn't find 'credit_line' for id 'c5f22b00baa845869ceb3a7d90d59bffccln'.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "404",
  • "title": "Model Not Found"
}

Create consumer credit line loan

Creates a credit line loan based on an installment plan. The loan is used for bank statements and should include a purpose and you must assign a reference to it. The credit line must have already been created without any blocks before creating a loan.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

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

Request Body schema: application/json

The application attributes

term
required
integer
reference
required
string
purpose
required
string <= 255 characters
interest_rate
number or null <float>
required
object (SolarisToolkit.Web.Money)
Responses
201

Application

400

Not Found

409

Conflict

post/v1/persons/{person_id}/credit_lines/{credit_line_id}/loans
Request samples
application/json
{
  • "term": 0,
  • "reference": "string",
  • "purpose": "string",
  • "interest_rate": 0,
  • "amount": {
    }
}
Response samples
application/json
{
  • "status": "string",
  • "interest_rate": 0,
  • "id": "string",
  • "effective_interest_rate": 0
}

Retrieve a consumer credit line

Returns the details and status of a credit line associated with a specific customer.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer for whom the credit line is issued.

credit_line_id
required
string

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

Responses
200

CreditLine

404

Not Found

get/v1/persons/{person_id}/credit_lines/{credit_line_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}'
Response samples
application/json
{
  • "utilized_amount": {
    },
  • "termination_type": "ORDINARY_BY_BANK",
  • "termination_requested_at": "2019-08-24",
  • "termination_date": "2019-08-24",
  • "status": "string",
  • "recipient_iban": "string",
  • "product_type": "freelancer",
  • "person_id": "string",
  • "locking_status": "string",
  • "limit": {
    },
  • "latest_disposable_income": {
    },
  • "interest_rate": 0,
  • "id": "string",
  • "granted_at": "string",
  • "disposable_income": {
    },
  • "created_at": "string",
  • "application_id": "string",
  • "annual_percentage_rate": 0,
  • "active_loans": [
    ],
  • "account_id": "string",
  • "account_iban": "string"
}

List credit lines

Returns an array of credit lines.

Request
Security:
query Parameters
page[number]
integer

The number of result pages to return.

page[size]
integer

The size of each result page (maximum amount of results) to return.

filter[person_id]
string

Filter results by person_id.

filter[status]
string

Filter results by credit line status.

filter[granted_at_min]
string

Filter results by the minimum date when the credit line was granted.

filter[granted_at_max]
string

Filter results by the maximum date when the credit line was granted.

filter[id]
string

Filter results by credit_line_id.

Responses
200

ConsumerCreditLine.V1.ListCreditLinesResponse

400

Bad Request

403

Forbidden

get/v1/persons/credit_lines
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/credit_lines?page%5Bnumber%5D=0&page%5Bsize%5D=0&filter%5Bperson_id%5D=string&filter%5Bstatus%5D=string&filter%5Bgranted_at_min%5D=string&filter%5Bgranted_at_max%5D=string&filter%5Bid%5D=string'
Response samples
application/json
[
  • {
    }
]

Calculate all available installment plans for a given amount

Creates possible installment plans for a requested amount. The credit line must have already been created before calling this endpoint. Afterward, you can create a loan for the customer based on one of these plans.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

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

Request Body schema: application/json

The criteria for calculating the available installment plans

interest_rate
number or null <float>
required
object
Responses
200

Available Installment Plans

404

Not Found

post/v1/persons/{person_id}/credit_lines/{credit_line_id}/available_installment_plans
Request samples
application/json
{
  • "interest_rate": 0,
  • "amount": {
    }
}
Response samples
application/json
{
  • "installment_plans": [
    ]
}

Revoke a credit line

Revokes a credit line. Revoking a credit line must be done within 14 days from the issuance date.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

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

Responses
204

No Content

400

Bad Request

404

Not Found

409

Conflict

put/v1/persons/{person_id}/credit_lines/{credit_line_id}/revoke
Request samples
curl -i -X PUT \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/revoke'
Response samples
application/json
{
  • "code": "build_pagination_headers_failure",
  • "detail": "Cannot connect to database.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "title": "Failed to build pagination headers."
}

Terminate a credit line

Terminates a customer's credit line. The termination could be initiated by the customer or Solarisbank.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

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

Request Body schema: application/json

Termination request

requested_at
required
string <date>
Responses
200

CreditLine

404

Not Found

409

Termination already initiated.

422

Revocation still possible or termination backdated too far into the past.

patch/v1/persons/{person_id}/credit_lines/{credit_line_id}/terminate
Request samples
application/json
{
  • "requested_at": "2019-08-24"
}
Response samples
application/json
{
  • "termination_date": "2019-08-24"
}

Update the reference account of a credit line

Updates the external reference account associated with a customer's credit line. The account is used for the payout of a credit line loan.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

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

Request Body schema: application/json

Update reference account

name
string or null <= 255 characters
mandate_signature_date
required
string <date>
mandate_number
required
string <= 255 characters
iban
required
string <= 34 characters
Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

422

Unprocessable Entity

patch/v1/persons/{person_id}/credit_lines/{credit_line_id}/reference_account
Request samples
application/json
{
  • "name": "string",
  • "mandate_signature_date": "2019-08-24",
  • "mandate_number": "string",
  • "iban": "string"
}
Response samples
application/json
{
  • "code": "build_pagination_headers_failure",
  • "detail": "Cannot connect to database.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "title": "Failed to build pagination headers."
}

Add internal payout account to a credit line

Links a customer's internal payout account (i.e., an existing Solarisbank account) to their credit line. The account is used for the payout of a credit line loan.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

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

Request Body schema: application/json

Internal Payout Account Id

account_id
required
string
Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

patch/v1/persons/{person_id}/credit_lines/{credit_line_id}/payout_account
Request samples
application/json
{
  • "account_id": "string"
}
Response samples
application/json
{
  • "code": "build_pagination_headers_failure",
  • "detail": "Cannot connect to database.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "title": "Failed to build pagination headers."
}

Block a credit line

This endpoint blocks the usage of a credit line. If a credit line is blocked, a loan cannot be created against it.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer whose credit line should be blocked.

credit_line_id
required
string

The unique ID of the credit line that should be blocked.

Request Body schema: application/json

Additional information about the source and reasons behind the credit line block.

source
required
string
Value: "webui"
reference_id
string <= 255 characters
description
required
string
Value: "externally_by_customer"
Responses
201

Credit Line Block

400

Invalid request

403

Forbidden

404

Not found

409

Conflict

post/v1/persons/{person_id}/credit_lines/{credit_line_id}/blocks
Request samples
application/json
{
  • "source": "webui",
  • "reference_id": "string",
  • "description": "externally_by_customer"
}
Response samples
application/json
{
  • "source": "automatic",
  • "reference_id": "string",
  • "id": "string",
  • "description": "string",
  • "created_at": "string"
}

List blocks for a credit line

Returns all blocks applied to a credit line.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

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

query Parameters
page[number]
integer

The number of result pages to return.

page[size]
integer

The size of each result page (maximum amount of results) to return.

Responses
200

ConsumerCreditLine.ListCreditLineBlocksResponse

400

Bad Request

403

Forbidden

404

Not Found

get/v1/persons/{person_id}/credit_lines/{credit_line_id}/blocks
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/blocks?page%5Bnumber%5D=0&page%5Bsize%5D=0'
Response samples
application/json
[
  • {
    }
]

Retrieve a credit line block

Returns the details of a single block applied to a customer's credit line.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

The unique ID of the credit line.

block_id
required
string

The unique ID of the credit line block.

Responses
200

Credit Line Block

403

Forbidden

404

Not found

get/v1/persons/{person_id}/credit_lines/{credit_line_id}/blocks/{block_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/blocks/{block_id}'
Response samples
application/json
{
  • "source": "automatic",
  • "reference_id": "string",
  • "id": "string",
  • "description": "string",
  • "created_at": "string"
}

Remove a credit line block

Removes a block from a credit line.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

The unique ID of the credit line.

block_id
required
string

E.g. Installment UUID / cards UUID/ dunning case UUID

Responses
204

No Content

403

Forbidden

404

Not Found

delete/v1/persons/{person_id}/credit_lines/{credit_line_id}/blocks/{block_id}
Request samples
curl -i -X DELETE \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/blocks/{block_id}'
Response samples
application/json
{
  • "code": "unauthorized_action",
  • "detail": "Unauthorized action is not allowed.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "403",
  • "title": "Unauthorized Action"
}

Download annual account statement for consumer credit line for a given year.

Downloads an account statement for a credit line for a specific year as a PDF.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

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

query Parameters
year
required
integer

The year for which the annual statement is issued.

Responses
200

The PDF binary of the annual account statement

400

Bad Request

403

Forbidden

404

Not Found

get/v1/persons/{person_id}/credit_lines/{credit_line_id}/annual_account_statement
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/annual_account_statement?year=0'
Response samples
application/json
{
  • "code": "build_pagination_headers_failure",
  • "detail": "Cannot connect to database.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "title": "Failed to build pagination headers."
}

Download closing account statement for a consumer credit line.

Downloads the closing account statement for a credit line as a PDF.

Request
Security:
path Parameters
person_id
required
string

The person ID of the customer who has the credit line.

credit_line_id
required
string

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

Responses
200

The pdf binary of the closing account statement

400

Bad Request

403

Forbidden

404

Not Found

get/v1/persons/{person_id}/credit_lines/{credit_line_id}/closing_account_statement
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/closing_account_statement'
Response samples
application/json
{
  • "code": "build_pagination_headers_failure",
  • "detail": "Cannot connect to database.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "title": "Failed to build pagination headers."
}

Freelancer Credit Line

Calculate anonymous installment plans for a given amount

Generates an anonymous credit line installment plan for a specific amount, including the monthly installment amount, the loan duration, and the applicable interest rates, allowing potential customers to receive an initial offer before applying for a credit line.

Request
Security:
Request Body schema: application/json

Anonymous installment plans params

required
object
interest_rate
number or null <float>

The interest rate applicable on the credit line. This rate is fixed for each partner depending on contractual and commercial agreements with Solarisbank.

Responses
200

Anonymous Installment Plans

400

Bad Request

403

Forbidden

404

Not found

post/v1/freelancers/anonymous_credit_line_installment_plans
Request samples
application/json
{
  • "amount": {
    },
  • "interest_rate": 1
}
Response samples
application/json
{
  • "installment_plans": [
    ]
}

Create freelancer credit line application

Creates a freelancer credit line application. The payload of this endpoint includes all the required financial information and account data about the customer, which the credit scorer uses to initiate a series of credit checks to determine the customer's credit risk and eligibility.

Request
Security:
path Parameters
person_id
required
string

The unique person ID, generated after completing the person onboarding process.

Request Body schema: application/json

The application attributes

required
object

The total annual income generated by the freelancer's business before deducting any expenses.

corporate_name
required
string

The corporate name of the freelancer's business.

foundation_date
required
string <date>

The date on which the freelancer's business was founded.

legal_form
required
string

The legal form of the freelancer's business.

Enum: "FREE_OCCUPATION" "COMMERCIAL_ENTERPRISE" "OTHER"
required
object

The monthly net profit generated by the freelancer's business after deducting all recurring business expenses.

required
object

The total monthly amount of credit expenses incurred by the freelancer, excluding mortgage-related expenses.

required
object

The total monthly amount of private fixed costs for the freelancer. Private costs include expenses not related to the business activities, such as rent or health insurance.

pre_selected_by_partner
boolean
Default: false

Value to be set when customer is pre selected by own risk assessment.

recipient_iban
required
string

The IBAN of the beneficiary's account.

tax_id
required
string

The tax ID associated with the freelancer's legal entity.

Responses
201

Application

400

Invalid request

403

Forbidden

404

Not Found

422

Unprocessable Entity

post/v1/freelancers/persons/{person_id}/credit_line_applications
Request samples
application/json
{
  • "annual_turnover": {
    },
  • "corporate_name": "string",
  • "foundation_date": "2019-08-24",
  • "legal_form": "FREE_OCCUPATION",
  • "monthly_net_profit": {
    },
  • "monthly_non_mortgage_credit_expense": {
    },
  • "monthly_private_fixed_cost": {
    },
  • "pre_selected_by_partner": false,
  • "recipient_iban": "DE13110101014386274299",
  • "tax_id": "3012034567890"
}
Response samples
application/json
{
  • "credit_line_id": "c5f22b00baa845869ceb3a7d90d59bffccln",
  • "decision": "REJECTED",
  • "id": "7d903b7483294e3b902b89097d699dbdccla",
  • "identification_id": "51462340e8653f8e2864801e8ebb4131cidt",
  • "mandate_reference_number": "LXD3RGLRTP6HHM",
  • "net_disposable_income": {
    },
  • "offered_interest_rate": 0.11,
  • "offered_limit": {
    },
  • "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
  • "reason": "string",
  • "recipient_iban": "DE13110101014386274299",
  • "status": "rejected",
  • "status_description": "Rejected by Scorer"
}

Retrieve freelancer credit line application

Returns the current status and details of an existing freelancer credit line application.

Request
Security:
path Parameters
person_id
required
string

The unique person ID, generated after completing the person onboarding process.

application_id
required
string

Freelancer Credit Line Application ID

Responses
200

Application

403

Forbidden

404

Not Found

get/v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}'
Response samples
application/json
{
  • "credit_line_id": "c5f22b00baa845869ceb3a7d90d59bffccln",
  • "decision": "REJECTED",
  • "id": "7d903b7483294e3b902b89097d699dbdccla",
  • "identification_id": "51462340e8653f8e2864801e8ebb4131cidt",
  • "mandate_reference_number": "LXD3RGLRTP6HHM",
  • "net_disposable_income": {
    },
  • "offered_interest_rate": 0.11,
  • "offered_limit": {
    },
  • "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
  • "reason": "string",
  • "recipient_iban": "DE13110101014386274299",
  • "status": "rejected",
  • "status_description": "Rejected by Scorer"
}

Link credit record to freelancer credit line application

Links a freelancer credit record to their existing credit line application. You have to add the unique ID of the credit record in the payload of this endpoint.

Request
Security:
path Parameters
person_id
required
string

The unique person ID, generated after completing the person onboarding process.

application_id
required
string

The unique ID of a freelancer credit line application.

Request Body schema: application/json

Credit Record link

credit_record_id
required
string

The unique ID of a credit record, generated after creating a freelancer credit record.

Responses
204

No Content

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

put/v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}/credit_record
Request samples
application/json
{
  • "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}
Response samples
application/json
{
  • "code": "build_pagination_headers_failure",
  • "detail": "Cannot connect to database.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "400",
  • "title": "Failed to build pagination headers."
}

Link account snapshot to freelancer credit line application

Links a freelancer account snapshot to their existing credit line application. You have to add the unique ID of the account snapshot in the payload of this endpoint.

Request
Security:
path Parameters
person_id
required
string

The unique person ID, generated after completing the person onboarding process.

application_id
required
string

The unique ID of a freelancer credit line application.

Request Body schema: application/json

Account snapshot link

account_snapshot_id
required
string

The unique ID of a customer account snapshot.

Responses
204

No Content

404

Not found

put/v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}/account_snapshot
Request samples
application/json
{
  • "account_snapshot_id": "0a3f28733f9a4842842aae2804f80eb4snap"
}
Response samples
application/json
{
  • "code": "model_not_found",
  • "detail": "Couldn't find 'Account' for id 'DE24112233445566'.",
  • "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  • "status": "404",
  • "title": "Model Not Found"
}

Set contract agreement date for a freelancer credit line application

Creates the credit line contract agreement. After a credit application passes the credit checks, call this endpoint and collect the customer's consent on the credit line contract and terms and conditions.

Request
Security:
path Parameters
person_id
required
string

The unique person ID, generated after completing the person onboarding process.

application_id
required
string

The unique ID of a freelancer credit line application.

Responses
200

Application

400

Invalid request

403

Forbidden

404

Not Found

409

Conflict

put/v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}/contract_agreement
Request samples
curl -i -X PUT \
  'https://api.solaris-sandbox.de/v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}/contract_agreement'
Response samples
application/json
{
  • "credit_line_id": "c5f22b00baa845869ceb3a7d90d59bffccln",
  • "decision": "REJECTED",
  • "id": "7d903b7483294e3b902b89097d699dbdccla",
  • "identification_id": "51462340e8653f8e2864801e8ebb4131cidt",
  • "mandate_reference_number": "LXD3RGLRTP6HHM",
  • "net_disposable_income": {
    },
  • "offered_interest_rate": 0.11,
  • "offered_limit": {
    },
  • "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
  • "reason": "string",
  • "recipient_iban": "DE13110101014386274299",
  • "status": "rejected",
  • "status_description": "Rejected by Scorer"
}