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"
}
'
{
  "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 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"}'

​
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