Peach Finance

https://docs.peachfinance.com/
Admin
Peach Finance is a comprehensive REST API platform for financial services including loan management,...
Tokens:296,640
Snippets:2,979
Trust Score:8.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example API Request with Authentication

Source: https://docs.peachfinance.com/data-reporting/direct-api-access.md

This cURL example demonstrates how to make a GET request to retrieve loan details, including the required API key in the header.

```curl
curl --request GET \
  --url 'https://api.peachfinance.com/v1/people/{personId}/loans/{loanId}' \
  --header 'X-API-KEY: your_api_key_here'
```

--------------------------------

### Make a request using an API Key

Source: https://docs.peachfinance.com/developer-tools/using-versions.md

This example shows how to make a GET request to the /api/people endpoint using an API key. The API version used will be the one associated with the provided API key.

```shell
# The request is handled with the API Version associated with the API Key `5be....572`
curl --request GET --url https://api.peach.finance/api/people \
    --header 'X-API-KEY: 5be....572'
```

--------------------------------

### Make a request specifying an API Version header

Source: https://docs.peachfinance.com/developer-tools/using-versions.md

This example demonstrates how to make a GET request to the /api/people endpoint while explicitly specifying the API version using the 'Peach-Version' header. This overrides the version associated with the API key.

```shell
# The request is handled with the API Version associated with the API Key `5be....572`
curl --request GET --url https://api.peach.finance/api/people \
    --header 'Peach-Version: 2023-11-29' \
    --header 'X-API-KEY: 5be....572'
```

--------------------------------

### Install DuckDB CLI on Windows

Source: https://docs.peachfinance.com/release-notes/change-notices/replica-v3-migration-guide.md

Install the DuckDB CLI on Windows using winget or by downloading the executable directly from the releases page.

```shell
# Using winget
winget install DuckDB.cli

# Or download directly from:
# https://github.com/duckdb/duckdb/releases/latest
```

--------------------------------

### Install DuckDB CLI on macOS

Source: https://docs.peachfinance.com/data-reporting/data-delivery-setup.md

Install the DuckDB command-line interface using Homebrew.

```shell
# Using Homebrew
brew install duckdb
```

--------------------------------

### Install Snowflake Connector for Python

Source: https://docs.peachfinance.com/data-reporting/snowflake-reader-accounts.md

Install the necessary Python library to interact with Snowflake. This is required before running connection tests.

```shell
pip install snowflake-connector-python
```

--------------------------------

### Start credit reporting

Source: https://docs.peachfinance.com/api-docs/api-public

Sets the starting date to begin reporting credit history for the loan.

```APIDOC
## POST /people/{personId}/loans/{loanId}/credit-reporting

### Description
Sets the starting date to begin reporting credit history for the loan.

### Method
POST

### Endpoint
/people/{personId}/loans/{loanId}/credit-reporting
```

--------------------------------

### Verify DuckDB CLI Installation

Source: https://docs.peachfinance.com/data-reporting/data-delivery-setup.md

Check if the DuckDB CLI is installed correctly by displaying its version.

```shell
duckdb --version
```

--------------------------------

### Example S3 Delivery Path

Source: https://docs.peachfinance.com/data-reporting/data-delivery-setup.md

A concrete example of a data file's path within an S3 bucket, following the specified prefix and partitioning structure.

```text
s3://your-data-lake/vendor/peach/transactions/year=2026/month=04/day=03/hour=12/batch=202604031200/0000.parquet
```

--------------------------------

### Start Verification

Source: https://docs.peachfinance.com/api-docs/api-public

Initiates a borrower verification session. This endpoint starts a flow where an agent asks questions to verify a human's identity as the borrower.

```APIDOC
## POST /people/{personId}/verifications

### Description
Starts a borrower verification session. Newly created verifications include randomly selected questions about the borrower.

### Method
POST

### Endpoint
/people/{personId}/verifications

### Query Parameters
#### dryRun (boolean) - Optional - If true, checks if a verification can be started without actually starting one.
```

--------------------------------

### Create an Installment Loan

Source: https://docs.peachfinance.com/loan-lifecycle/quickstart.md

Initiate a new installment loan with specified terms and details. This call requires your API key and the borrower's person ID.

