Download OpenAPI specification:Download
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.
Anonymous installment plans params
Anonymous Installment Plans
Bad Request
{- "loan_type": "installment_plan",
- "interest_rate": 0.11,
- "bullet_loan_repayment_date": "2022-02-22",
- "amount": {
- "value": 1,
- "unit": "cents",
- "currency": "EUR"
}
}
{- "installment_plans": [
- {
- "total": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "term": 6,
- "monthly_installment": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "interest_rate": 0.11,
- "effective_interest_rate": 0.1157
}
]
}
Creates a consumer credit line application and assigns it to the person with the person_id
included in the request URL. The payload of this endpoint includes all the required financial information and account data about the applicant, which the credit scorer uses to initiate a series of credit checks. See the Consumer Splitpay guide for the list of mandatory properties.
The application attributes
Application
Invalid request
Forbidden
Not found
Conflict
Unprocessable Entity
{- "requested_credit_limit": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "repayment_day_of_month": 1,
- "recipient_iban": "DE92370601930002130041",
- "private_insurance_amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "pre_selected_by_partner": false,
- "partner_score": "string",
- "partner_reference_number": "AGHD02130041",
- "number_of_dependents": 2,
- "net_income_amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "moved_in_last_two_years": false,
- "marriage_status": "MARRIED",
- "living_situation_amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "living_situation": "LIVING_IN_RENTED_HOUSE",
- "identification_id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
- "existing_credit_repayment_excluding_mortgage": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "employment_since": "2019-11-01",
- "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}
{- "status_description": "string",
- "status": "account_snapshot_pending",
- "signing_id": "7c63600ddddec4f2668893af39c1b814csig",
- "scoring_workflow": {
- "required_actions": [
- {
- "required": "string"
}
]
}, - "recipient_iban": "DE92370601930002130041",
- "reason": "string",
- "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
- "partner_reference_number": "ABHP244919",
- "offered_limit": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "offered_interest_rate": 2.5,
- "net_disposable_income": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "marriage_status": "UNMARRIED",
- "identification_id": "9e2e85c62230a652325964282c84559fcidt",
- "id": "35eee37033c5436f9cbff6df1f88e097ccla",
- "employment_status": "EMPLOYED",
- "decision": "OFFERED",
- "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln"
}
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.
Application
Not Found
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_line_applications/{application_id}'
{- "status_description": "string",
- "status": "account_snapshot_pending",
- "signing_id": "7c63600ddddec4f2668893af39c1b814csig",
- "scoring_workflow": {
- "required_actions": [
- {
- "required": "string"
}
]
}, - "recipient_iban": "DE92370601930002130041",
- "reason": "string",
- "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
- "partner_reference_number": "ABHP244919",
- "offered_limit": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "offered_interest_rate": 2.5,
- "net_disposable_income": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "marriage_status": "UNMARRIED",
- "identification_id": "9e2e85c62230a652325964282c84559fcidt",
- "id": "35eee37033c5436f9cbff6df1f88e097ccla",
- "employment_status": "EMPLOYED",
- "decision": "OFFERED",
- "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln"
}
Returns an array of all credit line applications for all of your customers.
ConsumerCreditLineWeb.ListCreditLineApplicationsResponse
Bad Request
Forbidden
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'
[- {
- "status": "credit_line_created",
- "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
- "limit": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "id": "35eee37033c5436f9cbff6df1f88e097ccla",
- "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln",
- "created_at": "2022-02-07T11:57:42"
}
]
Attaches a customer's credit record to their credit line application. A credit record is required for the credit scoring process.
Credit record link
No Content
Forbidden
Not Found
Conflict
{- "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}
{- "title": "Unauthorized Action",
- "status": "403",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Unauthorized action is not allowed.",
- "code": "unauthorized_action"
}
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.
Account Snapshot link
No Content
Not Found
{- "account_snapshot_id": "6c8f81a234df4052a9cde197577347b7snap"
}
{- "title": "Model Not Found",
- "status": "404",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Couldn't find 'Account' for id 'DE24112233445566'.",
- "code": "model_not_found"
}
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.
The identification id to attach to the application.
No Content
Invalid request
Forbidden
Not Found
Conflict
Unprocessable Entity
{- "identification_id": "9e2e85c62230a652325964282c84559fcidt"
}
{- "title": "Failed to build pagination headers.",
- "status": "400",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Cannot connect to database.",
- "code": "build_pagination_headers_failure"
}
This endpoint enables an additional authorization flow from your side in specific use cases. After Solaris approves the credit line application, you can call this endpoint to authorize the credit line internally before it can be issued to the customer.
No Content
Not Found
Conflict
curl -i -X PUT \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/authorization'
{- "title": "Model Not Found",
- "status": "404",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Couldn't find 'Account' for id 'DE24112233445566'.",
- "code": "model_not_found"
}
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.
The binary of the pre-contractual information (SECCI)
Not Found
Conflict
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_line_applications/{application_id}/pre_contract'
{- "title": "Model Not Found",
- "status": "404",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Couldn't find 'Account' for id 'DE24112233445566'.",
- "code": "model_not_found"
}
Generates the final contract for a consumer credit line, which the customer must e-sign during the identification and e-signing process.
The pdf binary of the contract
Not Found
Conflict
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_line_applications/{application_id}/contract'
{- "title": "Model Not Found",
- "status": "404",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Couldn't find 'Account' for id 'DE24112233445566'.",
- "code": "model_not_found"
}
(France only) Sends a confirmation to Solaris that you've sent the renewal notification to the customer. You have to add the exact date when the renewal notification was sent in the request body.
Receive partner notification about customer renewal notification
No Content
Forbidden
Not Found
{- "notification_sent_date": "2022-02-25"
}
{- "title": "Unauthorized Action",
- "status": "403",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Unauthorized action is not allowed.",
- "code": "unauthorized_action"
}
(France only) Cancels the renewal of an existing credit line after receiving a renewal notification. Call this endpoint if the customer doesn't wish to renew the credit line.
No Content
Forbidden
Not Found
curl -i -X POST \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/renewal/cancel'
{- "title": "Unauthorized Action",
- "status": "403",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Unauthorized action is not allowed.",
- "code": "unauthorized_action"
}
Returns the details and status of a credit line associated with a specific customer.
CreditLine
Not Found
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}'
{- "utilized_amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "termination_type": "ORDINARY_BY_CUSTOMER",
- "termination_requested_at": "2022-02-07",
- "termination_date": "2022-02-08",
- "status": "mandate_creation_pending",
- "renewal": {
- "status_description": "string",
- "status": "customer_notified",
- "rejection_date": "2022-10-31",
- "notification_sent_date": "2021-01-20",
- "id": "0696599d-7f0a-434b-b480-ebe5a1e20cc4",
- "effective_until_date": "2022-04-10",
- "effective_from_date": "2022-04-10",
- "credit_line_id": "1908331fb8384edcbfe63067366c4b6accln"
}, - "recipient_iban": "DE92370601930002130041",
- "product_type": "consumer",
- "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
- "locking_status": "NO_BLOCK",
- "limit": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "latest_disposable_income": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "interest_rate": 0.11,
- "id": "1908331fb8384edcbfe63067366c4b6accln",
- "granted_at": "2022-02-07T11:57:42Z",
- "disposable_income": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "created_at": "2022-02-07T11:57:42",
- "application_id": "35eee37033c5436f9cbff6df1f88e097ccla",
- "annual_percentage_rate": 0.11,
- "active_loans": [
- {
- "id": "e0167a47f385443a835050d1d9274b45cloa"
}
], - "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
- "account_iban": "DE25110101002910133758"
}
Returns an array of all credit lines for all of your customers.
ConsumerCreditLine.V1.ListCreditLinesResponse
Bad Request
Forbidden
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&filter%5Beligible_renewal_expires_at_min%5D=string&filter%5Beligible_renewal_expires_at_max%5D=string'
[- {
- "status": "open",
- "person_id": "dc1a6812a14f6cc338cd084208535bcdcper",
- "limit": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "id": "1908331fb8384edcbfe63067366c4b6accln",
- "granted_at": "2022-02-07T11:57:42Z"
}
]
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.
The criteria for calculating the available installment plans
Available Installment Plans
Not Found
{- "loan_type": "installment_plan",
- "interest_rate": 0.11,
- "bullet_loan_repayment_date": "2022-06-22",
- "amount": {
- "value": 1,
- "unit": "cents",
- "currency": "EUR"
}
}
{- "installment_plans": [
- {
- "total": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "term": 6,
- "monthly_installment": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}, - "interest_rate": 0.11,
- "effective_interest_rate": 0.1157
}
]
}
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.
The application attributes
Application
Not Found
Conflict
{- "type": "installment_plan",
- "term": 6,
- "reference": "ABH244919",
- "purpose": "Buying an iphone",
- "interest_rate": 0.11,
- "bullet_repayment_date": "2023-06-30",
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}
}
{- "type": "installment_plan",
- "status": "payout_pending",
- "interest_rate": 0.11,
- "id": "f8930e8d3dfa48e4a898d7a97c0d78b4cloa",
- "effective_interest_rate": 0.0111,
- "bullet_repayment_date": "2001-01-01"
}
Revokes a credit line. Revoking a credit line must be done within 14 days from the issuance date.
No Content
Bad Request
Not Found
Conflict
curl -i -X PUT \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/revoke'
{- "title": "Failed to build pagination headers.",
- "status": "400",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Cannot connect to database.",
- "code": "build_pagination_headers_failure"
}
Updates the external reference account associated with a customer's credit line. The account is used for the payout of a credit line loan.
Update reference account
No Content
Invalid request
Forbidden
Not Found
Conflict
Unprocessable Entity
{- "name": "Lisa Hermann",
- "mandate_signature_date": "2022-02-07",
- "mandate_number": "LUUJZMGP2IWIIE",
- "iban": "DE87110101001000057123"
}
{- "title": "Failed to build pagination headers.",
- "status": "400",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Cannot connect to database.",
- "code": "build_pagination_headers_failure"
}
Links a customer's internal payout account (i.e., an existing Solaris account) to their credit line. The account is used for the payout of a credit line loan.
Internal Payout Account Id
No Content
Invalid request
Forbidden
Not Found
{- "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc"
}
{- "title": "Failed to build pagination headers.",
- "status": "400",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Cannot connect to database.",
- "code": "build_pagination_headers_failure"
}
Downloads an account statement for a credit line for a specific year as a PDF.
The PDF binary of the annual account statement
Bad Request
Forbidden
Not Found
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/annual_account_statement?year=0'
{- "title": "Failed to build pagination headers.",
- "status": "400",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Cannot connect to database.",
- "code": "build_pagination_headers_failure"
}
Downloads the closing account statement for a credit line as a PDF.
The pdf binary of the closing account statement
Bad Request
Forbidden
Not Found
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/closing_account_statement'
{- "title": "Failed to build pagination headers.",
- "status": "400",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "detail": "Cannot connect to database.",
- "code": "build_pagination_headers_failure"
}
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.
Anonymous Installment Plans
Bad Request
Forbidden
Not found
{- "amount": {
- "currency": "EUR",
- "unit": "cents",
- "value": 100000
}, - "interest_rate": 1
}
{- "installment_plans": [
- {
- "effective_interest_rate": 3,
- "interest_rate": 1,
- "monthly_installment": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "term": 3,
- "total": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}
}
]
}
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.
The application attributes
Application
Invalid request
Forbidden
Not Found
Unprocessable Entity
{- "annual_turnover": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "corporate_name": "string",
- "foundation_date": "2019-08-24",
- "legal_form": "FREE_OCCUPATION",
- "monthly_net_profit": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "monthly_non_mortgage_credit_expense": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "monthly_private_fixed_cost": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "pre_selected_by_partner": false,
- "recipient_iban": "DE13110101014386274299",
- "tax_id": "3012034567890"
}
{- "credit_line_id": "c5f22b00baa845869ceb3a7d90d59bffccln",
- "decision": "REJECTED",
- "id": "7d903b7483294e3b902b89097d699dbdccla",
- "identification_id": "51462340e8653f8e2864801e8ebb4131cidt",
- "mandate_reference_number": "LXD3RGLRTP6HHM",
- "net_disposable_income": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "offered_interest_rate": 0.11,
- "offered_limit": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
- "reason": "string",
- "recipient_iban": "DE13110101014386274299",
- "status": "rejected",
- "status_description": "Rejected by Scorer"
}
Returns the current status and details of an existing freelancer credit line application.
Application
Forbidden
Not Found
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}'
{- "credit_line_id": "c5f22b00baa845869ceb3a7d90d59bffccln",
- "decision": "REJECTED",
- "id": "7d903b7483294e3b902b89097d699dbdccla",
- "identification_id": "51462340e8653f8e2864801e8ebb4131cidt",
- "mandate_reference_number": "LXD3RGLRTP6HHM",
- "net_disposable_income": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "offered_interest_rate": 0.11,
- "offered_limit": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
- "reason": "string",
- "recipient_iban": "DE13110101014386274299",
- "status": "rejected",
- "status_description": "Rejected by Scorer"
}
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.
Credit Record link
No Content
Invalid request
Forbidden
Not Found
Conflict
{- "credit_record_id": "fbb7d15fa4c54ba0b077592665ef04a4ccrd"
}
{- "code": "build_pagination_headers_failure",
- "detail": "Cannot connect to database.",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "400",
- "title": "Failed to build pagination headers."
}
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.
Account snapshot link
No Content
Not found
{- "account_snapshot_id": "0a3f28733f9a4842842aae2804f80eb4snap"
}
{- "code": "model_not_found",
- "detail": "Couldn't find 'Account' for id 'DE24112233445566'.",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "404",
- "title": "Model Not Found"
}
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.
Application
Invalid request
Forbidden
Not Found
Conflict
curl -i -X PUT \ 'https://api.solaris-sandbox.de/v1/freelancers/persons/{person_id}/credit_line_applications/{application_id}/contract_agreement'
{- "credit_line_id": "c5f22b00baa845869ceb3a7d90d59bffccln",
- "decision": "REJECTED",
- "id": "7d903b7483294e3b902b89097d699dbdccla",
- "identification_id": "51462340e8653f8e2864801e8ebb4131cidt",
- "mandate_reference_number": "LXD3RGLRTP6HHM",
- "net_disposable_income": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "offered_interest_rate": 0.11,
- "offered_limit": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "person_id": "ad8f5cefdc73035f17973fecb4fa2ebccper",
- "reason": "string",
- "recipient_iban": "DE13110101014386274299",
- "status": "rejected",
- "status_description": "Rejected by Scorer"
}