> ## Documentation Index
> Fetch the complete documentation index at: https://getequity.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> For credit providers. Issue and service loans to GetEquity users against the investments they already hold, using their portfolio as collateral.

> [!NOTE]
>
> The Credit API is a separate product from the [Investments API](https://getequity.io/docs/api-reference/choosing-your-integration.md). It is for lending against portfolios held on GetEquity, not for distributing investments. You can integrate it on its own.

## Who this is for

You are a credit provider — a lender, a BNPL provider, a bank — and you want to extend credit to people who already hold investments on GetEquity.

You integrate as the **creditor**. The borrower is an existing GetEquity user who pledges their portfolio as collateral; you assess them, issue the loan, and collect repayment. GetEquity locks and releases the collateral on your behalf.

## How it works

**1. Agree your terms**

[Get Loan Configuration](https://getequity.io/docs/api-reference/endpoint/CreditLoan/get-loan-configuration.md) returns the configuration set up for your organisation — the loan-to-value ratio, interest and tenor you lend at.

**2. Assess the borrower**

[Get User by ID](https://getequity.io/docs/api-reference/endpoint/CreditLoan/get-user-by-id.md) returns their personal details and verification status. [Get User Investments](https://getequity.io/docs/api-reference/endpoint/CreditLoan/get-user-investments.md) returns the portfolio you would be lending against — equity, SAFE, debt and fixed-interest positions with their current value.

**3. Issue the loan**

[Create Loan](https://getequity.io/docs/api-reference/endpoint/CreditLoan/create-loan.md) issues it. The loan amount is calculated automatically from the collateral value against your configuration, and the collateral is locked at this point.

**4. Service it**

[Get Loans by Creditor](https://getequity.io/docs/api-reference/endpoint/CreditLoan/get-creditor-loans.md) lists your whole book; [Get Loan by ID](https://getequity.io/docs/api-reference/endpoint/CreditLoan/get-loan-by-id.md) fetches one. [Repay Loan](https://getequity.io/docs/api-reference/endpoint/CreditLoan/repay-loan.md) processes a repayment and releases collateral as the balance clears.

**5. Reconcile**

Listen for the `loan.created` and `loan.repaid` [webhook events](https://getequity.io/docs/api-reference/endpoint/Webhook/webhook.md) rather than polling.

## Key endpoints

* **Get Loan Configuration**: View the lending configuration for your organisation

* **Get User by ID**: Retrieve borrower details including personal information and verification status

* **Get User Investments**: Fetch a borrower's portfolio — equity, SAFE, debt and fixed-interest positions, with current value

* **Create Loan**: Issue a new loan against matched configuration

* **Get Loans by Creditor**: Monitor every loan you have issued

* **Get Loan by ID**: Fetch a single loan by its id

* **Repay Loan**: Process a repayment by loan ID and amount

> [card] Collateral is handled for you
>
> Loan amounts are calculated from collateral value against your configuration, and collateral is locked on issue and released on repayment. You do not manage the pledge yourself.

## Authentication

The Credit API uses the same organisation secret key as the rest of the GetEquity API.

```http theme={null}
Authorization: "Bearer YOUR_SECRET_KEY"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.