```APIDOC
## POST /api/people/{personId}/loans

### Description
Creates a new installment loan with specified financial terms and borrower information.

### Method
POST

### Endpoint
/api/people/{personId}/loans

### Parameters
#### Path Parameters
- **personId** (string) - Required - The unique identifier of the person (borrower) to whom the loan will be associated.

#### Request Body
- **loanTypeId** (string) - Required - The ID of the loan type configuration.
- **externalId** (string) - Required - A unique external identifier for the loan.
- **type** (string) - Required - The type of loan, e.g., "installment".
- **servicedBy** (string) - Required - Indicates who services the loan, e.g., "creditor".
- **status** (string) - Required - The initial status of the loan, e.g., "originated".
- **assetType** (string) - Required - The type of asset, e.g., "personalClosedEndUnsecured".
- **mainBorrowerId** (string) - Required - The ID of the main borrower.
- **newDrawsAllowed** (boolean) - Required - Indicates if new draws are permitted.
- **atOrigination** (object) - Required - Details about the loan at the time of origination.
  - **amountFinanced** (number) - Required - The total amount financed.
  - **principalAmount** (number) - Required - The principal amount of the loan.
  - **duration** (number) - Required - The loan term in months.
  - **paymentFrequency** (string) - Required - The frequency of payments, e.g., "monthly".
  - **originationLicense** (string) - Required - The origination license identifier.
  - **originatingCreditorName** (string) - Required - The name of the originating creditor.
  - **interestRates** (array) - Required - A list of interest rate objects.
    - **interestType** (string) - Required - The type of interest, e.g., "absolute".
    - **days** (number) - Optional - Number of days for the rate.
    - **rate** (number) - Required - The interest rate (e.g., 0.05 for 5%).
  - **specificDays** (array) - Required - Specific days for payments, e.g., [15].
  - **fees** (object) - Required - Fee details.
    - **originationFeeAmount** (number) - Required - The amount of the origination fee.

### Request Example
```json
{
  "loanTypeId": "LT-8765-4321",
  "externalId": "LOAN-12345", 
  "type": "installment",
  "servicedBy": "creditor",
  "status": "originated",
  "assetType": "personalClosedEndUnsecured",
  "mainBorrowerId": "BO-1234-5678",
  "newDrawsAllowed": false,
  "atOrigination": {
    "amountFinanced": 10000,
    "principalAmount": 10000,
    "duration": 36,
    "paymentFrequency": "monthly",
    "originationLicense": "stateLicense",
    "originatingCreditorName": "Sample Bank",
    "interestRates": [
      {
        "interestType": "absolute",
        "days": null,
        "rate": 0.05
      }
    ],
    "specificDays": [15],
    "fees": {
      "originationFeeAmount": 100
    }
  }
}
```

### Response
#### Success Response (200)
- **loanId** (string) - The unique identifier for the newly created loan.
- **status** (string) - The current status of the loan.
- **type** (string) - The type of the loan.

#### Response Example
```json
{
  "status": 200,
  "data": {
    "loanId": "LN-9876-5432",
    "status": "originated",
    "type": "installment"
  }
}
```
```

--------------------------------

### Get webhooks

Source: https://docs.peachfinance.com/api-docs/api-public

Retrieves a list of all configured webhooks.

```APIDOC
## GET /webhooks

### Description
Retrieves a list of all configured webhooks.

### Method
GET

### Endpoint
/webhooks
```

--------------------------------

### get /keys

Source: https://docs.peachfinance.com/api-docs

Retrieves a list of API keys.

```APIDOC
## GET /keys

### Description
Retrieves a list of all API keys associated with the account.

### Method
GET

### Endpoint
/keys
```

--------------------------------

### Get a Specific Installment Advance

Source: https://docs.peachfinance.com/api-docs

Retrieves details of a specific installment advance.

```APIDOC
## GET /people/{personId}/loans/{loanId}/advances/{advanceId}

### Description
Retrieves details of a specific installment advance.

### Method
GET

### Endpoint
/people/{personId}/loans/{loanId}/advances/{advanceId}

#### Path Parameters
- **personId** (string) - Required - The ID of the person.
- **loanId** (string) - Required - The ID of the loan.
- **advanceId** (string) - Required - The ID of the advance.
```

--------------------------------

### SFTP Configuration Example

Source: https://docs.peachfinance.com/credit-reporting/credit-agency-setup.md

Configuration for SFTP server details, including hostname, username, and password or key-based authentication.

```json
{
  "sftpHostname": "sftp.example.com:22",
  "sftpUsername": "myuser",
  "sftpPassword": "encrypted_password",
  "sftpAccessMethod": "usernamePassword",
  "sftpCdDir": "/upload/path"
}
```

```json
{
  "sftpHostname": "sftp.example.com:22",
  "sftpUsername": "myuser",
  "sftpAccessMethod": "keys",
  "sftpSSHPeachPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAA...",
  "sftpSSHPeachPrivateKey": "-----BEGIN OPENSSH PRIVATE KEY-----\n...
-----END OPENSSH PRIVATE KEY-----",
  "copyKeysFrom": "equifax"
}
```

--------------------------------

### Jinja Template Example

Source: https://docs.peachfinance.com/api-docs/api-public

Illustrates a basic Jinja template with dynamic fields.

```jinja
Hello {{foo}}, your loan is due on {{bar}}.
```

--------------------------------

### Get Installment Advances for a Loan

Source: https://docs.peachfinance.com/api-docs

Retrieves a list of installment advances for a specific loan.

```APIDOC
## GET /people/{personId}/loans/{loanId}/advances

### Description
Retrieves a list of installment advances for a specific loan.

### Method
GET

### Endpoint
/people/{personId}/loans/{loanId}/advances

#### Path Parameters
- **personId** (string) - Required - The ID of the person.
- **loanId** (string) - Required - The ID of the loan.
```

--------------------------------

### S3 File Path Structure Example

Source: https://docs.peachfinance.com/data-reporting/data-delivery-setup.md

Illustrates the expected file organization for data delivered to an S3 bucket, including table name and date-based partitioning.

```text
s3://<your-bucket>/<prefix>/table_name/year=YYYY/month=MM/day=DD/hour=HH/batch=ID/file.parquet
```

--------------------------------

### Change installment loan terms SCRA

Source: https://docs.peachfinance.com/api-docs/api-public/scra

