Getting started with the Credit App REST API - Creditor Schema
Credit App offers a suite of APIs that allow developers to extend the platform’s built-in features. These APIs allow app developers to read and write data, interoperate with other systems and platforms, and add new functionality to Credit App.
When you make a request to the REST API, you will specify an HTTP method and a path. Additionally, you might also specify request headers and path, query, or body parameters. The API will return the response status code, response headers, and potentially a response body.
The REST API reference documentation describes the HTTP method, path, and parameters for every operation. It also displays example requests and responses for each operation.
Guides
We strongly recommend you check out the guides section before you start using the Credit App REST API. The guides provide detailed information on how to use the REST API, including examples and best practices.
Requirements for using the Credit App REST API
- All APIs require developers to request access and be granted an API key.
- All APIs require developers to authenticate.
Deprecated APIs
Deprecated APIs remain available but are unsupported and can stop working at any time. Developers should migrate to supported alternatives as soon as possible.
Authentication
All incoming requests to the Credit App API must be authenticated. Bearer authentication is used to authenticate requests. HMAC signatures are added to all outgoing webhook requests. Please see the guide on authentication for more information.
Webhooks
Webhooks allow apps to stay in sync with Credit App data or perform an action after a specific event occurs. Webhooks are a performant alternative to continuously polling for changes to data. For example, a webhook can notify your app when a decision has been made on an application by a creditor. Your app can then perform an action when the change occurs. This guide introduces how webhooks work, including how to configure a webhook for your app and manage webhooks.