API Reference

My API Keys

Where is my API Key

  1. Your Credit Scoring API key is found on your developers' page on the Cladfy Business Dashboard
    1. The dashboard for Cashflow is on: https://dashboard.cladfy.com/
    2. The dashboard for Repayment, Deposit, and Demographic Scores is on: https://score.cladfy.com/
  2. Your Identity - Know Your Customer (KYC/KYB) API key is provided upon request via email to [email protected]

Authentication

All protected endpoints will require a secret key

  1. For credit scoring, you will need:
    X-API-Key: YOUR_API_KEY, which you can get from your dashboard or upon request via email to [email protected]


    Example: Authorization:


  2. For Identity(KYC), you will need:
    Basic authentication. This is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string API Client ID:API Secret Key


    Example: Authorization: Basic WTYdfghWYGYPVSAFIhhbhTThrVRYGPHH==
    See how to get your Basic Auth Token


❗️

Note

Your API key will be generated once from your dashboard or via email and a copy stored securely on our servers.

However, you can regenerate your API key at any time, but doing so will create a new key