Modifies the start date or end date of a single SCRA interest rate (interestType=AbsoluteScra). Only applicable to installment loans. If the SCRA start date is in the past, this will replay the loan.

```APIDOC
## PUT /people/{personId}/loans/{loanId}/payment-plan-scra

### Description
Modifies the start date or end date of a single SCRA interest rate (interestType=AbsoluteScra). Only applicable to installment loans. If the SCRA start date is in the past, this will replay the loan.

### Method
PUT

### Endpoint
/people/{personId}/loans/{loanId}/payment-plan-scra

### Parameters
#### Path Parameters
- **personId** (string) - Required - The ID of the person.
- **loanId** (string) - Required - The ID of the loan.

#### Request Body
- **startDate** (string) - Optional - The new start date of the SCRA period.
- **endDate** (string) - Optional - The new end date of the SCRA period.

### Response
#### Success Response (200)
- The response indicates successful modification of SCRA terms.
```

--------------------------------

### Create Template Version with Activation

Source: https://docs.peachfinance.com/api-docs/api-public

Example of creating and activating a new template version in a single API call. This requires additional permissions.

```json
{
  "activate": true
}
```

--------------------------------

### GET /companies/{companyId}/auth/saml/help

Source: https://docs.peachfinance.com/api-docs/api-public

Display IdP setup help.

```APIDOC
## GET /companies/{companyId}/auth/saml/help

### Description
Display IdP setup help.

### Method
GET

### Endpoint
/companies/{companyId}/auth/saml/help

#### Path Parameters
- **companyId** (string) - Required - The ID of the company.
```

--------------------------------

### Delete installment loan terms SCRA

Source: https://docs.peachfinance.com/api-docs/api-public/scra

Removes a single SCRA interest rate (interestType=AbsoluteScra) on an installment loan. If the SCRA start date is in the past, this will replay the loan.

```APIDOC
## DELETE /people/{personId}/loans/{loanId}/payment-plan-scra

### Description
Removes a single SCRA interest rate (interestType=AbsoluteScra) on an installment loan. If the SCRA start date is in the past, this will replay the loan.

### Method
DELETE

### Endpoint
/people/{personId}/loans/{loanId}/payment-plan-scra

### Parameters
#### Path Parameters
- **personId** (string) - Required - The ID of the person.
- **loanId** (string) - Required - The ID of the loan.

### Response
#### Success Response (200)
- The response indicates successful deletion of SCRA terms.
```

--------------------------------

### Get all advances for a loan

Source: https://docs.peachfinance.com/api-docs/api-public

Retrieves a list of all installment advances associated with a specific loan.

```APIDOC
## GET /people/{personId}/loans/{loanId}/advances

### Description
Returns an installment loan's advances.

### Method
GET

### Endpoint
/people/{personId}/loans/{loanId}/advances
```

--------------------------------

### Launch DuckDB CLI

Source: https://docs.peachfinance.com/data-reporting/data-delivery-setup.md

Start the DuckDB CLI, optionally specifying a database file for persistence.

```shell
# Start with an in-memory database (temporary)
duckdb

# Or create/open a persistent database file
duckdb mydata.db
```

--------------------------------

### Get a specific advance by ID

Source: https://docs.peachfinance.com/api-docs/api-public

Retrieves details of a specific installment advance using its unique identifier.

```APIDOC
## GET /people/{personId}/loans/{loanId}/advances/{advanceId}

### Description
Returns an installment loan advance by its ID.

### Method
GET

### Endpoint
/people/{personId}/loans/{loanId}/advances/{advanceId}
```

--------------------------------

### Rendered Template Example

Source: https://docs.peachfinance.com/api-docs/api-public

Displays the output after rendering a Jinja template with provided context.

```text
Hello John, your loan is due on 2021-01-01.
```

--------------------------------

### Encryption Configuration Example

Source: https://docs.peachfinance.com/credit-reporting/credit-agency-setup.md

Configuration for PGP encryption, specifying the encryption method and the public key.

```json
{
  "encryptionMethod": "GPG",
  "publicKey": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n...
-----END PGP PUBLIC KEY BLOCK-----"
}
```

--------------------------------

### GET /auth/permissions

Source: https://docs.peachfinance.com/api-docs/api-public

Get all permissions for the requesting user.

```APIDOC
## GET /auth/permissions

### Description
Get all permissions for the requesting user.

### Method
GET

### Endpoint
/auth/permissions
```

--------------------------------

### Create Database from Snowflake Share

Source: https://docs.peachfinance.com/data-reporting/snowflake-direct-share.md

Use this SQL command to create a local database from the provided Snowflake share. Ensure you replace placeholders with your actual account and share names.

```sql
CREATE DATABASE PEACH_SHARED_DB FROM SHARE
<peach_provider_account>.<share_name>;
```

--------------------------------

### Update an Installment Advance

Source: https://docs.peachfinance.com/api-docs

Updates an existing installment advance.

```APIDOC
## PUT /people/{personId}/loans/{loanId}/advances/{advanceId}

### Description
Updates an existing installment advance.

### Method
PUT

### Endpoint
/people/{personId}/loans/{loanId}/advances/{advanceId}

#### Path Parameters
- **personId** (string) - Required - The ID of the person.
- **loanId** (string) - Required - The ID of the loan.
- **advanceId** (string) - Required - The ID of the advance.
```

--------------------------------

### Create Webhook Subscription

