Skip to main content
POST
/
api
/
onboarding
/
business
/
premium
Premium Business Credit History
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/business/premium/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "registration_number": "RC-123456"
}
'
{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.smartcomply.com/llms.txt

Use this file to discover all available pages before exploring further.

The Premium Business Credit History endpoint aggregates credit data from both the CRC and First Central bureaus, providing a unified view of a business’s credit standing including loan history, performance summaries, director details, and credit enquiries.

​
Endpoint

POST /api/onboarding/business/premium/

​
Request

​
Headers

HeaderValueRequired
x-access-tokenYour API secret keyYes
Content-Typeapplication/jsonYes

​
Body Parameters

ParameterTypeRequiredDescription
registration_numberstringYesThe business RC or registration number

​
Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/business/premium/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"registration_number": "RC123456"}'

​
Response

​
200 OK

Each field in data.score is an array of objects with source ("CRC" or "FIRST_CENTRAL") and value keys, providing per-bureau breakdowns.
FieldTypeDescription
data.namestringBusiness name
data.businessTypestringBusiness type
data.score.directorsarrayDirectors per bureau
data.score.totalNoOfLoansarrayTotal loans per bureau
data.score.totalBorrowedarrayTotal borrowed per bureau
data.score.totalOutstandingarrayOutstanding balance per bureau
data.score.totalOverduearrayOverdue amount per bureau
data.score.loanHistoryarrayLoan history per bureau
data.score.creditEnquiriesarrayCredit enquiries per bureau
data.score.loanPerformancearrayLoan performance per bureau
data.score.bureauStatusobjectSuccess/failure status for each bureau
{
  "status": "success",
  "data": {
    "_id": "636e768d8215a2e2fb06cfde",
    "business_reg_no": "RC123456",
    "name": "CAPITALFIELD ASSET MGT LTD",
    "businessType": "SMALLANDMEDIUMSCALEENTERPRISE",
    "score": {
      "totalNoOfLoans": [
        {"source": "CRC", "value": 24},
        {"source": "FIRST_CENTRAL", "value": 9}
      ],
      "totalBorrowed": [
        {"source": "CRC", "value": 567401372},
        {"source": "FIRST_CENTRAL", "value": 1004525869.55}
      ],
      "totalNoOfDelinquentFacilities": [
        {"source": "CRC", "value": 1},
        {"source": "FIRST_CENTRAL", "value": 0}
      ],
      "bureauStatus": {
        "crc": "success",
        "firstCentral": "success"
      }
    },
    "searchedDate": "2023-11-23T16:17:36.391Z"
  },
  "message": "Premium check successful"
}

​
400 Bad Request

{
  "status": "failed",
  "data": [],
  "message": "Missing required fields"
}

​
401 Unauthorized

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

Authorizations

​
x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
​
registration_number
string
required
Example:

"RC-123456"

Response

Premium business credit report retrieved