Kenya National ID Advanced
curl --request POST \
--url https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_advance/ \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"id_number": "12345678"
}
'import requests
url = "https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_advance/"
payload = { "id_number": "12345678" }
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({id_number: '12345678'})
};
fetch('https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_advance/', 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/kenya_kyc/national_id_advance/",
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_number' => '12345678'
]),
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/kenya_kyc/national_id_advance/"
payload := strings.NewReader("{\n \"id_number\": \"12345678\"\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/kenya_kyc/national_id_advance/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id_number\": \"12345678\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_advance/")
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 \"id_number\": \"12345678\"\n}"
response = http.request(request)
puts response.read_body{
"status": "failed",
"data": [
"<unknown>"
],
"message": "<string>"
}{
"status": "failed",
"message": "Authentication credentials were not provided."
}Kenya
National ID Advanced
Retrieve extended identity details for a Kenyan national ID, including photo, place of birth, and residence.
POST
/
api
/
onboarding
/
kenya_kyc
/
national_id_advance
/
Kenya National ID Advanced
curl --request POST \
--url https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_advance/ \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"id_number": "12345678"
}
'import requests
url = "https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_advance/"
payload = { "id_number": "12345678" }
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({id_number: '12345678'})
};
fetch('https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_advance/', 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/kenya_kyc/national_id_advance/",
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_number' => '12345678'
]),
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/kenya_kyc/national_id_advance/"
payload := strings.NewReader("{\n \"id_number\": \"12345678\"\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/kenya_kyc/national_id_advance/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id_number\": \"12345678\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_advance/")
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 \"id_number\": \"12345678\"\n}"
response = http.request(request)
puts response.read_body{
"status": "failed",
"data": [
"<unknown>"
],
"message": "<string>"
}{
"status": "failed",
"message": "Authentication credentials were not provided."
}The National ID Advanced endpoint returns comprehensive identity information for a Kenyan national ID, including the registrant’s photo, place of birth, place of residence, and issue details.
Endpoint
POST /api/onboarding/kenya_kyc/national_id_advance/
Request
Headers
| Header | Value | Required |
|---|---|---|
x-access-token | Your API secret key | Yes |
Content-Type | application/json | Yes |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
national_id | integer | Yes | The customer’s Kenyan national ID number |
Example
curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_advance/" \
-H "x-access-token: YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"national_id": 1010101010}'
Response
200 OK
| Field | Type | Description |
|---|---|---|
data.First_Name | string | First name |
data.Surname | string | Surname |
data.Other_Name | string | Other/middle name |
data.Gender | string | Gender ("M" or "F") |
data.Date_of_Birth | string | Date of birth |
data.Citizenship | string | Citizenship status |
data.Date_of_Issue | string | ID issue date |
data.Place_of_Birth | string | Place of birth |
data.Place_of_Live | string | Registered place of residence |
data.Photo | string | Base64-encoded ID photo |
{
"status": "success",
"data": {
"Pin": "",
"Clan": "",
"Photo": "<base64-encoded-jpeg>",
"Family": "",
"Gender": "M",
"Surname": "Leo",
"RegOffice": "",
"First_Name": "Joe",
"Occupation": "",
"Other_Name": "Doe",
"Citizenship": "Kenyan",
"Date_of_Birth": "2000-09-20 12:00:00 AM",
"Date_of_Death": "",
"Date_of_Issue": "1/27/2000 12:00:00 AM",
"Place_of_Live": "BOX 12345-00800 NAIROBI\nKAREN\nKAREN\nLOCATION - LANGATA\nDIVISION - KIBERA\nDISTRICT - STAREHE",
"Serial_Number": 0,
"Place_of_Birth": "NAIROBI\nDISTRICT - STAREHE",
"Place_of_Death": ""
},
"message": "National ID Advance details retrieved successfully"
}
400 Bad Request
{
"status": "failed",
"data": [],
"message": "Sorry, your check cannot be processed at the moment. Please try again in a few minutes"
}
401 Unauthorized
{
"status": "failed",
"message": "Authentication credentials were not provided."
}
⌘I