Source: https://docs.peachfinance.com/payments/peach-processing.md

Configure your endpoint to receive real-time payment events by creating a webhook subscription. Specify event types and the webhook URL.

```bash
POST /api/webhooks
X-API-KEY: YOUR_API_KEY
Content-Type: application/json

{
 "webhookType": "direct",
 "eventTypes": [
   "payment.initiated",
   "payment.succeeded"
 ],
 "enabled": true,
 "hydrateData": false,
 "webhookDirectDetails": {
   "webhookUrl": "https://api.example.com/webhooks/peach-finance
"
 }
}
```

--------------------------------

### Set Up Webhooks

Source: https://docs.peachfinance.com/payments/byob-processing.md

Configures webhooks to receive real-time payment status notifications. This allows for immediate updates on payment initiation and success.

```APIDOC
## POST /api/webhooks

### Description
Configures webhooks to receive real-time payment status notifications. This allows for immediate updates on payment initiation and success.

### Method
POST

### Endpoint
/api/webhooks

### Parameters
#### Request Body
- **webhookType** (string) - Required - The type of webhook (e.g., "direct").
- **eventTypes** (array) - Required - A list of event types to subscribe to (e.g., ["payment.initiated", "payment.succeeded"]).
- **enabled** (boolean) - Required - Whether the webhook is enabled.
- **hydrateData** (boolean) - Required - Whether to include full data in webhook payloads.
- **webhookDirectDetails** (object) - Required - Details for direct webhooks.
  - **webhookUrl** (string) - Required - The URL to send webhook notifications to.
```

--------------------------------

### Install DuckDB Python Package

Source: https://docs.peachfinance.com/data-reporting/data-delivery-setup.md

Install the DuckDB Python integration package using pip.

```shell
pip install duckdb
```

--------------------------------

### Create Payment Processor

Source: https://docs.peachfinance.com/payments/byob-processing.md

Configures your payment processor details. This example creates a draft payment processor that can handle ACH payments.

