Ghana Card / Voter ID

Verify a Ghana Card or voter ID. Ghana Card (default) requires a Personal ID in GHA-#########-# format; document numbers are not accepted. Send id_type=voter to look up a voter ID.

Test data

Sandbox test data

Use these values against the sandbox host. Click a value to copy it.

Sample Ghana Card (fictional)

Sample voter number (fictional)

Request

POST/api/v1/id/gh

{{baseUrl}}/api/v1/id/gh

Header

Header	Type	Description
Authorization	string	`Bearer YOUR_ACCESS_TOKEN` from the OAuth client-credentials flow
Content-Type	string	application/json

Body Parameters

Parameter	Type	Description	Required
id_number	string	Ghana Card Personal ID (default) or voter number when id_type=voter	required
id_type	string	"card" (default) or "voter"	optional
full_name	string	Optional for voter lookups	optional
is_new_id	boolean	Optional Ghana flag echoed in the response	optional
consent	boolean	Must be true — confirms data-subject consent to perform this verification	required
customer_number	string	Optional reference for your own tracking (max 255 characters)	optional

Ghana Card (default)

Sample request body for Ghana Card (default):

Sample dataSample request body

{
  "id_number": "GHA-123456789-0",
  "consent": true
}

Sample response for Ghana Card (default):

200 OKSample dataSample response

{
  "success": true,
  "response_code": 200,
  "message": "Ghana ID details fetched successfully",
  "country": "gh",
  "data": {
    "id_number": "GHA-123456789-0",
    "voter_number": "GHA-123456789-0",
    "first_name": "Kwame",
    "last_name": "Mensah",
    "name": "Kwame Mensah",
    "gender": "Male",
    "full_name": "Kwame Mensah",
    "is_new_id": null,
    "valid": true
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

id_type=voter

Sample request body for id_type=voter:

Sample dataSample request body

{
  "id_number": "123456789",
  "id_type": "voter",
  "consent": true
}

Sample response for id_type=voter:

200 OKSample dataSample response

{
  "success": true,
  "response_code": 200,
  "message": "Ghana ID details fetched successfully",
  "country": "gh",
  "data": {
    "id_number": "123456789",
    "voter_number": "123456789",
    "first_name": "Kwame",
    "last_name": "Mensah",
    "name": "Kwame Mensah",
    "gender": "Male",
    "full_name": "Kwame Mensah",
    "is_new_id": false,
    "valid": true
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

Field	Type	Description
success	boolean	Whether the request succeeded
response_code	number	Application response code (typically mirrors HTTP)
message	string	Human-readable status message
data	object	Payload for the verified resource
request_id	string	UUID for support and audit trails
country	string	Country code — always "gh" for this route
data.id_number	string	Personal ID or voter number
data.voter_number	string	Voter number when present
data.first_name	string	Given name
data.last_name	string	Surname
data.name	string	Full display name
data.gender	string	Gender
data.full_name	string	Same as name
data.is_new_id	boolean	Optional Ghana new-ID flag
data.valid	boolean	Whether the ID is valid

Error codes

Standard Peleza HTTP / response_code values (same across all API calls). Validation message text is endpoint-specific. Full reference: Error Codes.

Code	When	Billed?
200	Ghana ID details returned successfully	Yes
400	Validation — missing/invalid id_number, consent (must be true), or Ghana-specific fields	No
401	Missing or invalid Bearer token	No
402	Insufficient wallet balance or credit limit	No
403	No active wallet or billing profile (or service not enabled)	No
404	Ghana ID not found — or unsupported country	Yes for ID-not-found; No for unsupported country
408	Upstream timeout / service error	No
429	Rate limited	No
502	Upstream bad or unreadable response	No
503	Upstream connection unavailable	No

400 — validation

400Sample data400 — validation

{
  "success": false,
  "response_code": 400,
  "message": "Ghana Card requires a Personal ID (GHA-#########-#), not a document number",
  "country": "gh",
  "errors": {
    "id_number": "Ghana Card requires a Personal ID (GHA-#########-#), not a document number"
  },
  "data": null,
  "request_id": "550e8400-e29b-41d4-a716-446655440010"
}

404 — ID not found

404Sample data404 — ID not found

{
  "success": false,
  "response_code": 404,
  "message": "Ghana ID not found",
  "description": "There is no information for requested search parameters",
  "country": "gh",
  "data": null,
  "request_id": "550e8400-e29b-41d4-a716-446655440013"
}

Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.