Authentication

You can login with your credentials into the Web Portal. Use the default "CreditChek" app API keys or create your preferred App with your details.

All CreditChek API Endpoint accepts your unique secured API public Key as a Header token. Only the RADAR Endpoint uses the same API Public Key as the "Bearer token". You can manage your API keys from the dashboard.

Sample Header

token: oCLkJivg2ol5P9iG39454OUYMvOgXT1XbAPmjF/1qyjDr8SwTssHcDpb4CI0iVSa

Generally, we provide both public and secret keys. For Security reasons we went further ahead to encrypt your keys with the AES 256 bit encryption algorithm.

If for any reason you believe your keys has been compromised or you wish to reset them, you can do so from the dashboard.

Secure your keys

Do not commit your keys to git, or use them in client-side code.

API requests made without authentication will fail with the status code 401: Unauthorized. All API requests must be made over HTTPS.

Secure your requests

Do not set VERIFY_PEER to FALSE. Ensure your server verifies the SSL connection to CreditChek

Ensure to check this boxes ✅ during your complete integration of our services.

Happy building and integration...

Love from CreditChek Team..

Sample Requests

We provide sample API calls next to each method using cURL. All you need to do is insert your specific parameters, and you can test the calls from the command line. See this tutorial on using cURL with APIs.

Requests and Response

Both request body data and response data are formatted as JSON. Content type for responses will always be application/json. Generally, all responses will be in the following format:

Response format

{
  "success": [boolean],  // Only true if the details provided could be processed and no error occured while processing
  "message": [string], // Explains why status is false... Entirely informational. Please only log this but do not use for your checks
  "data": [object]    // contains actionable result of processing if present
}

While, it could be useful to use HTTP status codes to determine the result of an API call, we have provided a handy success key to let you know upfront if the request was successful or not.

The message key is a string which will contain a summary of the response and its status. For instance when trying to retrieve a list of customers, message might read “Customers retrieved”. In the event of an error, the message key will contain a description of the error as with the authorization header situation above. This is the only key that is universal across requests.

The data key is where you want to look for the result of your request. It can either be an object, or an array depending on the request made. For instance, a request to retrieve a single customer will return a customer object in the data key, while the key would be an array of customers if a list is requested instead.

Wallets

You can get your wallet balance using the endpoint below. You're advised as well to set a wallet threshold limit so you can get notified via email whenever your balance goes below the set limit to avoid service disruption.

Response format

---
curl --location --request GET 'https://api.creditchek.africa/v1/wallet/' \
--header 'Authorization: Bearer nAuuVJ2T2TokentNoOcqBpSf1TokenwIJyTSIFDTokenMchQXb44Token5GyKG'
---

Errors

As stated earlier, CreditChek's API is RESTful and as such, uses conventional HTTP response codes to indicate the success or failure of requests.
For more enquries, please reach out us @ E-mail: [email protected]