Skip to content
Lira APILira API

Verifications

Verify a bank account

post/verify/account

Verify a bank account number and retrieve the account holder's name and details. Supports sync and async modes.

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

accountNumberstringrequired

Bank account number. Digits-only for African corridors; alphanumeric allowed for CN/GB.

bankCodestringrequired

The receiving institution's routing code. The exact form depends on the country: for the UK this is the 6-digit sort code; for some corridors it is the bank's BIC/SWIFT code; for others it is the local bank/clearing code. Supply whichever routing code applies to the destination country in this single field.

countrystringrequired

ISO 3166-1 alpha-2 country code. Supported: NG, GH, ZM, TZ, ET, GB, CN.

Options: NGGHZMTZETGBCN

accountNamestring

Claimed account holder name to match against the bank record. Required for GB and CN.

accountHolderTypestring

Required for CN — INDIVIDUAL or BUSINESS.

Options: INDIVIDUALBUSINESS

identifiersobject[]

Corridor-specific identifiers for the account holder. For a business account in some corridors, include a BUSINESS_REGISTRATION entry with the entity's registration code (e.g. an 18-character Uniform Credit Code).

Show child attributes
typestringrequired

Options: BUSINESS_REGISTRATION

valuestringrequired
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

Unique verification ID

statusstringrequired

Options: pendingsuccessfailederrorinconclusive

verificationTypestringrequired

Options: ACCOUNT_NUMBER

identifierstringrequired

The account 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

accountNumberstring | nullrequired
accountNamestring | nullrequired

Account holder name as returned by the registry

bankCodestring | nullrequired
bankNamestring | nullrequired
addressobject | nullrequired

Customer address (when returned by registry, mostly NG)

Show child attributes
townstring
lgastring

Local government area (Nigeria)

statestring
streetstring
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