Forth, Inc

Forth Pay

This section contains any user guides specific to the Forth Credit feature.

User Guides

The Bulk APIs section makes handling large volumes of data faster and easier. Instead of processing records one by one, you can batch update or upload multiple entries in a single request—saving time and improving efficiency. Whether you&apos;re managing massive datasets or streamlining workflows, this functionality is built to optimize performance and keep operations running smoothly.

Bulk APIs

The Compliance section is here to help you stay on top of regulatory requirements with ease. Instead of navigating complex compliance rules on your own, this section gives you the tools and guidance to keep your projects aligned with industry standards. Whether it’s data security, financial regulations, or governance, it’s designed to make compliance feel less overwhelming, so you can focus on building with confidence.

Compliance

The Core Objects section is the backbone of customer management, handling everything from interactions and accounts to financial agreements. Whether you&apos;re managing contacts, companies, debts, documents, enrollments, loans, or settlement offers, this section keeps everything organized and accessible. It ensures smooth communication and tracking, helping you maintain clarity and efficiency in client-related activities.<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div>

Core Objects

The Lookups section is designed to make searching and managing predefined data effortless. Instead of manually keeping track of things like templates, hold reasons, types, subtypes, and statuses, this tool provides a structured way to retrieve and organize key reference information. Whether you need to pull status updates or filter through categories, everything is accessible exactly when you need it, keeping operations smooth and efficient.

Lookups

The Processing section keeps draft management and fee handling organized and hassle-free. Users can create, update, retrieve, or delete drafts, with the flexibility to activate, deactivate, or cancel them as needed. It also provides easy access to ACH credit fee information, enabling users to view and modify fees without having to dig through complicated records. Everything is designed to keep workflows efficient and structured.

Processing

The Reporting section offers users powerful insights into their transactions, clients, holds, debts, and settlements. With access to detailed reports and analytics, users can track performance, analyze trends, and make informed decisions to optimize their business operations. This functionality provides a clear and structured view of financial data, ensuring efficient management and strategic planning.

Reporting

Clixsign

This section contains a user guide specific to the Clixsign feature. Clixsign is Forth&apos;s proprietary electronic document signing platform. To enable this platform, please contact <a href="mailto:Support@setforth.com" target="_self">Support@setforth.com</a>.

This endpoint allows you to initiate the sending of a Clixsign document to a specified client. By providing the necessary documents and signer details, you can trigger the document delivery process efficiently.

Create Signing Request

Blank

Forth Pay API

Api-Key

Production

Sandbox

Activate Debit

Activate Fee

Activate Refund

Activate Settlement Payment

Add Bank Account

Add Comment

All Settlement Decisions by Date

Attach Settlement Letter

Bank Accounts

Cancel Enrollment

Cancel Unprocessed Debit

Cancel Unprocessed Fee

Cancel Unprocessed Refund

Cancel Unprocessed Settlement Payment

Client Balance Reports

Client Report

Clients on Gateway Hold

Request a Signature

Companies

Clients

Create ACH Credit Fee

Create Co-Applicant

Create Company

Create Client

Create Debit

Create Debt

Create Forth Pay Creditor

Create Forth Pay Portal User Account

Create ForthPay Creditor Address

Create Multiple Drafts / Debits

Create Performance Fee

Create Refund

Create Settlement

Create Settlement Payment

Creditors

Deactivate Debit

Deactivate Fee

Deactivate Refund

Deactivate Settlement Payment

Debits

Debts

Decisions

Delete Unprocessed Debit

Documents

Enroll Client

Enrolled Clients

Enrollment

Fees

Forth Pay API Workflow Guide

Forth Pay Quick Start Guide

Generate Account Closure Form

Generate Bank Change Document

Generate CAA Document

Generate Document Based on Lookup Key

Generate One Time Debit Document

Generate Risk Returns Form

Request Hold Release

Get Bank Account

Get All Companies

Payees

Get Payee

Update Payee

Get All Documents

Get Document

Upload Document

Graduate Enrollment

Pause Enrollment

Re-Enroll Client

Resume Enrollment

Get Client

Portal

Send Password Reset Email

Update Co-Applicant

Update Client

Get All Creditors

Get Creditor

Get Debt

Update Debt

Settlement Offers

Get Settlement

Update Settlement

Void Settlement

Virtual Bank Accounts (VBA)

Get All VBAs

Get VBA

Get VBA Activity

Update VBA Reserve Amount

VBA to Client Funds Transfer

VBA to VBA Funds Transfer

Get Cancellation Reasons

Get Compensation Templates

Get Decision Statuses

Get Document Templates

Get Document Types

Get Forth Fee Amounts

Get Freeze Map

Get Hold Reasons

Get Settlement Offer Statuses

Get Transaction Statuses

Get Transaction Subtypes

Get Transaction Types

Get Check Image

Get Settlement Decision

Mark  as Paid

Mark as Returned

Transactions

Get Debit

Update Debit

Get Fee

Update Fee

Refunds

Get Refund

Update Refund

Settlement Payments

Get Settlement Payment

Update Settlement Payment

Outstanding Debts

Settlements

Shipped Check Payments

