Skip to main content
POST
/
api
/
onboarding
/
individual
/
crc_summary
CRC Credit History
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/individual/crc_summary/ \
  --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 CRC Credit History endpoint returns a summary of an individual’s credit-related activities from the CRC bureau, including loan totals, repayment status, and outstanding balances.

​
Endpoint

POST /api/onboarding/individual/crc_summary/

​
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/crc_summary/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bvn": "22244545518"}'

​
Response

​
200 OK

FieldTypeDescription
data.namestringFull name
data.genderstringGender
data.dateOfBirthstringDate of birth
data.score.totalNoOfLoansstringTotal loans on record
data.score.totalNoOfActiveLoansstringCurrently active loans
data.score.totalNoOfClosedLoansnumberClosed loans
data.score.totalBorrowedstringTotal amount borrowed
data.score.totalOutstandingstringTotal outstanding balance
data.score.totalOverduestringTotal overdue amount
data.score.totalNoOfDelinquentFacilitiesstringNumber of delinquent facilities
data.score.lastReportedDatestringMost recent bureau report date
data.score.crcReportOrderNumberstringCRC report order number
data.searchedDatestringDate this report was retrieved
{
  "status": "success",
  "data": {
    "_id": "64f600608aaf9386c646de32",
    "bvn": "22244545518",
    "customerId": "505327",
    "name": "ADELEKE EMMANUEL AYORINDE",
    "gender": "Male",
    "dateOfBirth": "29/12/1994",
    "score": {
      "totalNoOfDelinquentFacilities": "0",
      "lastReportedDate": "30-SEP-2023",
      "totalNoOfLoans": "7",
      "totalNoOfInstitutions": "4",
      "totalNoOfActiveLoans": "6",
      "totalBorrowed": "3,541,267",
      "totalOutstanding": "1",
      "totalOverdue": "0",
      "maxNoOfDays": "0",
      "totalNoOfClosedLoans": 1,
      "crcReportOrderNumber": "W-0097884391/2023"
    },
    "searchedDate": "2023-11-23T14:04:03.722Z"
  },
  "message": "CRC Individual credit summary report details retrieved successfully"
}

​
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

CRC credit history retrieved