```APIDOC
## POST /api/payment-processors

### Description
Configures your payment processor details. This example creates a draft payment processor that can handle ACH payments.

### Method
POST

### Endpoint
/api/payment-processors

### Parameters
#### Request Body
- **processorName** (string) - Required - The name of the payment processor.
- **processorType** (string) - Required - The type of the payment processor (e.g., "achDirectUS").
- **status** (string) - Required - The status of the payment processor (e.g., "draft").
- **paymentTypes** (array) - Required - A list of payment types supported (e.g., ["ach"]).
- **timezone** (string) - Required - The timezone for the processor (e.g., "America/Los_Angeles").
- **isDefault** (boolean) - Required - Whether this is the default processor.
- **achCutoff** (string) - Optional - The ACH cutoff time (e.g., "16:00:00").
- **achSameDayCutoff** (string) - Optional - The ACH same-day cutoff time (e.g., "10:30:00").
- **achFileHeaderImmediateDestination** (string) - Optional - Immediate destination for ACH file header.
- **achFileHeaderImmediateOrigin** (string) - Optional - Immediate origin for ACH file header.
- **achFileHeaderImmediateDestinationName** (string) - Optional - Name of the immediate destination for ACH file header.
- **achFileHeaderImmediateOriginName** (string) - Optional - Name of the immediate origin for ACH file header.
- **achBatchHeaderCompanyName** (string) - Optional - Company name for ACH batch header.
- **achBatchHeaderCompanyId** (string) - Optional - Company ID for ACH batch header.
- **achBatchHeaderOriginatingDFIId** (string) - Optional - Originating DFI ID for ACH batch header.
- **achFeeType** (string) - Optional - The type of ACH fee (e.g., "net").
- **achFeeAmount** (number) - Optional - The amount of the ACH fee.
- **achSameDayFeeAmount** (number) - Optional - The amount of the ACH same-day fee.
- **achSECCode** (string) - Optional - The ACH SEC code (e.g., "PPD").
- **sftpAccessMethod** (string) - Optional - The SFTP access method (e.g., "usernamePassword").
- **sftpHostname** (string) - Optional - The SFTP hostname.
- **sftpUsername** (string) - Optional - The SFTP username.
- **sftpPassword** (string) - Optional - The SFTP password.
- **sftpAchConfirmationFileNameRegex** (string) - Optional - Regex for ACH confirmation file name.
- **sftpAchReturnFileNameRegex** (string) - Optional - Regex for ACH return file name.
- **isFileNameDefaultConvention** (boolean) - Optional - Whether to use the default file name convention.
- **signOutgoing** (boolean) - Optional - Whether to sign outgoing files.
- **externalId** (string) - Optional - An external ID for the processor.

### Request Example
```json
{
 "processorName": "ACH Direct Processor",
 "processorType": "achDirectUS",
 "status": "draft",
 "paymentTypes": [
   "ach"
 ],
 "timezone": "America/Los_Angeles",
 "isDefault": false,
  "achCutoff": "16:00:00",
 "achSameDayCutoff": "10:30:00",
 "achFileHeaderImmediateDestination": "123456789",
 "achFileHeaderImmediateOrigin": "987654321",
 "achFileHeaderImmediateDestinationName": "RECEIVING BANK",
 "achFileHeaderImmediateOriginName": "ORIGINATING COMPANY",
 "achBatchHeaderCompanyName": "ACME LENDING",
 "achBatchHeaderCompanyId": "1234567890",
 "achBatchHeaderOriginatingDFIId": "12345678",
 "achFeeType": "net",
 "achFeeAmount": 0.25,
 "achSameDayFeeAmount": 1.50,
 "achSECCode": "PPD",
  "sftpAccessMethod": "usernamePassword",
 "sftpHostname": "test.rebex.net",
 "sftpUsername": "demo",
 "sftpPassword": "password",
 "sftpAchConfirmationFileNameRegex": "ACH_CONF_\\d{8}\\.txt",
 "sftpAchReturnFileNameRegex": "ACH_RETURN_\\d{8}\\.txt",
  "isFileNameDefaultConvention": true,
 "signOutgoing": false,
 "externalId": "PROC-ACH-001"
}
```

### Response
#### Success Response (200)
- **createdAt** (string) - The timestamp when the payment processor was created.
- **updatedAt** (string) - The timestamp when the payment processor was last updated.
- **deletedAt** (null) - Indicates if the payment processor has been deleted.
- **id** (string) - The unique identifier for the payment processor.
- **object** (string) - The type of object, "paymentProcessor".
- **externalId** (string) - The external ID of the payment processor.
- **companyId** (string) - The ID of the company associated with the processor.
- **paymentTypes** (array) - A list of payment types supported.
- **processorType** (string) - The type of the payment processor.
- **processorName** (string) - The name of the payment processor.
- **status** (string) - The status of the payment processor.
- **isDefault** (boolean) - Whether this is the default processor.
- **isSettlementRequired** (boolean) - Whether settlement is required.
- **isFileNameDefaultConvention** (boolean) - Whether the default file name convention is used.
- **signOutgoing** (boolean) - Whether outgoing files are signed.
- **sftpAccessMethod** (string) - The SFTP access method.
- **timezone** (string) - The timezone for the processor.
- **achFileHeaderImmediateDestination** (string) - Immediate destination for ACH file header.
- **achFileHeaderImmediateDestinationName** (string) - Name of the immediate destination for ACH file header.
- **achFileHeaderImmediateOrigin** (string) - Immediate origin for ACH file header.
- **achFileHeaderImmediateOriginName** (string) - Name of the immediate origin for ACH file header.
- **achBatchHeaderCompanyName** (string) - Company name for ACH batch header.
- **achBatchHeaderCompanyId** (string) - Company ID for ACH batch header.
- **achBatchHeaderSettlementCompanyId** (null) - Settlement company ID for ACH batch header.
- **achBatchHeaderOriginatingDFIId** (string) - Originating DFI ID for ACH batch header.
- **achCutoff** (string) - The ACH cutoff time.
- **achSameDayCutoff** (string) - The ACH same-day cutoff time.
- **achFeeType** (string) - The type of ACH fee.
- **achFeeAmount** (number) - The amount of the ACH fee.
- **achSameDayFeeAmount** (number) - The amount of the ACH same-day fee.
- **sftpHostname** (string) - The SFTP hostname.
- **sftpUsername** (string) - The SFTP username.
- **sftpPassword** (string) - The SFTP password.
- **sftpCdDirInbox** (null) - SFTP CD directory for inbox.
- **sftpCdDirOutbox** (null) - SFTP CD directory for outbox.
- **sftpAchConfirmationFileNameRegex** (string) - Regex for ACH confirmation file name.
- **sftpAchReturnFileNameRegex** (string) - Regex for ACH return file name.
- **encryptionMethodOutgoing** (null) - Encryption method for outgoing data.
- **encryptionMethodIncoming** (null) - Encryption method for incoming data.
- **peachPublicKey** (null) - Peach's public key.
- **peachPrivateKey** (null) - Peach's private key.
- **thirdPartyPublicKey** (null) - Third-party public key.
- **sftpSSHPeachPublicKey** (null) - SFTP SSH Peach public key.
- **sftpSSHPeachPrivateKey** (null) - SFTP SSH Peach private key.
- **sftpSSHDisabledAlgorithms** (null) - Disabled algorithms for SFTP SSH.
- **achSECCode** (string) - The ACH SEC code.
- **confirmFileUpload** (boolean) - Whether to confirm file uploads.
- **isDebugLogging** (boolean) - Whether debug logging is enabled.
- **fundingInstruments** (array) - List of funding instruments.

### Response Example
```json
{
    "status": 200,
    "data": {
        "createdAt": "2025-03-05T20:49:27.619038+00:00",
        "updatedAt": "2025-03-05T20:49:27.619047+00:00",
        "deletedAt": null,
        "id": "PP-G2K6-VB45",
        "object": "paymentProcessor",
        "externalId": "PROC-ACH-001",
        "companyId": "CP-L9BN-5J52",
        "paymentTypes": [
            "ach"
        ],
        "processorType": "achDirectUS",
        "processorName": "ACH Direct Processor",
        "status": "draft",
        "isDefault": false,
        "isSettlementRequired": false,
        "isFileNameDefaultConvention": true,
        "signOutgoing": false,
        "sftpAccessMethod": "usernamePassword",
        "timezone": "America/Los_Angeles",
        "achFileHeaderImmediateDestination": "123456789",
        "achFileHeaderImmediateDestinationName": "RECEIVING BANK",
        "achFileHeaderImmediateOrigin": "987654321",
        "achFileHeaderImmediateOriginName": "ORIGINATING COMPANY",
        "achBatchHeaderCompanyName": "ACME LENDING",
        "achBatchHeaderCompanyId": "1234567890",
        "achBatchHeaderSettlementCompanyId": null,
        "achBatchHeaderOriginatingDFIId": "12345678",
        "achCutoff": "16:00:00",
        "achSameDayCutoff": "10:30:00",
        "achFeeType": "net",
        "achFeeAmount": 0.25,
        "achSameDayFeeAmount": 1.5,
        "sftpHostname": "test.rebex.net",
        "sftpUsername": "demo",
        "sftpPassword": "cv4bhluj8mqs73bpp30g",
        "sftpCdDirInbox": null,
        "sftpCdDirOutbox": null,
        "sftpAchConfirmationFileNameRegex": "ACH_CONF_\\d{8}\\.txt",
        "sftpAchReturnFileNameRegex": "ACH_RETURN_\\d{8}\\.txt",
        "encryptionMethodOutgoing": null,
        "encryptionMethodIncoming": null,
        "peachPublicKey": null,
        "peachPrivateKey": null,
        "thirdPartyPublicKey": null,
        "sftpSSHPeachPublicKey": null,
        "sftpSSHPeachPrivateKey": null,
        "sftpSSHDisabledAlgorithms": null,
        "achSECCode": "PPD",
        "confirmFileUpload": true,
        "isDebugLogging": false,
        "fundingInstruments": []
    }
}
```
```

