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>"
}
'import requests
url = "https://adhere-api.smartcomply.com/api/onboarding/uganda_kyc/national_id/"
payload = {
"national_id": "<string>",
"surname": "<string>",
"given_name": "<string>",
"date_of_birth": "1990-01-15",
"document_id": "<string>"
}
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({
national_id: '<string>',
surname: '<string>',
given_name: '<string>',
date_of_birth: '1990-01-15',
document_id: '<string>'
})
};
fetch('https://adhere-api.smartcomply.com/api/onboarding/uganda_kyc/national_id/', 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/uganda_kyc/national_id/",
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([
'national_id' => '<string>',
'surname' => '<string>',
'given_name' => '<string>',
'date_of_birth' => '1990-01-15',
'document_id' => '<string>'
]),
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/uganda_kyc/national_id/"
payload := strings.NewReader("{\n \"national_id\": \"<string>\",\n \"surname\": \"<string>\",\n \"given_name\": \"<string>\",\n \"date_of_birth\": \"1990-01-15\",\n \"document_id\": \"<string>\"\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/uganda_kyc/national_id/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"national_id\": \"<string>\",\n \"surname\": \"<string>\",\n \"given_name\": \"<string>\",\n \"date_of_birth\": \"1990-01-15\",\n \"document_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://adhere-api.smartcomply.com/api/onboarding/uganda_kyc/national_id/")
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 \"national_id\": \"<string>\",\n \"surname\": \"<string>\",\n \"given_name\": \"<string>\",\n \"date_of_birth\": \"1990-01-15\",\n \"document_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "failed",
"data": [
"<unknown>"
],
"message": "<string>"
}{
"status": "failed",
"message": "Authentication credentials were not provided."
}Uganda
Uganda National ID
Verify a customer’s identity using their Ugandan National Identification Number.
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>"
}
'import requests
url = "https://adhere-api.smartcomply.com/api/onboarding/uganda_kyc/national_id/"
payload = {
"national_id": "<string>",
"surname": "<string>",
"given_name": "<string>",
"date_of_birth": "1990-01-15",
"document_id": "<string>"
}
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({
national_id: '<string>',
surname: '<string>',
given_name: '<string>',
date_of_birth: '1990-01-15',
document_id: '<string>'
})
};
fetch('https://adhere-api.smartcomply.com/api/onboarding/uganda_kyc/national_id/', 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/uganda_kyc/national_id/",
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([
'national_id' => '<string>',
'surname' => '<string>',
'given_name' => '<string>',
'date_of_birth' => '1990-01-15',
'document_id' => '<string>'
]),
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/uganda_kyc/national_id/"
payload := strings.NewReader("{\n \"national_id\": \"<string>\",\n \"surname\": \"<string>\",\n \"given_name\": \"<string>\",\n \"date_of_birth\": \"1990-01-15\",\n \"document_id\": \"<string>\"\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/uganda_kyc/national_id/")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"national_id\": \"<string>\",\n \"surname\": \"<string>\",\n \"given_name\": \"<string>\",\n \"date_of_birth\": \"1990-01-15\",\n \"document_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://adhere-api.smartcomply.com/api/onboarding/uganda_kyc/national_id/")
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 \"national_id\": \"<string>\",\n \"surname\": \"<string>\",\n \"given_name\": \"<string>\",\n \"date_of_birth\": \"1990-01-15\",\n \"document_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "failed",
"data": [
"<unknown>"
],
"message": "<string>"
}{
"status": "failed",
"message": "Authentication credentials were not provided."
}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
| Header | Value | Required |
|---|---|---|
x-access-token | Your API secret key | Yes |
Content-Type | application/json | Yes |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
national_id | string | Yes | The customer’s Ugandan National Identification Number (e.g. NO0987654321BE) |
surname | string | Yes | Customer’s surname |
given_name | string | Yes | Customer’s given name |
date_of_birth | string | Yes | Date of birth in YYYY-MM-DD format |
document_id | string | Yes | Document 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
| Field | Type | Description |
|---|---|---|
data.national_id | string | National ID number |
data.surname | string | Customer’s surname |
data.given_name | string | Customer’s given name |
data.date_of_birth | string | Date of birth |
data.gender | string | Gender |
data.nationality | string | Nationality |
{
"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
Your Adhere API secret key
Body
application/json
Response
National ID verified
⌘I

