Skip to main content
POST
/
api
/
onboarding
/
kenya_kyc
/
national_id_basic
/
Kenya National ID Basic
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_basic/ \
  --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_basic/"

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_basic/', 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_basic/",
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_basic/"

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_basic/")
.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_basic/")

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 Kenya National ID Basic endpoint retrieves verified identity data from the Kenyan government’s IPRS database, returning the ID holder’s full name, gender, citizenship, and photo.

Endpoint

POST /api/onboarding/kenya_kyc/national_id_basic/

Request

Headers

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

Body Parameters

ParameterTypeRequiredDescription
national_idstringYesThe customer’s Kenyan national ID number

Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_basic/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"national_id": "00000000"}'
const response = await fetch(
  "https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_basic/",
  {
    method: "POST",
    headers: {
      "x-access-token": "YOUR_SECRET_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ national_id: "00000000" }),
  }
);
const data = await response.json();
import requests

response = requests.post(
    "https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_basic/",
    headers={
        "x-access-token": "YOUR_SECRET_KEY",
        "Content-Type": "application/json",
    },
    json={"national_id": "00000000"},
)
data = response.json()

Response

200 OK

FieldTypeDescription
data.First_NamestringCustomer’s first name
data.SurnamestringCustomer’s surname
data.Other_NamestringOther names
data.Genderstring"M" or "F"
data.Citizenshipstringe.g., "Kenyan"
data.Date_of_BirthstringDate of birth
data.Date_of_IssuestringID issue date
data.Place_of_BirthstringPlace of birth including district
data.Place_of_LivestringRegistered address
data.PhotostringBase64-encoded customer photo
data.ErrorOcurredbooleanfalse on success
{
  "status": "success",
  "data": {
    "Gender": "M",
    "Surname": "Leo",
    "First_Name": "Joe",
    "Other_Name": "Doe",
    "Citizenship": "Kenyan",
    "ErrorOcurred": false,
    "Date_of_Birth": "2000-09-20 12:00:00 AM",
    "Date_of_Issue": "1/27/2000 12:00:00 AM",
    "Place_of_Live": "BOX 12345-00800 NAIROBI\nKAREN\nLOCATION - LANGATA",
    "Place_of_Birth": "NAIROBI\nDISTRICT - STAREHE",
    "Photo": "<base64-encoded-jpeg>"
  },
  "message": "National ID Basic details retrieved successfully"
}

400 Bad Request

Returned when the ID number is missing, malformed, or not found.
{
  "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."
}

Authorizations

x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
id_number
string
required

Kenyan national ID number

Example:

"12345678"

Response

National ID verified