Skip to main content
A scope is a single kind of check, run by putting its slug in the request path: POST /v1/{scope}. The request body is that scope’s inputs. This section lists every scope, grouped by category, with the fields each one takes.

KYC

Individual identity: NIN, BVN, voter’s card, passport, bank account, phone.

KYB

Business verification: company search, tax ID, TIN.

Vision

Face comparison, face detection, document reading.

AML

Adverse media, PEPs, and sanctions screening.

Reading these pages

For each scope you get its slug (what goes in the path), its inputs (the body fields), and the fields it returns.
The exact fields a scope returns depend on the provider configured for your organization, so the result fields listed are the common ones you can expect, not a frozen schema. Always read the result object by key rather than by position, and tolerate a missing optional field.

A note on availability

Listing a scope here does not mean it is active for your organization. Each scope must be activated before you can run it, and your API key must be allowed to run it. An inactive or disallowed scope returns 403.