Centrex Software

Get Started

<p class="slate-p " >Here is a quick description of authentication and authorization in the context of access to APIs:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Authentication: </strong>This is the process of verifying your identity. When you make an API request, you prove your identity by providing a valid API Key.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Authorization:</strong> Once authenticated, this is the process of confirming that you have permission to access a specific API resource or perform an action.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Connection Flow</h2><p class="slate-p " >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:</p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Access REST API Management Page</h3><p class="slate-p " >Log-in to the Forth CRM and navigate to the API Credentials Management Page.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Generate a Secret / Key Pair</h3><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/633a9376-be64-417f-8220-d78b1ac657c9.jpg" style="
              width:537px;
	            height:432px;
	            aspect-ratio:537 / 432"
         /></div><p class="slate-p " >On the API Credentials Management Page:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Select the User Type (Standard or Service)</div></li><li class="slate-li " ><div style="position:relative">Choose a Company via the dropdown menu</div></li><li class="slate-li " ><div style="position:relative">Select a User via the dropdown menu</div></li><li class="slate-li " ><div style="position:relative">Enter a Description</div></li><li class="slate-li " ><div style="position:relative">Click the <em class="slate-italic">Generate Key</em> button at the bottom left of the section</div></li><li class="slate-li " ><div style="position:relative">A pop-up screen will appear, displaying your API Secret and Key ID (see example below).</div></li></ol><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/e872f262-2563-4d7f-bee6-9325c3d738df.jpg" style="
              width:673px;
	            height:244px;
	            aspect-ratio:673 / 244"
         /></div><p class="slate-p " >Copy and save both values in a secure location like a secrets or password manager. <strong class="slate-bold">The API Secret will not be shown again.</strong></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Obtain Access Token</h3><p class="slate-p " >Use the <a href="6836715cf4389be3769da5e4/68362d43f4389be3769c1b69/68362d43f4389be3769c1bde" target="">Get Access Token endpoint</a> to swap your API Secret and Key ID for an access token. The access token expires after <strong class="slate-bold">10 days</strong> and must be refreshed using this endpoint before the expiration date. </p><p class="slate-p " >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.</p></div></div></div><p class="slate-p " ></p>

Authentication

<p class="slate-p " >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:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">2xx (Success): The request was successfully received, understood, and accepted.</div></li><li class="slate-li " ><div style="position:relative">4xx (Client Error): The request failed due to an issue on your end (e.g., missing parameter, invalid data, lack of permissions).</div></li><li class="slate-li " ><div style="position:relative">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.</div></li></ul><p class="slate-p " >Here are some common error codes you may encounter:</p><p class="slate-p " ></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:94px;">Code</div><div style="width:170px;">HTTP Status</div><div style="width:237px;">Meaning</div><div style="width:234px;">Possible Causes</div><div style="width:823px;">Resolution Steps</div></div><colgroup ><col style="width:94px"><col style="width:170px"><col style="width:237px"><col style="width:234px"><col style="width:823px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">400</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Bad Request</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">The request is malformed or contains invalid parameters.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Missing parameters, invalid JSON format, incorrect data types.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Validate request parameters, check JSON structure, and ensure required fields are included.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">401</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Unauthorized</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Authentication is missing or invalid.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Missing API key, expired token, incorrect credentials.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Include a valid API key, a refresh authentication token, and verify credentials.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">403</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Forbidden</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Client lacks permission to access the resource.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Insufficient user permissions, resource restrictions.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Ensure user has the required permissions, check access control settings.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">404</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Not Found</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">The requested resource does not exist.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Incorrect URL, resource deleted or moved.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Verify the request URL, check resource availability.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">405</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Method Not Allowed</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">HTTP method is not allowed for the endpoint.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Using GET instead of POST, or vice versa.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Use the correct HTTP method per the API documentation.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">429</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Too Many Requests</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Too many requests hit the API too quickly</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Exceeding rate limits</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Examine rate limit headers, avoid aggressive retries, ID high-volume processes, and optimize if possible, 
Exponential backoff of your requests.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">500</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Internal Server Error</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">An unexpected error occurred on the server.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Server misconfiguration, unhandled exceptions.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Check server logs, debug application code.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">502</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Bad Gateway</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Server received an invalid response from an upstream server.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">API gateway issues, backend server down.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Check backend server health, retry request.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">503</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Service Unavailable</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Server is overloaded or under maintenance.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">High traffic, scheduled maintenance.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Retry after some time, check the API status page.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">504</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Gateway Timeout</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Server did not receive a timely response from an upstream server.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Slow database query, network congestion.</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px">Optimize backend response times, increase timeout threshold.</p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

Error Codes

<p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >Under Construction, Coming Soon!</p></div></div><h3 class="slate-h3 " >
Postman Collections</h3><p class="slate-p " >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.</p>

Developer Tools

<p class="slate-p " >To ensure platform stability and fair usage for all clients, the Forth API employs rate limiting.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >The current Request Rate Limit is set to <strong class="slate-bold">twenty (20) requests per second</strong> for a unique Session ID or IP Address.</p></div></div><p class="slate-p " ></p><h3 class="slate-h3 " >Handling Rate Limiting Errors</h3><p class="slate-p " >If you exceed the Request Rate Limit, you will receive an HTTP 429 &quot;Too Many Requests&quot; response code, and your API use will be restricted.</p><p class="slate-p " >Resolution Options:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Wait progressively longer before retrying requests. Avoid aggressive retries.</div></li><li class="slate-li " ><div style="position:relative">Identify high-volume processes and optimize them (e.g., use bulk endpoints if available, implement caching).</div></li><li class="slate-li " ><div style="position:relative">If you consistently hit limits due to legitimate high usage, contact us to discuss potential options.</div></li></ul><p class="slate-p " ></p>

Rate Limits

<p class="slate-p " >The Forth CRM API provides access to essential functionality for managing customer relationships and interactions within your project. Users can create, update, and retrieve customer data, track interactions, and manage customer profiles efficiently. This section is crucial for optimizing customer relationship management efforts and enhancing overall customer satisfaction.</p><p class="slate-p " >To view endpoints associated with the Forth Pay API, click <a href="https://app.theneo.io/setforth/pay/forth-pay-api" target="">HERE</a>.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Centrex CRM

<p class="slate-p " >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.</p><p class="slate-p " ></p><p class="slate-p " ></p>

User Guides

<p class="slate-p " >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.</p><p class="slate-p " ></p>

Core Objects

<p class="slate-p " >The Marketing APIs enable you to manage promotional campaigns, manage email marketing templates and more. </p>

Marketing

<p class="slate-p " >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.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Platform Management

<p class="slate-p " >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.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Servicing

<p class="slate-p " >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.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Utilities

Clixsign

<p class="slate-p " >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>.</p><p class="slate-p " ></p>

<p class="slate-p " >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.</p><p class="slate-p " ></p>

Sections