Voter's Card

Extract identity details from a Nigerian Permanent Voter’s Card (PVC).

POST /api/onboarding/document_verification/nigeria/voters_card

Document Verification — Nigeria Voter's Card

cURL

curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/document_verification/nigeria/voters_card \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-access-token: <api-key>' \
  --form document_front=@example-file \
  --form document_back=@example-file \
  --form selfie_image=@example-file

200

{
  "status": "success",
  "data": {
    "valid": true,
    "first_name": "<string>",
    "last_name": "<string>",
    "full_name": "<string>",
    "date_of_birth": "<string>",
    "gender": "<string>",
    "nationality": "<string>",
    "address": "<string>",
    "id_number": "<string>",
    "serial_number": "<string>",
    "id_type": "<string>",
    "document_type": "<string>",
    "document_country": "<string>",
    "expiry_date": "<string>",
    "issue_date": "<string>",
    "is_expired": true,
    "photo": "<string>",
    "extra_fields": {},
    "face_match": {
      "attempted": true,
      "verified": true,
      "decision": "MATCH",
      "confidence_percentage": 123,
      "compare_mode": "COMPARISON_NO_LIVENESS",
      "selfie_image": "<string>",
      "reason": "<string>"
    }
  },
  "message": "Document details retrieved successfully"
}

Verify a customer’s Nigerian Permanent Voter’s Card (PVC) by uploading a photo — no manual voter ID entry required. We read the details and compare the face on the document with a selfie. No liveness check is needed.

This is a two-sided document — supply both document_front and document_back for the most complete extraction.

selfie_image is required — the face extracted from the document is compared against it. This is a still-image comparison (not liveness).

​

Endpoint

POST /api/onboarding/document_verification/nigeria/voters_card

​

Request

​

Headers

Header	Value	Required
x-access-token	Your API secret key	Yes
Content-Type	multipart/form-data	Yes

​

Body Parameters

Parameter	Type	Required	Description
document_front	file	Yes	Photo of the front of the PVC. JPG, PNG or single-page PDF, max 10MB
document_back	file	No	Photo of the back of the PVC. JPG, PNG or single-page PDF, max 10MB
selfie_image	file	Yes	A selfie to compare against the document’s face photo. JPG or PNG, max 5MB

A scanned document can be uploaded as a single-page PDF, for example -F "document_front=@/path/to/scan.pdf".

​

Example

cURL

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/document_verification/nigeria/voters_card" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -F "document_front=@/path/to/pvc_front.jpg" \
  -F "document_back=@/path/to/pvc_back.jpg" \
  -F "selfie_image=@/path/to/selfie.jpg"

​

Response

​

200 OK

Field	Type	Description
status	string	"success" on a successful extraction
data.full_name	string	Extracted full name
data.first_name	string	Extracted first name
data.last_name	string	Extracted last name
data.date_of_birth	string	Date of birth in YYYY-MM-DD format
data.gender	string	Extracted gender
data.address	string	Registered address printed on the card
data.id_number	string	The Voter Identification Number (VIN)
data.serial_number	string	The card’s serial number
data.document_type	string	"voters_card"
data.document_country	string	The country that issued the document, as a two-letter country code: "NG"
data.photo	string	Base64-encoded face photo extracted from the document
data.extra_fields	object	Other fields printed on the card — see below
data.face_match	object	Result of comparing the document’s face against selfie_image — see below
data.face_match.attempted	boolean	Whether a comparison was actually run
data.face_match.verified	boolean | null	true/false if the comparison ran; null if it couldn’t (see Face Match Notes)
data.face_match.decision	string	"MATCH" or "NO_MATCH"
data.face_match.confidence_percentage	number	Match confidence, 0–100
data.face_match.compare_mode	string	"COMPARISON_NO_LIVENESS" means the two photos were compared without a liveness check
data.face_match.selfie_image	string	URL of the uploaded selfie
message	string	Human-readable result summary

{
  "status": "success",
  "data": {
    "valid": true,
    "first_name": "TUNDE",
    "last_name": "AYODELE",
    "full_name": "AYODELE TUNDE",
    "date_of_birth": "2002-02-16",
    "gender": "M",
    "address": "12 ALLEN AVENUE, IKEJA, LAGOS",
    "id_number": "90F5A1B2C3D4E5F6",
    "serial_number": "SN00123456",
    "document_type": "voters_card",
    "document_country": "NG",
    "photo": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
    "extra_fields": {
      "occupation": "ENGINEER",
      "state": "LAGOS",
      "lga": "IKEJA",
      "ward": "WARD 5",
      "polling_unit_code": "PU001234",
      "date_of_registration": "2019-01-15"
    },
    "face_match": {
      "attempted": true,
      "verified": true,
      "decision": "MATCH",
      "confidence_percentage": 92.4,
      "compare_mode": "COMPARISON_NO_LIVENESS",
      "selfie_image": "https://.../selfie.jpg"
    }
  },
  "message": "Document details retrieved successfully"
}

Extra Fields — extra_fields carries whatever else the PVC printed beyond the fields listed above (occupation, state, LGA, ward, polling unit code, registration date, batch/serial numbers). Only fields actually present on the card are included.

Face Match Notes — if the comparison service itself fails, attempted reflects whether a comparison was actually run and verified comes back null with a reason field explaining why — this is different from verified: false, which means the comparison ran and the faces didn’t match. A face-match problem never blocks the underlying document data — the rest of data is still returned.

​

400 Bad Request

{
  "status": "failed",
  "data": [],
  "message": "ID photo is too blurry — please retake in good lighting with a steady hand"
}

​

401 Unauthorized

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

For a full list of error codes, see the Error Codes reference.

Authorizations

x-access-token · string · header · required

Your Adhere API secret key

Body

multipart/form-data

document_front · file · required

Photo of the PVC. JPG, PNG or single-page PDF, max 10MB.

document_back · file

Back of the PVC. Optional, but recommended — extraction may be less complete without it. JPG, PNG or single-page PDF, max 10MB.

selfie_image · file

A selfie to compare against the face extracted from the document. JPG or PNG, max 5MB. Required.

Response

200

application/json

Document details extracted successfully

status · string

Example:

"success"

data · object

Show child attributes

message · string

Example:

"Document details retrieved successfully"