Skip to main content

Common Parameters

This section presents an array of enhanced parameters that can be applied across all services, with the exception of liveness, to streamline request processing. These parameters are meticulously designed to refine the verification process, ensuring a consistent and professional approach to initiating and managing verification flows.

ParametersDescription
client_reference Required: No
Type: string
Minimum: 5 characters
Maximum: 255 characters
Example: client_reference="QWERTY12345"
Required if allow_override field set to 1. This is the client's provided reference ID associated with the transaction creation.
allow_override Required: No
Type: boolean
Default value: 0
Accepted values: 0, 1
The client reference is mandatory if the value of the override key is set as 1. The override key allow the system to replace the latest previous image with the new one against the specified reference number of the client’s reference.
enroll_face Required: No
Type: boolean
Example: : enroll_face=true
Default value: true
If you do not want the system to enroll the face then set the value of the key as false.
wait_for_resultRequired: No
Type: boolean
Default value: true
Accepted values: 0, 1
Set the value of this key as 1 if you want the results of the transaction within the same API request.

{
    “client_reference” : “QWERTY12345“,
    “allow_override” : 0
    "enroll_face" : true
    “wait_for_result” : 1

}