--------------------------------

### Autopay Setup Response

Source: https://docs.peachfinance.com/payments/peach-processing.md

This response shows the details of a created autopay schedule, including the autopay ID, payment schedule, and potential savings. The schedule may contain more entries than shown.

```json
{
  "status": 200,
  "data": {
    "id": "AP-VK2O-3QVB",
    "isLocked": false,
    "createdAt": "2025-03-05T22:37:18.473196+00:00",
    "type": "statementMinimumAmount",
    "extraAmount": 0,
    "isAlignedToDueDates": true,
    "paymentFrequency": "monthly",
    "specificDays": [
      15
    ],
    "paymentInstrumentId": "PT-OB5R-M8QJ",
    "agreementDocumentId": null,
    "schedule": [
      {
        "ids": [
          "AE-KGLQ-E7LB",
          "AE-BW14-LYMK"
        ],
        "amount": 415.25,
        "baseAmount": 0.0,
        "originalAmount": 415.25,
        "originalDate": null,
        "date": "2025-03-06",
        "interestAmount": 0,
        "interestBeforeDiscountAmount": 0,
        "paymentType": "periodicPayment",
        "principalAmount": 0,
        "status": "booked",
        "individualEntries": [
          {
            "date": "2025-03-06",
            "id": "AE-KGLQ-E7LB",
            "periodId": "PE-BM81-7V7V",
            "paymentType": "periodicPayment",
            "status": "booked",
            "amount": 315.25,
            "baseAmount": null,
            "originalAmount": 315.25,
            "originalDate": null,
            "principalAmount": 0.0,
            "interestAmount": 0.0,
            "interestBeforeDiscountAmount": 0.0,
            "dynamicFeeDetails": {
              "loanFeeId": null,
              "dynamicFeeTypeId": null,
              "apiName": null,
              "displayName": null
            },
            "specialFlag": null
          },
          {
            "date": "2025-03-06",
            "id": "AE-BW14-LYMK",
            "periodId": "PE-BM81-7V7V",
            "paymentType": "originationFee",
            "status": "booked",
            "amount": 100.0,
            "baseAmount": null,
            "originalAmount": 100.0,
            "originalDate": null,
            "principalAmount": null,
            "interestAmount": null,
            "interestBeforeDiscountAmount": null,
            "dynamicFeeDetails": {
              "loanFeeId": null,
              "dynamicFeeTypeId": null,
              "apiName": null,
              "displayName": null
            },
            "specialFlag": null
          }
        ]
      },
      {
        "ids": [
          "AE-KEY3-V77B"
        ],
        "amount": 315.25,
        "baseAmount": 0.0,
        "originalAmount": 315.25,
        "originalDate": null,
        "date": "2025-03-15",
        "interestAmount": 0,
        "interestBeforeDiscountAmount": 0,
        "paymentType": "periodicPayment",
        "principalAmount": 0,
        "status": "booked",
        "individualEntries": [
          {
            "date": "2025-03-15",
            "id": "AE-KEY3-V77B",
            "periodId": "PE-KG8Y-131E",
            "paymentType": "periodicPayment",
            "status": "booked",
            "amount": 315.25,
            "baseAmount": null,
            "originalAmount": 315.25,
            "originalDate": null,
            "principalAmount": 0.0,
            "interestAmount": 0.0,
            "interestBeforeDiscountAmount": 0.0,
            "dynamicFeeDetails": {
              "loanFeeId": null,
              "dynamicFeeTypeId": null,
              "apiName": null,
              "displayName": null
            },
            "specialFlag": null
          }
        ]
      }
    ],
    "deltaTerms": {
      "deltaInterestAmount": -659.15,
      "deltaFeeAmount": 0,
      "deltaDurationDays": -61,
      "deltaDueDatesNumber": -2
    },
    "offsetFromDueDate": null
  }
}
```