The Companies section is where everything related to businesses comes together. Whether you’re managing company profiles, tracking interactions, or organizing payees, this section keeps things clear and accessible. It helps you stay on top of business relationships, ensuring that important information is easy to find when you need it.

The Consumers section is all about making client interactions smooth and effortless. Whether you need to retrieve client details, upload documents, or enroll them in services, everything is designed to keep things organized and efficient. Instead of jumping between systems, this section brings all client management tasks into one place, so handling consumer needs is clear, simple, and hassle-free.

This endpoint makes it efficient to add a new client, just enter their details, like name, contact info, and any initial settings, and the system will set up the record for you. No manual data entry, just a quick and efficient way to keep client information organized.

In order to pull up details for a specific client, you provide their unique {id}, and you&apos;ll receive everything from personal info to account status in one organized response to keep client data accessible and up to date.

If you need to update a client’s details, enter their unique {id} and specify the fields that need to be changed. Instead of hunting down records manually, you can streamline updates and keep client information accurate and up to date

If a client needs to add a co-applicant, they can provide their unique {id} and include the co-applicant’s details or ID. No need for manual linking—the system takes care of the association, keeping everything organized and efficient

If a client needs to add a co-applicant, they can provide their unique {id} along with the co-applicant’s details. The system will then ensure everything is linked properly and kept organized for a seamless process.

The Documents section provides a central place to manage and access important files. It allows users to securely store, retrieve, and organize documents related to various processes, ensuring that key information is readily available when needed.

The Enrollment section helps clients manage every stage of their journey—whether they need to resume, pause, graduate, or cancel their enrollment. With clear, structured actions, users can easily update their status without unnecessary hassle, ensuring a smooth and flexible process that adapts to their needs.

Enroll Consumer allows users to enroll a specific client into a debt relief program or service, providing enrollment details like program options and start dates in the request body. This section facilitates the seamless onboarding of clients into the desired program, streamlining the enrollment process for administrators and ensuring a smooth experience for clients.

This endpoint reactivates a client’s participation or services after a pause, using their unique {id} for identification. It provides a seamless way to restart engagements without unnecessary delays, ensuring continuity in their program or service.

This endpoint temporarily suspends a client’s participation or services, using their unique {id} for identification. Whether it’s a temporary leave or another interruption, this feature allows for a smooth pause, ensuring flexibility while keeping their status properly managed.

This endpoint confirms a client’s successful completion or graduation from an enrolled program, using their unique {id} for identification. This action may update their status or modify associated records, ensuring their progress is accurately reflected in the system.

The Cancel Enrollment endpoint removes a client from an enrolled program or service, using their unique {id} for identification. The reason_id parameter allows users to specify the reason for cancellation, ensuring accurate record-keeping and proper updates to the client’s status.

This endpoint re-enrolls a client into a Forth Pay program or service, using their unique {id} for identification. Whether they’re returning after completing a program or rejoining after unenrollment, this process ensures a smooth transition back into the system. The request body may include re-enrollment details to ensure their information is accurately updated.

The Portal section of the Default project API provides users with access to a centralized hub for managing account information, settings, and preferences. Through this section, users can easily navigate and update their account details, view transaction history, and customize their dashboard layout. This section serves as a user-friendly interface for efficiently managing and personalizing their account experience.

The Creditors section helps users manage creditor-related tasks effortlessly. Whether you need to look up a specific creditor, list all creditors, add new ones, or update addresses, this section makes the process smooth and organized. By keeping creditor details easily accessible, users can streamline payments and handle financial interactions with confidence.

The endpoints within the Bank Accounts section allow users to manage and view bank account information associated with a client&apos;s record. Users can add new bank accounts to a client&apos;s profile and retrieve a list of existing bank accounts for reference. This section provides essential functionality for handling financial transactions securely within the application.

Handling debts doesn’t have to be overwhelming. This section makes it simple—whether you’re creating a new debt record, retrieving details, or updating existing information, everything is designed to keep things clear and organized. No unnecessary complexity, just a straightforward way to stay on top of debt-related tasks with ease.

The endpoints within the Settlement Offers section allow users to manage and view settlement offers related to their transactions. Users can review, update, create, void, and attach letters to settlement offers through this API functionality. This section provides essential tools for efficiently handling settlement processes within the application.

This section is all about keeping settlement records clear and manageable. Whether you need to create, update, retrieve, or void a settlement, the available tools ensure everything stays organized and accurate. You can also attach important documents to settlements, making it easy to keep track of relevant details. The goal is to provide a straightforward, structured way to handle settlements without unnecessary complexity.

Completes the enrollment process in FORTH Pay. Requires a Client Record, Bank Account, Debts and Debit Schedule

Completes the enrollment process in FORTH Pay. Requires a Client Record, Bank Account, Debts and Debit Schedule

Unique identifier for the client to be enrolled.

The current status of the enrollment request, such as success or failure.

A specific code returned by the API indicating the result of the enrollment process.

code

A message providing additional context or details about the enrollment response.

message

status

response

Error - Unable to enroll this client into a Forth program at this time. 

Sections

Enroll Client

Header Parameters

Path Parameters

Response

Response Attributes

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Sections

Enroll Client

Header Parameters

Path Parameters

ResponseExpand all

Response Attributes

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Response