KYC - Nigeria
Individual Credit Report
Retrieves the credit report for an individual in Nigeria using identification details, account information, or name and date of birth.
POST
/
v2
/
api
/
identity
/
credit-report
/
ng
/
individual
Individual Credit Report
curl --request POST \
--url https://api.youverify.co/v2/api/identity/credit-report/ng/individual \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"id": "22471069115",
"isSubjectConsent": true,
"consumerName": "",
"accountNumber": "",
"dateOfBirth": "",
"enquiryReason": "borrower_existing_credit"
}
'import requests
url = "https://api.youverify.co/v2/api/identity/credit-report/ng/individual"
payload = {
"id": "22471069115",
"isSubjectConsent": True,
"consumerName": "",
"accountNumber": "",
"dateOfBirth": "",
"enquiryReason": "borrower_existing_credit"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '22471069115',
isSubjectConsent: true,
consumerName: '',
accountNumber: '',
dateOfBirth: '',
enquiryReason: 'borrower_existing_credit'
})
};
fetch('https://api.youverify.co/v2/api/identity/credit-report/ng/individual', 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://api.youverify.co/v2/api/identity/credit-report/ng/individual",
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([
'id' => '22471069115',
'isSubjectConsent' => true,
'consumerName' => '',
'accountNumber' => '',
'dateOfBirth' => '',
'enquiryReason' => 'borrower_existing_credit'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://api.youverify.co/v2/api/identity/credit-report/ng/individual"
payload := strings.NewReader("{\n \"id\": \"22471069115\",\n \"isSubjectConsent\": true,\n \"consumerName\": \"\",\n \"accountNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"enquiryReason\": \"borrower_existing_credit\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://api.youverify.co/v2/api/identity/credit-report/ng/individual")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"22471069115\",\n \"isSubjectConsent\": true,\n \"consumerName\": \"\",\n \"accountNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"enquiryReason\": \"borrower_existing_credit\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/identity/credit-report/ng/individual")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"22471069115\",\n \"isSubjectConsent\": true,\n \"consumerName\": \"\",\n \"accountNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"enquiryReason\": \"borrower_existing_credit\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"id": "6493a6cdaa1aca5fb0203b57",
"parentId": null,
"status": "not_found",
"reason": "Person Not Found",
"personalDetailsSummary": [],
"deliquencyInformation": [],
"creditAccountSummary": [],
"creditAccountRating": [],
"creditAgreementSummary": [],
"accountMonthlyPaymentHistory": [],
"guarantorCount": [],
"guarantorDetails": [],
"enquiryHistoryTop": [],
"identificationHistory": [],
"addressHistory": [],
"employmentHistory": [],
"telephoneHistory": [],
"isConsent": true,
"idNumber": "22471069116",
"businessId": "628b38f03ae28a14f52d4bf7",
"type": "ngIndividualCreditReport",
"requestedAt": "2023-06-22T01:41:36.203Z",
"requestedById": "628b38f03ae28a5a122d4bf3",
"country": "NG",
"createdAt": "2023-06-22T01:41:36.389Z",
"lastModifiedAt": "2023-06-22T01:41:36.389Z",
"metadata": {},
"requestedBy": {
"firstName": "API",
"lastName": "User",
"middleName": "",
"id": "628b38f03ae28a5a122d4bf3"
}
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"data": {}
}{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"name": "ResourceNotFoundError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}Authorizations
Your Youverify API secret key. Never expose client-side.
Headers
API secret token
Body
application/json
Individual's identification number (BVN, Mobile No., National ID, Pencom ID, Passport No., or Drivers License No.). Pass empty string when using consumerName + dateOfBirth or accountNumber
Must be true indicating subject consent
Consumer's name; pass empty string when using id or accountNumber
Consumer's account number; pass empty string when using id
Consumer's date of birth; pass empty string when using id or accountNumber
Customer's enquiry reason
Response
Success (found or not found)
⌘I
Individual Credit Report
curl --request POST \
--url https://api.youverify.co/v2/api/identity/credit-report/ng/individual \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"id": "22471069115",
"isSubjectConsent": true,
"consumerName": "",
"accountNumber": "",
"dateOfBirth": "",
"enquiryReason": "borrower_existing_credit"
}
'import requests
url = "https://api.youverify.co/v2/api/identity/credit-report/ng/individual"
payload = {
"id": "22471069115",
"isSubjectConsent": True,
"consumerName": "",
"accountNumber": "",
"dateOfBirth": "",
"enquiryReason": "borrower_existing_credit"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '22471069115',
isSubjectConsent: true,
consumerName: '',
accountNumber: '',
dateOfBirth: '',
enquiryReason: 'borrower_existing_credit'
})
};
fetch('https://api.youverify.co/v2/api/identity/credit-report/ng/individual', 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://api.youverify.co/v2/api/identity/credit-report/ng/individual",
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([
'id' => '22471069115',
'isSubjectConsent' => true,
'consumerName' => '',
'accountNumber' => '',
'dateOfBirth' => '',
'enquiryReason' => 'borrower_existing_credit'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://api.youverify.co/v2/api/identity/credit-report/ng/individual"
payload := strings.NewReader("{\n \"id\": \"22471069115\",\n \"isSubjectConsent\": true,\n \"consumerName\": \"\",\n \"accountNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"enquiryReason\": \"borrower_existing_credit\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://api.youverify.co/v2/api/identity/credit-report/ng/individual")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"22471069115\",\n \"isSubjectConsent\": true,\n \"consumerName\": \"\",\n \"accountNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"enquiryReason\": \"borrower_existing_credit\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/identity/credit-report/ng/individual")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"22471069115\",\n \"isSubjectConsent\": true,\n \"consumerName\": \"\",\n \"accountNumber\": \"\",\n \"dateOfBirth\": \"\",\n \"enquiryReason\": \"borrower_existing_credit\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"id": "6493a6cdaa1aca5fb0203b57",
"parentId": null,
"status": "not_found",
"reason": "Person Not Found",
"personalDetailsSummary": [],
"deliquencyInformation": [],
"creditAccountSummary": [],
"creditAccountRating": [],
"creditAgreementSummary": [],
"accountMonthlyPaymentHistory": [],
"guarantorCount": [],
"guarantorDetails": [],
"enquiryHistoryTop": [],
"identificationHistory": [],
"addressHistory": [],
"employmentHistory": [],
"telephoneHistory": [],
"isConsent": true,
"idNumber": "22471069116",
"businessId": "628b38f03ae28a14f52d4bf7",
"type": "ngIndividualCreditReport",
"requestedAt": "2023-06-22T01:41:36.203Z",
"requestedById": "628b38f03ae28a5a122d4bf3",
"country": "NG",
"createdAt": "2023-06-22T01:41:36.389Z",
"lastModifiedAt": "2023-06-22T01:41:36.389Z",
"metadata": {},
"requestedBy": {
"firstName": "API",
"lastName": "User",
"middleName": "",
"id": "628b38f03ae28a5a122d4bf3"
}
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"data": {}
}{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"name": "ResourceNotFoundError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}