Skip to main content
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"
}
'
{
  "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 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

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

​
Body Parameters

ParameterTypeRequiredDescription
national_idintegerYesThe 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

FieldTypeDescription
data.First_NamestringFirst name
data.SurnamestringSurname
data.Other_NamestringOther/middle name
data.GenderstringGender ("M" or "F")
data.Date_of_BirthstringDate of birth
data.CitizenshipstringCitizenship status
data.Date_of_IssuestringID issue date
data.Place_of_BirthstringPlace of birth
data.Place_of_LivestringRegistered place of residence
data.PhotostringBase64-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."
}

Authorizations

​
x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
​
id_number
string
required
Example:

"12345678"

Response

National ID advanced data retrieved