Credit Registry Summary
curl --request POST \
--url https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/ \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"bvn": "22244545518"
}
'import requests
url = "https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/"
payload = { "bvn": "22244545518" }
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({bvn: '22244545518'})
};
fetch('https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'bvn' => '22244545518'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/"
payload := strings.NewReader("{\n \"bvn\": \"22244545518\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bvn\": \"22244545518\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bvn\": \"22244545518\"\n}"
response = http.request(request)
puts response.read_body{
"status": "failed",
"data": [
"<unknown>"
],
"message": "<string>"
}{
"status": "failed",
"message": "Authentication credentials were not provided."
}Individual
Credit Registry Credit Summary
Retrieve an individual’s credit summary from the Credit Registry bureau using their BVN.
POST
/
api
/
onboarding
/
individual
/
credit_registry_summary
/
Credit Registry Summary
curl --request POST \
--url https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/ \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"bvn": "22244545518"
}
'import requests
url = "https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/"
payload = { "bvn": "22244545518" }
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({bvn: '22244545518'})
};
fetch('https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'bvn' => '22244545518'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/"
payload := strings.NewReader("{\n \"bvn\": \"22244545518\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"bvn\": \"22244545518\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bvn\": \"22244545518\"\n}"
response = http.request(request)
puts response.read_body{
"status": "failed",
"data": [
"<unknown>"
],
"message": "<string>"
}{
"status": "failed",
"message": "Authentication credentials were not provided."
}The Credit Registry Credit Summary endpoint returns a summary of an individual’s credit-related activities from the Credit Registry bureau, including loan totals, repayment status, and outstanding balances.
Endpoint
POST /api/onboarding/individual/credit_registry_summary/
Request
Headers
| Header | Value | Required |
|---|---|---|
x-access-token | Your API secret key | Yes |
Content-Type | application/json | Yes |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
bvn | string | Yes | The individual’s 11-digit Bank Verification Number |
Example
curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/individual/credit_registry_summary/" \
-H "x-access-token: YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"bvn": "22244545518"}'
Response
200 OK
| Field | Type | Description |
|---|---|---|
data.name | string | Full name |
data.score.totalNoOfLoans | number | Total loans on record |
data.score.totalNoOfActiveLoans | number | Currently active loans |
data.score.totalNoOfClosedLoans | number | Closed loans |
data.score.totalBorrowed | number | Total amount borrowed |
data.score.totalOutstanding | number | Total outstanding balance |
data.score.totalNoOfDelinquentFacilities | number | Number of delinquent facilities |
data.score.highestLoanAmount | number | Highest single loan amount |
data.searchedDate | string | Date this report was retrieved |
{
"status": "success",
"data": {
"_id": "64f600608aaf9386c646de32",
"bvn": "22244545518",
"name": "ADELEKE EMMANUEL AYORINDE",
"gender": "Male",
"dateOfBirth": "29/12/1994",
"score": {
"totalNoOfLoans": 16,
"totalNoOfInstitutions": 5,
"totalNoOfActiveLoans": 1,
"totalNoOfClosedLoans": 15,
"totalNoOfPerformingLoans": 16,
"totalNoOfDelinquentFacilities": 0,
"highestLoanAmount": 1134330,
"totalBorrowed": 3761267,
"totalOutstanding": 0,
"totalOverdue": 0
},
"searchedDate": "2023-11-23T14:46:37.552Z"
},
"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."
}
⌘I

