Skip to content
Lira APILira API

Verifications

Verify a Lipa Na M-Pesa number

post/verify/lipa-na-mpesa

Verify a Kenyan M-Pesa paybill or till number.

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

identifierstringrequired

Paybill or till number to verify

identifierTypestringrequired

Whether the `identifier` is a paybill or till number

Options: paybilltill

countrystring

ISO 3166-1 alpha-2 country code. Defaults to KE.

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: LIPA_NA_MPESA

identifierstringrequired

Paybill or till number

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

organizationShortCodestring | nullrequired
organizationNamestring | nullrequired

Registered organization name

identifierTypestring | nullrequired
errorobject | nullrequired

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

Show child attributes
codestringrequired
messagestringrequired