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
Bad Request
{- "interest_rate": 0,
- "amount": {
- "value": 100000,
- "unit": "cents",
- "currency": "EUR"
}
}
{- "installment_plans": [
- {
- "total": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "term": 0,
- "monthly_installment": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "interest_rate": 0,
- "effective_interest_rate": 0
}
]
}
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.
The application attributes
Application
Invalid request
Forbidden
Not found
Conflict
Unprocessable Entity
{- "requested_credit_limit": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "repayment_day_of_month": 1,
- "recipient_iban": "string",
- "private_insurance_amount": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "pre_selected_by_partner": true,
- "partner_score": "string",
- "partner_reference_number": "string",
- "number_of_dependents": 0,
- "net_income_amount": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "moved_in_last_two_years": true,
- "marriage_status": "MARRIED",
- "living_situation_amount": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "living_situation": "LIVING_WITH_PARENTS",
- "identification_id": "string",
- "existing_credit_repayment_excluding_mortgage": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "employment_since": "2019-08-24",
- "credit_record_id": "string"
}
{- "status_description": "string",
- "status": "string",
- "signing_id": "string",
- "scoring_workflow": {
- "required_actions": [
- {
- "required": "string"
}
]
}, - "recipient_iban": "string",
- "reason": "string",
- "person_id": "string",
- "offered_limit": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "offered_interest_rate": 0,
- "net_disposable_income": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "marriage_status": "string",
- "identification_id": "string",
- "id": "string",
- "employment_status": "string",
- "decision": "REJECTED",
- "credit_line_id": "string"
}
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": "string",
- "signing_id": "string",
- "scoring_workflow": {
- "required_actions": [
- {
- "required": "string"
}
]
}, - "recipient_iban": "string",
- "reason": "string",
- "person_id": "string",
- "offered_limit": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "offered_interest_rate": 0,
- "net_disposable_income": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "marriage_status": "string",
- "identification_id": "string",
- "id": "string",
- "employment_status": "string",
- "decision": "REJECTED",
- "credit_line_id": "string"
}
Returns an array of credit line applications.
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": "string",
- "person_id": "string",
- "limit": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "id": "string",
- "credit_line_id": "string",
- "created_at": "string"
}
]
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": "string"
}
{- "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"
}
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": "string"
}
{- "code": "build_pagination_headers_failure",
- "detail": "Cannot connect to database.",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "400",
- "title": "Failed to build pagination headers."
}
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.
No Content
Not Found
Conflict
curl -i -X PUT \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/authorization'
{- "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"
}
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'
{- "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"
}
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'
{- "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"
}
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
{- "term": 0,
- "reference": "string",
- "purpose": "string",
- "interest_rate": 0,
- "amount": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}
}
{- "status": "string",
- "interest_rate": 0,
- "id": "string",
- "effective_interest_rate": 0
}
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": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "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": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "latest_disposable_income": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "interest_rate": 0,
- "id": "string",
- "granted_at": "string",
- "disposable_income": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "created_at": "string",
- "application_id": "string",
- "annual_percentage_rate": 0,
- "active_loans": [
- {
- "id": "string"
}
], - "account_id": "string",
- "account_iban": "string"
}
Returns an array of credit lines.
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'
[- {
- "status": "string",
- "person_id": "string",
- "limit": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "id": "string",
- "granted_at": "string"
}
]
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
{- "interest_rate": 0,
- "amount": {
- "value": 1000,
- "unit": "cents",
- "currency": "EUR"
}
}
{- "installment_plans": [
- {
- "total": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "term": 0,
- "monthly_installment": {
- "currency": "EUR",
- "unit": "cents",
- "value": 1000
}, - "interest_rate": 0,
- "effective_interest_rate": 0
}
]
}
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'
{- "code": "build_pagination_headers_failure",
- "detail": "Cannot connect to database.",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "400",
- "title": "Failed to build pagination headers."
}
Terminates a customer's credit line. The termination could be initiated by the customer or Solarisbank.
CreditLine
Not Found
Termination already initiated.
Revocation still possible or termination backdated too far into the past.
{- "requested_at": "2019-08-24"
}
{- "termination_date": "2019-08-24"
}
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": "string",
- "mandate_signature_date": "2019-08-24",
- "mandate_number": "string",
- "iban": "string"
}
{- "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 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.
No Content
Invalid request
Forbidden
Not Found
{- "account_id": "string"
}
{- "code": "build_pagination_headers_failure",
- "detail": "Cannot connect to database.",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "400",
- "title": "Failed to build pagination headers."
}
This endpoint blocks the usage of a credit line. If a credit line is blocked, a loan cannot be created against it.
Additional information about the source and reasons behind the credit line block.
Credit Line Block
Invalid request
Forbidden
Not found
Conflict
{- "source": "webui",
- "reference_id": "string",
- "description": "externally_by_customer"
}
{- "source": "automatic",
- "reference_id": "string",
- "id": "string",
- "description": "string",
- "created_at": "string"
}
Returns all blocks applied to a credit line.
ConsumerCreditLine.ListCreditLineBlocksResponse
Bad Request
Forbidden
Not Found
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'
[- {
- "source": "automatic",
- "reference_id": "string",
- "id": "string",
- "description": "string",
- "created_at": "string"
}
]
Returns the details of a single block applied to a customer's credit line.
Credit Line Block
Forbidden
Not found
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/blocks/{block_id}'
{- "source": "automatic",
- "reference_id": "string",
- "id": "string",
- "description": "string",
- "created_at": "string"
}
Removes a block from a credit line.
No Content
Forbidden
Not Found
curl -i -X DELETE \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/credit_lines/{credit_line_id}/blocks/{block_id}'
{- "code": "unauthorized_action",
- "detail": "Unauthorized action is not allowed.",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "403",
- "title": "Unauthorized Action"
}
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'
{- "code": "build_pagination_headers_failure",
- "detail": "Cannot connect to database.",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "400",
- "title": "Failed to build pagination headers."
}
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'
{- "code": "build_pagination_headers_failure",
- "detail": "Cannot connect to database.",
- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "400",
- "title": "Failed to build pagination headers."
}
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"
}