Skip to main content
POST
cURL

Authorizations

X-API-KEY
string
header
required

Body

verification_type
enum<string>
required
  • ID - ID Verification
  • DOC - Document Verification
  • BIOMETRIC - Biometrics Verification
Available options:
ID,
DOC,
BIOMETRIC
first_name
string
required
Required string length: 2 - 50
Example:

"John"

last_name
string
required
Required string length: 2 - 50
Example:

"Doe"

date_of_birth
string<date>
required
phone_number
string
required
Pattern: ^\+?[1-9]\d{1,14}$
Example:

"+256000000000"

country_code
string
required
Required string length: 2
Example:

"UG"

id_type
enum<string>
required

*NATIONAL_ID - National ID

Available options:
NATIONAL_ID
middle_name
string
Maximum string length: 50
Example:

"Loe"

email_address
string<email> | null
id_number
string
id_document_front
string<byte>

Base64-encoded front of ID document (Required for Document & Biometrics Verification)

id_document_back
string<byte>

Base64-encoded back of ID document (Required for Document & Biometrics Verification)

selfie
string<byte>

Base64-encoded selfie image (Required for Biometrics Verification)

Response

Successful Operation

provider
string
required
batch_id
string<uuid>
required
status
string
required
type
string
required
used_url
boolean
required
verification_type
string
required
verification_result
string
required
id_type
string
required
created_at
string<date-time>
required
user_input
object
required
id_info
object
required
phone_info
object
required
aml_info
object
required
risk_info
object
required
fraud_insights
object
required
face_match_info
object
required
face_liveness_info
object
required
verification_url
string | null