Verifications

Verify a phone number

post/verify/phone

Verify a phone number and retrieve the subscriber's details. Ghana requires a networkCode.

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

phoneNumberstringrequired

Phone number in local or E.164 format. 10–15 digits, optional leading `+`.

countrystring

ISO 3166-1 alpha-2 country code. Supported: NG, GH, UG, ZM, SN, CM, BJ, TG, TZ, ET.

Options: NGGHUGZMSNCMBJTGTZET

networkCodestring

Mobile network operator code. Required for Ghana (GH), Tanzania (TZ), Ethiopia (ET), and other listed countries. For ET: TELEBIRR or MPESA.

modestring

`sync` returns the verification result in the response. `async` returns `pending` and delivers the final result via your registered webhooks (configure under `/webhooks`).

Options: syncasync

Response

idstringrequired

statusstringrequired

Options: pendingsuccessfailederrorinconclusive

verificationTypestringrequired

Options: PHONE_NUMBER

identifierstringrequired

The phone number that was verified

countrystringrequired

verifiedAtstring | nullrequired

verifiedboolean | nullrequired

originstringrequired

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

Options: apidashboard

phoneNumberstring | nullrequired

firstNamestring | nullrequired

lastNamestring | nullrequired

middleNamestring | nullrequired

fullNamestring | nullrequired

dateOfBirthstring | nullrequired

identityobject

Show child attributes

idTypestringrequired

Identity document type returned by the registry

Options: NINTIN

idValuestringrequired

Identity document value

errorobject | nullrequired

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

Show child attributes

codestringrequired

messagestringrequired