Ghana

Passport

post

Government database lookup API

Header parameters

AuthorizationstringRequired

Bearer token

Body

application/json

documentNumberstring · min: 1Required

firstNamestring · min: 1Required

lastNamestring · min: 1Required

middleNamestring · min: 1Required

dateOfBirthstring · min: 1Required

yyyy-MM-dd

Pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}

Responses

200

OK

application/json

faceImagestringOptional

Base64 encoded face image of the user

documentNumberstringOptional

firstNamestringOptional

lastNamestringOptional

middleNamestringOptional

dateOfBirthstringOptional

dateOfBirthFormattedstringOptional

ISO-8601 format yyyy-MM-dd

genderstringOptional

issueDatestringOptional

issueDateFormattedstringOptional

ISO-8601 format yyyy-MM-dd

dateOfExpirystringOptional

dateOfExpiryFormattedstringOptional

ISO-8601 format yyyy-MM-dd

placeOfBirthstringOptional

placeOfIssuestringOptional

firstNameMatchbooleanOptional

lastNameMatchbooleanOptional

middleNameMatchbooleanOptional

dateOfBirthMatchbooleanOptional

400

Bad Request: Missing required input or invalid format

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

429

Too Many Requests

500

Internal Server Error: Unexpected error

503

Service unavailable: Government database not available

post

/api/v2/id/lookup/gha/passport

HTTPcURLJavaScriptPython

POST /api/v2/id/lookup/gha/passport HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "documentNumber": "text",
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "dateOfBirth": "text"
}

{
  "faceImage": "text",
  "documentNumber": "text",
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "dateOfBirth": "text",
  "dateOfBirthFormatted": "text",
  "gender": "text",
  "issueDate": "text",
  "issueDateFormatted": "text",
  "dateOfExpiry": "text",
  "dateOfExpiryFormatted": "text",
  "placeOfBirth": "text",
  "placeOfIssue": "text",
  "firstNameMatch": true,
  "lastNameMatch": true,
  "middleNameMatch": true,
  "dateOfBirthMatch": true
}

Voter ID

post

Government database lookup API

Header parameters

AuthorizationstringRequired

Bearer token

Body

application/json

voterIdstring · min: 1Required

fullNamestring · min: 1Required

Responses

200

OK

application/json

faceImagestringOptional

Base64 encoded face image of the user

documentNumberstringOptional

fullNamestringOptional

fullNameMatchbooleanOptional

genderstringOptional

pollingStationstringOptional

registrationDatestringOptional

registrationDateFormattedstringOptional

ISO-8601 format yyyy-MM-dd

400

Bad Request: Missing required input or invalid format

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

429

Too Many Requests

500

Internal Server Error: Unexpected error

503

Service unavailable: Government database not available

post

/api/v2/id/lookup/gha/voter/id

HTTPcURLJavaScriptPython

POST /api/v2/id/lookup/gha/voter/id HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "voterId": "text",
  "fullName": "text"
}

{
  "faceImage": "text",
  "documentNumber": "text",
  "fullName": "text",
  "fullNameMatch": true,
  "gender": "text",
  "pollingStation": "text",
  "registrationDate": "text",
  "registrationDateFormatted": "text"
}

SSNIT

post

Government database lookup API

Header parameters

AuthorizationstringRequired

Bearer token

Body

application/json

socialSecurityNumberstring · min: 1Required

fullNamestring · min: 1Required

dateOfBirthstring · min: 1Required

yyyy-MM-dd

Pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}

Responses

200

OK

application/json

faceImagestringOptional

Base64 encoded face image of the user

socialSecurityNumberstringOptional

fullNamestringOptional

dateOfBirthstringOptional

dateOfBirthFormattedstringOptional

ISO-8601 format yyyy-MM-dd

serialNumberstringOptional

genderstringOptional

fullNameMatchbooleanOptional

dateOfBirthMatchbooleanOptional

400

Bad Request: Missing required input or invalid format

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

429

Too Many Requests

500

Internal Server Error: Unexpected error

503

Service unavailable: Government database not available

post

/api/v2/id/lookup/gha/ssnit

HTTPcURLJavaScriptPython

POST /api/v2/id/lookup/gha/ssnit HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "socialSecurityNumber": "text",
  "fullName": "text",
  "dateOfBirth": "text"
}

{
  "faceImage": "text",
  "socialSecurityNumber": "text",
  "fullName": "text",
  "dateOfBirth": "text",
  "dateOfBirthFormatted": "text",
  "serialNumber": "text",
  "gender": "text",
  "fullNameMatch": true,
  "dateOfBirthMatch": true
}

Driving License

post

Government database lookup API

Header parameters

AuthorizationstringRequired

Bearer token

Body

application/json

licenseNumberstring · min: 1Required

fullNamestring · min: 1Required

dateOfBirthstring · min: 1Required

yyyy-MM-dd

Pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}

Responses

200

OK

application/json

faceImagestringOptional

Base64 encoded face image of the user

licenseNumberstringOptional

fullNamestringOptional

dateOfBirthstringOptional

dateOfBirthFormattedstringOptional

ISO-8601 format yyyy-MM-dd

dateOfExpirystringOptional

dateOfExpiryFormattedstringOptional

ISO-8601 format yyyy-MM-dd

issueDatestringOptional

issueDateFormattedstringOptional

ISO-8601 format yyyy-MM-dd

certificateDatestringOptional

pinstringOptional

fullNameMatchbooleanOptional

dateOfBirthMatchbooleanOptional

400

Bad Request: Missing required input or invalid format

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

429

Too Many Requests

500

Internal Server Error: Unexpected error

503

Service unavailable: Government database not available

post

/api/v2/id/lookup/gha/dl

HTTPcURLJavaScriptPython

POST /api/v2/id/lookup/gha/dl HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "licenseNumber": "text",
  "fullName": "text",
  "dateOfBirth": "text"
}

{
  "faceImage": "text",
  "licenseNumber": "text",
  "fullName": "text",
  "dateOfBirth": "text",
  "dateOfBirthFormatted": "text",
  "dateOfExpiry": "text",
  "dateOfExpiryFormatted": "text",
  "issueDate": "text",
  "issueDateFormatted": "text",
  "certificateDate": "text",
  "pin": "text",
  "fullNameMatch": true,
  "dateOfBirthMatch": true
}