Countries & ID types

When creating a verification you pass a country and an idType. This page lists the supported values.

The authoritative list for your organization comes from GET /config — it returns only the ID types enabled for your account and their feature flags. Use the catalog below for reference; use /config at runtime.

Supported countries

NG (Nigeria), GH (Ghana), KE (Kenya), ZA (South Africa), CI (Côte d'Ivoire).

ID types by country

CountryidType values
NGbvn, bvn-premium, nin, vnin, drivers-license, passport, pvc
GHghana-card, voters, drivers-license, ssnit, passport
KEnational-id, passport
ZAnational-id, passport
CIcni, residence-card

ID type identifiers are lowercase and hyphenated (e.g. drivers-license, not drivers_license).

Capture requirements

ID types fall into two groups, which determines what you must capture and upload.

Number-only IDs

Verified from the ID number alone — no document scan required. You may still run a liveness/selfie step if enabled.

CountryNumber-only IDs
NGbvn, nin, vnin

For these, send idNumber and (optionally) a selfie / livenessVideo media ID.

Document IDs

Every other ID type requires a document scan. Some need both sides:

CaptureIDs
Front onlyAll document IDs not listed below
Front and backNG: drivers-license, pvc · GH: ghana-card, voters, drivers-license · KE: national-id · ZA: national-id · CI: cni, residence-card

For document IDs, upload the relevant files (documentFront, documentBack, selfie, …) and reference their mediaIds in the verify request.

Feature flags

Each enabled ID type from GET /config carries three feature flags:

FeatureMeaning
documentVerificationA document image is captured and checked.
livenessCheckA selfie/liveness step runs and is face-matched to the document.
govDbCheckThe ID is validated against the government database.

Branch your capture flow on these flags so you never ask the user for something the org hasn't enabled. Manage which ID types are enabled under Settings → Organization → ID Types.