--------------------------------

### Create an Installment Advance for a Loan

Source: https://docs.peachfinance.com/api-docs

Creates a new installment advance for a specific loan. Advances increase the principal balance of a Loan.

```APIDOC
## POST /people/{personId}/loans/{loanId}/advances

### Description
Creates a new installment advance for a specific loan. Advances increase the principal balance of a Loan.

### Method
POST

### Endpoint
/people/{personId}/loans/{loanId}/advances

#### Path Parameters
- **personId** (string) - Required - The ID of the person.
- **loanId** (string) - Required - The ID of the loan.
```

--------------------------------

### POST /communicator/render

Source: https://docs.peachfinance.com/api-docs/api-public

Renders a file (text, html, or pdf) from a template and prepares it for download. It selects an appropriate Template Descriptor and renders the active Template Version with the given context. Only the content matching the `fmt` query parameter is returned.

```APIDOC
## POST /communicator/render

### Description
Render a file (text, html or pdf) from template and download it. It selects an appropriate Template Descriptor (matching subject, channel), and renders the active Template Version with the given context. Only the content matching the `fmt` query parameter is returned in the file. The rendered template file is then downloaded as an attachment.

### Method
POST

### Endpoint
/communicator/render

### Query Parameters
- **fmt** (string) - Required - The format of the file to render (e.g., text, html, pdf).

### Parameters
#### Request Body
- **context** (object) - Required - The context for rendering the template.
- **subject** (string) - Required - The subject to match the template descriptor.
- **channel** (string) - Required - The channel to match the template descriptor.

### Response
#### Success Response (200)
- **Content-Disposition** (string) - attachment - Indicates the file should be downloaded.
- **Content-Type** (string) - The MIME type of the rendered file.
```

--------------------------------

### GET /supercases/{supercaseId}/populations/draft

Source: https://docs.peachfinance.com/api-docs/api-public

Retrieves the draft population for a specific supercase. This endpoint is used to get the current draft population details.

```APIDOC
## GET /supercases/{supercaseId}/populations/draft

### Description
Gets the draft population for the specified supercase.

### Method
GET

### Endpoint
/supercases/{supercaseId}/populations/draft

### Parameters
#### Path Parameters
- **supercaseId** (string) - Required - The unique identifier for the supercase.
```

--------------------------------

### Render template version

Source: https://docs.peachfinance.com/api-docs/api-public

Renders a file (text, html, or pdf) from a Template Version and initiates a download. Only the content matching the `fmt` query parameter is returned.

```APIDOC
## POST /communicator/templates/{templateVersionId}/render

### Description
Render a file (text, html or pdf) from this Template Version and download it. Only the content matching the fmt query parameter is returned in the file. The rendered template file is then downloaded as an attachment.

### Method
POST

### Endpoint
/communicator/templates/{templateVersionId}/render

### Query Parameters
- **fmt** (string) - Required - The format of the content to render (e.g., text, html, pdf).
```

--------------------------------

### Get all loans associated with a company

Source: https://docs.peachfinance.com/api-docs/api-public/loans

Retrieves a list of all loans associated with the authenticated company. This endpoint is useful for getting an overview of all active loans.

```APIDOC
## GET /loans

### Description
Get all loans associated with a company.

### Method
GET

### Endpoint
/loans

### Parameters
#### Query Parameters
- **companyId** (string) - Required - The identifier of the company for which to retrieve loans.

### Response
#### Success Response (200)
- **loans** (array) - A list of loan objects.
  - **loanId** (string) - The unique identifier for the loan.
  - **borrowerId** (string) - The identifier of the main borrower.
  - **status** (string) - The current status of the loan (e.g., 'pending', 'originated').
  - **atOrigination** (object) - Details about the loan at the time of origination.
    - **interestRate** (number) - The interest rate at origination.
    - **term** (string) - The loan term (e.g., '30 years').
    - **paymentSchedule** (object) - The payment schedule details.
      - **dueDate** (string) - The next due date for the payment.
      - **amount** (number) - The amount due for the payment.

### Response Example
{
  "example": "{\"loans\": [{\"loanId\": \"ln_12345\", \"borrowerId\": \"br_67890\", \"status\": \"pending\", \"atOrigination\": {\"interestRate\": 5.5, \"term\": \"30 years\", \"paymentSchedule\": {\"dueDate\": \"2024-01-01\", \"amount\": 1200.50}}}]}"
}
```

--------------------------------

### Create installment loan terms SCRA

Source: https://docs.peachfinance.com/api-docs/api-public/scra

Creates a customer payment plan for the borrower in accordance with SCRA regulations. Only applicable to installment loans.

```APIDOC
## POST /people/{personId}/loans/{loanId}/payment-plan-scra

### Description
Creates a customer payment plan for the borrower in accordance with SCRA regulations. Only applicable to installment loans.

### Method
POST

### Endpoint
/people/{personId}/loans/{loanId}/payment-plan-scra

### Parameters
#### Path Parameters
- **personId** (string) - Required - The ID of the person.
- **loanId** (string) - Required - The ID of the loan.

#### Request Body
- **startDate** (string) - Required - The start date of the SCRA period.
- **endDate** (string) - Required - The end date of the SCRA period.
- **annualRate** (number) - Required - The annual interest rate during the SCRA period.
- **isCancelFees** (boolean) - Required - Indicates whether to cancel fees during the SCRA period.

### Response
#### Success Response (200)
- The response indicates successful creation of SCRA terms.
```

