Skip to content
Lira APILira API

Verifications

Verify an identity document with a live selfie

post/verify/identity/facial

Verify a Ghana Card by matching a live selfie against the cardholder record (liveness + 1:1 face match). Returns the verified identity on a successful match.

Authorization

API key in the X-API-Key header.

Headers

Idempotency-Keystringrequired

Required for verification mutations. Use a unique printable ASCII key per logical request; retries with the same key return the original response.

Body required

countrystringrequired

ISO 3166-1 alpha-2 country code. Facial verification currently supports: GH.

idTypestringrequired

Identity document type. Facial verification currently supports: `ghana_card`.

idNumberstringrequired

Ghana Card number.

imagesobjectrequired

Image inputs. Provide `selfie` for facial verification.

Show child attributes
selfiestringrequired

Base64-encoded live face photo (data URI or raw base64). Required.

documentFrontstring

Reserved for future document verification. Not yet supported.

documentBackstring

Reserved for future document verification. Not yet supported.

modestring

Facial verification is synchronous only.

Options: sync

validationobject

Optional fields to cross-check against the matched identity. A mismatch yields status `inconclusive`.

Show child attributes
firstNamestring
lastNamestring
dateOfBirthstring

Format YYYY-MM-DD

Response

idstringrequired
statusstringrequired

Options: pendingsuccessfailederrorinconclusive

verificationTypestringrequired

Options: GHANA_CARD_FACIAL

idTypestringrequired
countrystringrequired
identifierstringrequired

The Ghana Card number that was verified

verifiedAtstring | nullrequired
verifiedboolean | nullrequired
facialMatchboolean | nullrequired

True when the selfie matched the cardholder (liveness + face match passed)

originstringrequired

Where this verification was initiated. `api` = Lira API key (machine-to-machine). `dashboard` = logged-in dashboard user.

Options: apidashboard

complimentarybooleanrequired

True when this live verification was consumed from your complimentary test allowance instead of being charged to your wallet.

firstNamestring | nullrequired
lastNamestring | nullrequired
middleNamestring | null
dateOfBirthstring | nullrequired
genderstring | nullrequired
placeOfBirthstring | nullrequired
nationalIdstring | null

National identity number recorded by the registry.

cardIdstring | null

The Ghana Card document (card) number.

cardValidFromstring | null
cardValidTostring | null
nationalitystring | null
addressesarray | null

Addresses on file (Hometown and/or Residence).

contactobject | null

Contact details on file.

Show child attributes
emailstring | null
phoneNumbersobject[]
Show child attributes
typestring | null
phoneNumberstring | null
networkstring | null
occupationsarray | null

Occupations recorded by the registry.

imagestring | null

The cardholder's photo on file, as a base64 data URI. May be `null`.

validationobject | nullrequired

Per-field cross-check results (present only when validation fields were submitted)

Show child attributes
firstNameobject
Show child attributes
valuestringrequired
matchbooleanrequired
lastNameobject
Show child attributes
valuestringrequired
matchbooleanrequired
dateOfBirthobject
Show child attributes
valuestringrequired
matchbooleanrequired
errorobject | nullrequired

Populated only when status is `failed` or `error`

Show child attributes
codestringrequired
messagestringrequired