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="your_client_reference_here"
Required if allow_override field set to 1. This is the client's provided reference ID associated with the transaction creation.
allow_overrideRequired: No
Type: boolean
Accepted values: 1 / 0 (or true / false in JSON requests)
Default: 0
Set to 1 to replace the latest previously enrolled image with the new one for the given client_reference. client_reference is required when this is set to 1.
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 / integer
Accepted values: 1 / 0 (integer) or true / false (boolean)
Default: 0 (false)
Set to 1 or true to wait for the processing result in the same response. Set to 0 or false (or omit it) to receive only the reference_id and fetch the result later.

{
    "client_reference" : "your_client_reference_here",
    "allow_override" : false,
    "enroll_face" : true,
    "wait_for_result" : true

}