Skip to main content
POST
/
api
/
onboarding
/
uganda_kyc
/
national_id
Uganda National ID
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/uganda_kyc/national_id/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "national_id": "<string>",
  "surname": "<string>",
  "given_name": "<string>",
  "date_of_birth": "1990-01-15",
  "document_id": "<string>"
}
'
{
  "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 Uganda National ID endpoint validates a customer’s National Identification Number against Uganda’s national registry and returns the associated personal details.

​
Endpoint

POST /api/onboarding/uganda_kyc/national_id/

​
Request

​
Headers

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

​
Body Parameters

ParameterTypeRequiredDescription
national_idstringYesThe customer’s Ugandan National Identification Number (e.g. NO0987654321BE)
surnamestringYesCustomer’s surname
given_namestringYesCustomer’s given name
date_of_birthstringYesDate of birth in YYYY-MM-DD format
document_idstringYesDocument ID number

​
Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/uganda_kyc/national_id/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "national_id": "NO0987654321BE",
    "surname": "Doe",
    "given_name": "John",
    "date_of_birth": "1990-01-01",
    "document_id": "1234567890"
  }'

​
Response

​
200 OK

FieldTypeDescription
data.national_idstringNational ID number
data.surnamestringCustomer’s surname
data.given_namestringCustomer’s given name
data.date_of_birthstringDate of birth
data.genderstringGender
data.nationalitystringNationality
{
  "status": "success",
  "data": {
    "national_id": "NO0987654321BE",
    "surname": "Doe",
    "given_name": "John",
    "date_of_birth": "1990-01-01",
    "gender": "Male",
    "nationality": "Ugandan"
  },
  "message": "National ID details retrieved successfully"
}

​
400 Bad Request

{
  "status": "failed",
  "data": [],
  "message": "Missing required fields"
}

​
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
​
national_id
string
required
​
surname
string
required
​
given_name
string
required
​
date_of_birth
string<date>
required
Example:

"1990-01-15"

​
document_id
string
required

Document serial number from the physical card

Response

National ID verified