Skip to main content

General Parameters

This section outlines the universal parameters that are integral to every verification request processed by Shufti Pro. These parameters are consistently required across all types of verification services we offer, ensuring a standardized approach to initiating and handling verifications.

ParametersDescription
referenceRequired: Yes
Type: string
Minimum: 6 characters
Maximum: 250 characters
Each request is issued a unique reference ID which is sent back to Shufti Pro’s client with each response. This reference ID helps to verify the request. The client can use this ID to check the status of already performed verifications.
countryRequired: No
Type: string
Length: 2 characters
You may omit this parameter if you don't want to enforce country verification. If a valid country code is provided, then the proofs (images/videos) for document verification or address verification must be from the same country. Country code must be a valid ISO 3166-1 alpha-2 country code. Please consult Supported Countries for country codes.
languageRequired: No
Type: string
Length: 2 characters
If the Shufti Pro client wants their preferred language to appear on the verification screens they may provide the 2-character long language code of their preferred language. The list of Supported Languages can be consulted for the language codes. If this key is missing in the request the system will select the default language as English.
emailRequired: No
Type: string
Minimum: 6 characters
Maximum: 128 characters
This field represents email of the end-user.
callback_urlRequired: No
Type: string
Minimum: 6 characters
Maximum: 250 characters
A number of server-to-server calls are made to Shufti Pro’s client to keep them updated about the verification status. This allows the clients to keep the request updated on their end, even if the end-user is lost midway through the process.

Note: The callback domains must be registered within the Backoffice to avoid encountering a validation error. For registering callback domain, click here.

e.g: example.com, test.example.com
redirect_urlRequired: No
Type: string
Minimum: 6 characters
Maximum: 250 characters
Once an on-site verification is complete, User is redirected to this link after showing the results.

Note: The redirect domains must be registered within the Backoffice to avoid encountering a validation error. For registering redirect domain, click here.

e.g: example.com, test.example.com
verification_modeRequired: No
Type: string
Accepted Values: any, image_only, video_only
This key specifies the types of proof that can be used for verification. In a "video_only” mode, Shufti Pro’s client can only send "Base64” of videos wherein formats of proofs should be MP4 or MOV. "any” mode can be used to send a combination of images and videos as proofs for verification.
allow_offlineRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 1
This parameter allows users to upload images or videos in case of non-availability of a functional webcam.If value: 0, users can capture photos/videos with the camera only.
allow_onlineRequired: No
Type: string
Accepted Values: 0, 1
Default-Value: 1
This parameter allows users to capture image or videos in real-time when internet is available. If value: 0 users can upload already captured images or videos.

Note: if allow_offline: 0 priority will be given to allow_offline.
allow_na_ocr_inputsRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 0
In onsite with ocr verification request, it allows the end-user to select N/A on the OCR form and the verification step will be accepted.
decline_on_single_stepRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 1
If enabled, the verification request will be declined when one of the verification steps is not verified.
show_resultsRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 1
If Value for this parameter is 1, verification result will be displayed to the end-user, showing them whether their verification is accepted or declined. If the value of this parameter is set 0, verification results will not be shown to end-user.
show_feedback_formRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 1
This parameter will work only for onsite verification. If its value is 1 at the end of verification, a feedback form is displayed to the end-user to collect his/her feedback. If it is 0 then it will not display the feedback page to the end-user.
allow_retryRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 1
In onsite verification request, If the document is declined by AI, the end-user can re-upload the document up to 3 times.
manual_reviewRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 0
This key can be used if the client wants to review verifications after processing from Shufti Pro has completed. Once the user submits any/all required documents, Shufti Pro returns a status of review.pending. The client can then review the verification details and Accept OR Decline the verifications from the back-office.
enhanced_originality_checksRequired: No
Type: string
Accepted Values: 0, 1
Default Value: 0
If enabled, this key will be used for performing a strict text edit check on the ID document and decline the verification request if the edited text is found. It will restrict the end-users to scan a QR code to continue the verification journey on mobile if the process is initiated from a Desktop device. This configuration will ensure quality image from the native camera to detect edited text on ID documents.
show_ocr_formRequired: No
Type: boolean
Accepted Values: 0, 1
default value: 1
The default value for this is 1. If this is set to 0, the user will not be shown the OCR form to validate the extracted information. This can be used within the Document, Document Two, and Address service. This value can also be applied to all services collectively. However, preference will be given to the value set within the service.

Note: Setting the value at 0 may cause data inaccuracy as the user does not have option to validate the extracted information.
ttlRequired: No
Type: int
Default: 60
Maximum: 43200
Give a numeric value for minutes that you want the verification url to remain active.

Note: The minimum request timeout duration has been set to 30 minutes, regardless of the TTL value provided in the request.
general-request-parameters
{
  "reference": "",
  "country": "",
  "language": "en",
  "callback_url": null,
  "redirect_url": "",
  "verification_mode": "any",
  "email": "",
  "allow_offline": "1",
  "allow_online": "1",
  "show_consent": "0",
  "decline_on_single_step": "1",
  "manual_review": "0",
  "show_privacy_policy": "0",
  "show_results": "1",
  "show_feedback_form": "0",
  "allow_na_ocr_inputs": "0",
  "allow_retry": "0",
  "ttl": 60,
  "enhanced_originality_checks": "0",
  {
    //services like face, document, ...
  }
}