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

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

​
Body Parameters

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

FieldTypeDescription
data.FullNamestringFull name
data.FirstNamestringFirst name
data.LastNamestringLast name
data.OtherNamesstringOther names
data.DOBstringDate of birth (YYYY-MM-DD)
data.GenderstringGender
data.PhoneNumberstringRegistered phone number
data.AddressstringRegistered address
data.CountrystringCountry
data.IDNumberstringGhana Card number
data.IssuanceDatestringCard issue date
data.ExpirationDatestringCard expiry date
data.Secondary_ID_NumberstringSecondary identification number
data.PhotostringBase64-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