Here is a quick description of authentication and authorization in the context of access to APIs:

• Authentication: This is the process of verifying your identity. When you make an API request, you prove your identity by providing a valid API Key.
• Authorization: Once authenticated, this is the process of confirming that you have permission to access a specific API resource or perform an action.

Connection Flow

All API endpoints require authentication. A valid API Key must be included when sending a request. If you do not have an API Key or your previous key has expired, you will need to obtain a new one by completing the following steps:

1

Access REST API Management Page

Log-in to the Forth CRM and navigate to the API Credentials Management Page.

2

Generate a Secret / Key Pair

On the API Credentials Management Page:

1. Select the User Type (Standard or Service)
2. Choose a Company via the dropdown menu
3. Select a User via the dropdown menu
4. Enter a Description
5. Click the Generate Key button at the bottom left of the section
6. A pop-up screen will appear, displaying your API Secret and Key ID (see example below).

Copy and save both values in a secure location like a secrets or password manager. The API Secret will not be shown again.

3

Obtain Access Token

Use the Get Access Token endpoint to swap your API Secret and Key ID for an access token. The access token expires after 10 days and must be refreshed using this endpoint before the expiration date.

Our APIs use Api Key-based authentication/authorization schemes to create a session. You must pass this access token in the Api-Key header in every HTTP request made to a Forth API endpoint.

The Forth API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, response codes fall into these categories:

• 2xx (Success): The request was successfully received, understood, and accepted.
• 4xx (Client Error): The request failed due to an issue on your end (e.g., missing parameter, invalid data, lack of permissions).
• 5xx (Server Error): An unexpected error occurred on Forth’s servers. These are rare, but if you encounter one, please check our status page or contact our support team.

Here are some common error codes you may encounter:

Postman Collections

To improve the developer experience, Forth will soon be providing users with a convenient way to access and interact with predefined API collections for our various products. By viewing or running these collections in Postman, users can easily test and explore various API endpoints and functionalities.

To ensure platform stability and fair usage for all clients, the Forth API employs rate limiting.

Handling Rate Limiting Errors

If you exceed the Request Rate Limit, you will receive an HTTP 429 "Too Many Requests" response code, and your API use will be restricted.

Resolution Options:

• Wait progressively longer before retrying requests. Avoid aggressive retries.
• Identify high-volume processes and optimize them (e.g., use bulk endpoints if available, implement caching).
• If you consistently hit limits due to legitimate high usage, contact us to discuss potential options.

Our User Guides provide step-by-step instructions and documentation to help you navigate and utilize the Forth API. These guides include best practices and troubleshooting tips to enhance your experience and create better applicausing the Forth API.

Our core objects represent the backbone of our APIs. Most, if not all, actions are tied to these core objects and are fundamental to the Forth ecosystem. These objects reflect key pillars of the debt settlement process, from Contacts (the consumers you intend to enroll), to Documents, to communication objects like the Call object to log conversations.

The Contact is the central object for debt settlement workflows and processes. This object represents the consumer you intend to enroll and all of their accompanying data. This includes:

• Credit Reports
• Calendar Events
• Logged Calls and SMS messages
• Debts (settled, unsettled, enrolled and unenrolled)
• Notes
• Documents
• Banking Information

The Contact Object represents basic CRUD operations for Contacts in your system. Additionally, you can use this endpoint to de-link a co-applicant from this contact's record.

The Alerts section allows you to manage and view alerts associated with a specific contact. You can create, update, delete, and retrieve alerts to stay informed about important events or notifications related to the contact.

The Notes section allows you to manage and store additional information related to specific contacts. You can create, update, and delete notes associated with a contact, providing valuable context and documentation for each contact interaction.

The Communication section contains various endpoints to send and/or log various forms of communication like email and SMS.

The Credit Reports section provides you with access to detailed reports on credit information related to a specific entity or individual.

The Documents section provides functionality for managing and accessing various documents associated with a contact. You can upload, delete, and retrieve documents, as well as update document details such as file type.

The Debts Management section allows you to retrieve information about debts related to specific contacts. You can view details on unsettled debts, settled debts, debts that are not yet enrolled, enrolled debts, and all debts associated with a particular contact.

The Workflow section of endpoints allows you to interact with and manage the various stages and steps involved in a project or task.

The Banking section of endpoints provides functionality related to financial transactions and account management. You can perform tasks such as transferring funds, querying account balances, and setting up direct debits.

Retrieves bank account details stored on the contact record.

Duplicate of Get Bank Account API Endpoint

The "Update Bank Account" endpoint allows you to update and modify the details of a bank account associated with a specific contact. Users can change account numbers, routing numbers, account types, payment types, and account holder information.

The "Create Bank Account" endpoint allows you to add a new bank account associated with a specific contact. By providing necessary account details, users can securely store banking information for future transactions and financial operations.

This endpoint allows you to retrieve detailed information about a bank account stored on a contact record. You can access essential details such as the name on the account, account number, routing number, account type, and bank information.

The endpoints within the Contact Lists section allow you to manage and organize their contact information efficiently. Users can create, update, and delete contact lists, as well as add, remove, and retrieve contacts within these lists.

The endpoints within the Call section allow you to interact with and manage call data within the system. You can retrieve, update, and delete specific call entries, as well as create new calls and access information about call dispositions.

This collection of endpoints allows you to generate and delete documents in our system.

This collection of endpoints allows you to generate and/or delete entire document packages.

These document packages must be configured in your CRM account before leveraging these endpoints.

The endpoints within the Task section allow you to interact with tasks in the default project's calendar. You can create, retrieve, update, and delete individual tasks.

The endpoints within the Calendar Event section allow you to interact with calendar events in our system. Calendar events in our systare tied to contacts. You can create, retrieve, update, and delete individual calendar events using this section. This functionality enables users to efficiently manage and organize their project's schedule through the API.

The User section of the API allows you to manage and retrieve information about individual users within an account. Users can create, update, delete, and view user profiles, as well as access user-specific data and settings.

The Marketing APIs enable you to manage promotional campaigns, manage email marketing templates and more.

The Platform Management section provides functions to effectively manage various aspects of their platform settings. You can configure and customize settings related to account preferences, notifications, and user permissions.

The Servicing section of the API allows you to manage and update various settings and configurations for the common servicing functions of debt settlement workflows. This includes creditors, enrollment states, lenders, settlement offers, and transactions.

The Utilities section provides various tools and functions to assist users in managing and manipulating data within the system. With this section, users can perform tasks such as searching for contacts by phone number and conducting lookups on institutions. Streamline your workflow and enhance data organization with the Utilities section.

This section contains a user guide specific to the Clixsign feature. Clixsign is Forth's proprietary electronic document signing platform. To enable this platform, please contact Support@setforth.com.

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.