Verifications
Verify an M-Pesa agent
Verify a Kenyan M-Pesa agent by agent code.
Authorization
API key in the X-API-Key header.
Headers
Idempotency-KeystringrequiredRequired for verification mutations. Use a unique printable ASCII key per logical request; retries with the same key return the original response.
Body required
agentCodestringrequiredM-Pesa agent code to verify
countrystringISO 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
idstringrequiredstatusstringrequiredOptions: pendingsuccessfailederrorinconclusive
verificationTypestringrequiredOptions: MPESA_AGENT
identifierstringrequiredcountrystringrequiredverifiedAtstring | nullrequiredverifiedboolean | nullrequiredoriginstringrequiredWhere this verification was initiated. `api` = Lira API key (machine-to-machine). `dashboard` = logged-in dashboard user.
Options: apidashboard
agentCodestring | nullrequiredagentNamestring | nullrequiredagentAccountstring | nullrequirederrorobject | nullrequiredPopulated only when status is `failed` or `error`
Show child attributes
codestringrequiredmessagestringrequired