Ghana ID Card - Adhere by Smartcomply

Ghana ID Card

curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/ghana_kyc/id_card/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "identification_number": "<string>",
  "id_type": "<string>"
}
'

import requests

url = "https://adhere-api.smartcomply.com/api/onboarding/ghana_kyc/id_card/"

payload = {
    "identification_number": "<string>",
    "id_type": "<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({identification_number: '<string>', id_type: '<string>'})
};

fetch('https://adhere-api.smartcomply.com/api/onboarding/ghana_kyc/id_card/', 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/ghana_kyc/id_card/",
  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([
    'identification_number' => '<string>',
    'id_type' => '<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/ghana_kyc/id_card/"

	payload := strings.NewReader("{\n  \"identification_number\": \"<string>\",\n  \"id_type\": \"<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/ghana_kyc/id_card/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identification_number\": \"<string>\",\n  \"id_type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://adhere-api.smartcomply.com/api/onboarding/ghana_kyc/id_card/")

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  \"identification_number\": \"<string>\",\n  \"id_type\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

POST

api

onboarding

ghana_kyc

id_card

Ghana ID Card

curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/ghana_kyc/id_card/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "identification_number": "<string>",
  "id_type": "<string>"
}
'

import requests

url = "https://adhere-api.smartcomply.com/api/onboarding/ghana_kyc/id_card/"

payload = {
    "identification_number": "<string>",
    "id_type": "<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({identification_number: '<string>', id_type: '<string>'})
};

fetch('https://adhere-api.smartcomply.com/api/onboarding/ghana_kyc/id_card/', 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/ghana_kyc/id_card/",
  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([
    'identification_number' => '<string>',
    'id_type' => '<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/ghana_kyc/id_card/"

	payload := strings.NewReader("{\n  \"identification_number\": \"<string>\",\n  \"id_type\": \"<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/ghana_kyc/id_card/")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identification_number\": \"<string>\",\n  \"id_type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://adhere-api.smartcomply.com/api/onboarding/ghana_kyc/id_card/")

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  \"identification_number\": \"<string>\",\n  \"id_type\": \"<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 Ghana ID Card endpoint validates a Ghana Card number and returns the associated personal details including name, date of birth, address, and photo.

Endpoint

POST /api/onboarding/ghana_kyc/id_card/

Request

Headers

Header	Value	Required
`x-access-token`	Your API secret key	Yes
`Content-Type`	`application/json`	Yes

Body Parameters

Parameter	Type	Required	Description
`identification_number`	string	Yes	The customer’s Ghana Card number (format: `GHA-000000000-0`)

Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/ghana_kyc/id_card/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"identification_number": "GHA-000000000-0"}'

Response

200 OK

Field	Type	Description
`data.FullName`	string	Full name
`data.FirstName`	string	First name
`data.LastName`	string	Last name
`data.OtherNames`	string	Other names
`data.DOB`	string	Date of birth (`YYYY-MM-DD`)
`data.Gender`	string	Gender
`data.PhoneNumber`	string	Registered phone number
`data.Address`	string	Registered address
`data.Country`	string	Country
`data.IDNumber`	string	Ghana Card number
`data.IssuanceDate`	string	Card issue date
`data.ExpirationDate`	string	Card expiry date
`data.Secondary_ID_Number`	string	Secondary identification number
`data.Photo`	string	Base64-encoded ID photo

{
  "status": "success",
  "data": {
    "DOB": "2000-09-20",
    "Photo": "<base64-encoded-jpeg>",
    "Gender": "Male",
    "Address": "OPHELIA JUNCTION, Barimah Close, ESSERESO, BOSOMTWE, ASHANTI, Ghana",
    "Country": "Ghana",
    "FullName": "Joe Leo Doe",
    "IDNumber": "GHA-000000000-0",
    "LastName": "Leo",
    "FirstName": "Joe",
    "OtherNames": "Leo",
    "PhoneNumber": "0000000",
    "IssuanceDate": "2020-08-07",
    "ExpirationDate": "2030-08-07",
    "Secondary_ID_Number": "AQ0000000"
  },
  "message": "Ghana ID Card 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

identification_number

string

required

Ghana Card, Passport, Voter ID, SSNIT, or Driver's License number

id_type

string

required

GhanaCard, Passport, VoterID, SSNIT, or DriversLicense

Response

ID card verified

​Endpoint

​Request

​Headers

​Body Parameters

​Example

​Response

​200 OK

​400 Bad Request

​401 Unauthorized

Authorizations

Body

Response

Endpoint

Request

Headers

Body Parameters

Example

Response

200 OK

400 Bad Request

401 Unauthorized