--------------------------------

### Installment Refunds

Source: https://docs.peachfinance.com/api-docs

Operations for managing installment refunds on loans. This includes creating full or partial refunds, which may also trigger reimbursements to the borrower.

```APIDOC
## Installment Refunds

This object represents refunds. Various situations require full or partial refunds of a loan. Depending on the refund amount and whether the borrower has made payments, a refund may also trigger a reimbursement to the borrower.

### Operations

- **GET** `/people/{personId}/loans/{loanId}/refunds`
- **POST** `/people/{personId}/loans/{loanId}/refunds`
- **POST** `/people/{personId}/loans/{loanId}/refunds-v2`
- **POST** `/people/{personId}/loans/{loanId}/refunds/{loanRefundId}/cancel`
```

--------------------------------

### Jinja Rendering Context Example

Source: https://docs.peachfinance.com/api-docs/api-public

Shows the JSON context object used to render a Jinja template.

```json
{
  "foo": "John",
  "bar": "2021-01-01"
}
```

--------------------------------

### GET /communicator/subjects/{subject}

Source: https://docs.peachfinance.com/api-docs/api-public

Get the descriptor for a specific Interaction Subject. Note that subject descriptors do not have an id field but are instead identified by their unique subject field.

```APIDOC
## GET /communicator/subjects/{subject}

### Description
Get the descriptor for a specific Interaction Subject. Note that subject descriptors do not have an id field but are instead identified by their unique subject field.

### Method
GET

### Endpoint
/communicator/subjects/{subject}

### Parameters
#### Path Parameters
- **subject** (string) - Required - The unique subject field of the interaction descriptor to retrieve.

### Response
#### Success Response (200)
- **subject** (string) - The name of the interaction subject.
- **description** (string) - A description of the interaction subject.

#### Response Example
{
  "subject": "paymentReminder",
  "description": "Reminders related to payments."
}
```

--------------------------------

### post /keys

Source: https://docs.peachfinance.com/api-docs

Creates a new API key.

```APIDOC
## POST /keys

### Description
Creates a new API key for managing access to the Peach Finance API.

### Method
POST

### Endpoint
/keys
```

--------------------------------

### Run Dataform Compilation and Execution

Source: https://docs.peachfinance.com/data-reporting/data-delivery-setup.md

Compiles Dataform definitions and then executes the data transformations. Ensure Dataform is installed and configured.

```shell
dataform compile
dataform run
```

--------------------------------

### Configure Autopay

Source: https://docs.peachfinance.com/payments/autopay.md

Finalizes the autopay setup by creating the autopay configuration using the previously created payment instrument and agreement document.

```APIDOC
## POST /people/{personId}/loans/{loanId}/autopay

### Description
Configures and finalizes the autopay settings for a specific loan.

### Method
POST

### Endpoint
/people/{personId}/loans/{loanId}/autopay

### Parameters
#### Path Parameters
- **personId** (string) - Required - The ID of the person.
- **loanId** (string) - Required - The ID of the loan for which to configure autopay.

#### Request Body
- **previewMode** (boolean) - Required - If true, the autopay will be set up in preview mode.
- **amountType** (string) - Required - Determines the amount to be paid automatically (e.g., "statementBalanceAmount", "statementMinimumAmount").
- **isAlignedToDueDates** (boolean) - Required - If true, autopay dates will align with loan due dates.
- **paymentInstrumentId** (string) - Required - The ID of the payment instrument to use for autopay.
- **agreementDocumentId** (string) - Required - The ID of the accepted autopay agreement document.

### Request Example
```json
{
  "previewMode": false,
  "amountType": "statementBalanceAmount",
  "isAlignedToDueDates": true,
  "paymentInstrumentId": "PT-9087-4563",
  "agreementDocumentId": "DD-5678-1234"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the details of the configured autopay.
  - **agreementDocumentId** (string) - The ID of the agreement document.
  - **paymentInstrumentId** (string) - The ID of the payment instrument.
  - **paymentFrequency** (string) - The frequency of payments (e.g., "monthly").
  - **schedule** (array) - An array of scheduled payment details.
    - **amount** (number) - The payment amount.
    - **date** (string) - The payment date.
    - **status** (string) - The status of the payment.
  - **type** (string) - The type of amount to be paid (matches `amountType` from request).
- **status** (integer) - The HTTP status code.

#### Response Example
```json
{
  "data": {
    "agreementDocumentId": "DD-5678-1234",
    "paymentInstrumentId": "PT-9087-4563",
    "paymentFrequency": "monthly",
    "schedule": [
      {
        "amount": 473.78,
        "date": "2022-10-15",
        "status": "booked"
      }
    ],
    "type": "statementBalanceAmount"
  },
  "status": 200
}
```
```

--------------------------------

### Credit Reporting Delete API Example

Source: https://docs.peachfinance.com/credit-reporting/account-status.md

Example of a POST request to the credit reporting delete endpoint, specifying an account status code for a charged-off account.

```json
POST /people/{personId}/loans/{loanId}/credit-reporting/{creditAgencyId}/delete
{
  "deletedReason": "other",
  "metro2": {
    "accountStatusCode": "97"
  }
}
```
Tokens:
Raw