Skip to main content
POST
/
api
/
onboarding
/
individual
/
credit_registry_history_advanced
Credit Registry History Advanced
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_history_advanced/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "bvn": "22244545518"
}
'
{
  "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 Credit Registry History Advanced endpoint returns a detailed credit history report from the Credit Registry bureau, including loan performance per account, creditor contact details, and credit enquiry summaries.

​
Endpoint

POST /api/onboarding/individual/credit_registry_history_advanced/

​
Request

​
Headers

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

​
Body Parameters

ParameterTypeRequiredDescription
bvnstringYesThe individual’s 11-digit Bank Verification Number

​
Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_history_advanced/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bvn": "22244545518"}'

​
Response

​
200 OK

FieldTypeDescription
data.namestringFull name
data.score.totalNoOfLoansnumberTotal loans on record
data.score.totalBorrowednumberTotal amount borrowed
data.score.creditorsarrayCreditors with subscriber IDs and contact details
data.score.creditEnquiriesarrayCredit enquiries with reason and date
data.score.creditEnquiriesSummaryobjectEnquiry counts for last 3, 12, and 36 months
data.score.loanPerformancearrayPer-account performance with payment profiles
{
  "status": "success",
  "data": {
    "_id": "64f600608aaf9386c646de32",
    "bvn": "22244545518",
    "name": "ADELEKE EMMANUEL AYORINDE",
    "gender": "Male",
    "dateOfBirth": "29/12/1994",
    "score": {
      "totalNoOfLoans": 16,
      "totalNoOfDelinquentFacilities": 0,
      "totalBorrowed": 3761267,
      "totalOutstanding": 0,
      "creditors": [
        {"Subscriber_ID": "737248693595559931", "Name": "NewEdge Finance Limited", "Phone": "008618824674241"}
      ],
      "creditEnquiries": [
        {"loanProvider": "Lifegate Microfinance Bank Limited", "reason": "KYCCheck", "date": "2023-11-23T00:00:00"}
      ],
      "creditEnquiriesSummary": {
        "Last3MonthCount": "3",
        "Last12MonthCount": "4",
        "Last36MonthCount": "6"
      },
      "loanPerformance": [
        {"loanProvider": "Sterling Bank Plc", "accountNumber": "0086575839", "status": "Open", "paymentProfile": "NNNNNNNNNNNNNNNNNN0N0N00"}
      ]
    },
    "searchedDate": "2023-11-23T14:47:42.824Z"
  },
  "message": "Credit Registry 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
​
bvn
string
required
Example:

"22244545518"

Response

Advanced credit history retrieved