Verify Entity (KYC)

token*

String

API secret token

entityId

String

Id of the entity being checked.

entityType*

String

Type of entity being checked or verified.

Allowed values: "individual"

isSubjectConsent*

Boolean

Consent of the individual or entity being verified.

Allowed values: true

identity*

Object

Identity document data.

id

String

Unique identifier depending on the type (e.g., BVN, NIN, VNIN, Passport No., etc.).

countryCode*

String

Country code of the identity document (ISO 3166-1 alpha-2).

Size range: 2

idType*

String

Document type code. Must be supported by the country.

mobile

String

Mobile number (used with nin_by_phone).

accountNumber

String

10-digit account number (used with BAV).

bankCode

String

Bank code for BAV verification.

lastName

String

Last name (used with passport verification).

shouldRetrivedNin

Boolean

Whether to fetch linked NIN from BVN.

Default value: false

premiumBVN

Boolean

Enable premium BVN check.

Default value: false

premiumNin

Boolean

Enable premium NIN check.

Default value: false

fullDetails

Boolean

Request extended BVN profile.

Default value: false

metadata

Object

Optional metadata for auditing, tracking, or extensions.

validations

Object

Validation payload for cross-checking identity.

data

Object

Personal info to validate.

firstName

String

First name to validate.

lastName

String

Last name to validate.

dateOfBirth

String

Date of birth to validate.

Allowed values: "YYYY-MM-DD"

selfie

Object

Selfie validation block.

image

String

URL to a selfie image.

Size range: URI

advanced

Boolean

For kenya_scrub - whether to run advanced check. [identity.bankId] Bank ID (Kenya).

bank

String

Bank name (South Africa).

bankBranchCode

String

Required in South African BAV.

accountType

String

Account type (e.g., "Savings", "Current") for ZA BAV.

Default value: Savings

type

String

type (e.g., "old_voter_card", "new_voter_card") for GH voter ID.