# Loans

Version: 1.0

## Servers

Sandbox
```
https://api.solaris-sandbox.de
```

Production
```
https://api.solarisbank.de
```

## Download OpenAPI description

[Loans](https://docs.solarisgroup.com/_bundle/api-reference/lending/loans.yaml)

## Loan servicing

### Retrieve a loan schedule

 - [GET /v1/loans/{loan_id}/repayment_schedule](https://docs.solarisgroup.com/api-reference/lending/loans/loan-servicing/loanengineweb.v1.loans.repaymentschedule.showoperation.md): Returns the schedule of the loan specified in the request URL. The loan schedule includes the full details of a loan, such as loan balance, fees, penalities, interests, and all past, present, and future installments of the loan.

### Retrieve the history of repayments of a loan

 - [GET /v1/loans/{loan_id}/repayment_history](https://docs.solarisgroup.com/api-reference/lending/loans/loan-servicing/loanengineweb.v1.loans.showrepaymenthistoryoperation.md): Returns the history of all past repayments the customer made in relation to the loan specified in the request URL. This includes all executed SEPA Direct Debits (SDD) and/or SEPA Credit Transfers (SCT).

### Retrieve a loan

 - [GET /v1/loans/{loan_id}](https://docs.solarisgroup.com/api-reference/lending/loans/loan-servicing/loanengineweb.v1.loans.showoperation.md): Returns the details of the loan specified in the request URL.

### Index loans

 - [GET /v1/loans](https://docs.solarisgroup.com/api-reference/lending/loans/loan-servicing/loanengineweb.v1.loans.indexoperation.md): Returns an array containing all loans for all of your customers.

### Retrieve a credit line mandate

 - [GET /v1/credit_lines/{credit_line_id}/active_mandate](https://docs.solarisgroup.com/api-reference/lending/loans/loan-servicing/loanengineweb.v1.mandates.showcreditlinemandateoperation.md): Returns a signed mandate for a credit line.

### (DEPRECATED) Retrieve the repayment plan of a loan (deprecated)

 - [GET /v1/loans/{loan_id}/repayment_plan](https://docs.solarisgroup.com/api-reference/lending/loans/loan-servicing/loanengineweb.v1.loans.repaymentplan.showoperation.md): Returns the repayment plan of the loan specified in the request URL. This endpoint is deprecated. Please use the repayment schedule endpoint instead.

## Loan dunning cases

### Index the notifications of a dunning case

 - [GET /v1/dunning_cases/{dunning_case_id}/notifications](https://docs.solarisgroup.com/api-reference/lending/loans/loan-dunning-cases/loanengineweb.v1.dunningcases.notifications.indexoperation.md): Returns the notifications related to a dunning case.

### Retrieve a dunning case

 - [GET /v1/dunning_cases/{dunning_case_id}](https://docs.solarisgroup.com/api-reference/lending/loans/loan-dunning-cases/loanengineweb.v1.dunningcases.showoperation.md): Returns the dunning case with the ID specified in the request URL.

### Index dunning cases

 - [GET /v1/dunning_cases](https://docs.solarisgroup.com/api-reference/lending/loans/loan-dunning-cases/loanengineweb.v1.dunningcases.indexoperation.md): Returns an array containing all the dunning cases for all of your customers.

## Consumer Loan

### Create anonymous loan offer

 - [POST /v1/anonymous_consumer_loan_offers](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.anonymousoffers.createoperation.md): Generates a non-binding anonymous loan offer for a customer based on their self-declared and unverified financial information.

### Retrieve two thirds rates

 - [GET /v1/consumer_loans/two_thirds_rates](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.partners.showtwothirdsratesoperation.md): Returns the 2/3 interest rate for different loan terms for an anonymous loan offer.

### Create consumer loan application

 - [POST /v1/persons/{person_id}/consumer_loan_applications](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.applications.createoperation.md): Creates a consumer loan application and assigns it to the person with the person_id specified in the request URL. The payload of the request 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.

### Retrieve consumer loan application

 - [GET /v1/persons/{person_id}/consumer_loan_applications/{application_id}](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.applications.showoperation.md): Returns the current status and details of an existing consumer loan application. Additionally, you can subscribe to the webhook event CONSUMER_LOAN_APPLICATION to receive status updates on the application.

### Skip the account snapshot process for a consumer loan application

 - [PUT /v1/persons/{person_id}/consumer_loan_applications/{application_id}/skip_account_snapshot](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.applications.skipaccountsnapshotoperation.md): Skips the processing of an account snapshot in relation to the consumer loan application specified in the request URL.

### Link an account snapshot to a consumer loan application

 - [PUT /v1/persons/{person_id}/consumer_loan_applications/{application_id}/account_snapshot](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.applications.linkaccountsnapshotoperation.md): Links a customer's account snapshot to their consumer loan application. You must include the account_snapshot_id in the request body. This call triggers the credit scorer to complete the final verification step.

### Upload the purchase contract related to the financed good

 - [PUT /v1/persons/{person_id}/consumer_loan_applications/{application_id}/upload_purchase_contract](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.applications.uploadpurchasecontractoperation.md): Uploads the purchase contract of the financed good purchased with the loan. You must include the details of the signature position in the payload.

### Generate a subsidized offer for a consumer loan

 - [POST /v1/persons/{person_id}/consumer_loan_applications/{application_id}/offers/{offer_id}/subsidize](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.applications.createsubsidizedofferoperation.md): Creates a subsidized loan offer with a reduced interest rate from the original offer. You must add the required interest rate in the request body to receive the new offer.

### Download the pre-contractual information for consumer loan

 - [GET /v1/persons/{person_id}/consumer_loan_applications/{application_id}/offers/{offer_id}/pre_contract](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.applications.downloadofferprecontractoperation.md): Downloads a SECCI form as a PDF, which is the overview of the final offer and the contract. You must share it with the customer to review it prior to the identification and e-signing process.

### Download the final contract for a consumer loan

 - [GET /v1/persons/{person_id}/consumer_loan_applications/{application_id}/offers/{offer_id}/contract](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.applications.downloadoffercontractoperation.md): Generates the final contract for a consumer loan, which the customer must e-sign during the identification and e-signing process.

### Create a consumer loan

 - [PUT /v1/persons/{person_id}/consumer_loan_applications/{application_id}/consumer_loan](https://docs.solarisgroup.com/api-reference/lending/loans/consumer-loan/consumerloanweb.v1.applications.createloanoperation.md): Creates a loan and issues the loan payout to the customer's specified IBAN. The status of the consumer loan application will change to loan_created after calling this endpoint.

