Request
Sample Request
{
"reference":"sp-bc-prod-gBuRaBK0",
"country":"",
"language":"en",
"callback_url":null,
"redirect_url":"https://backoffice.shuftipro.com/demo-redirect",
"verification_mode":"any",
"ekyc":{
},
"email":null,
"show_consent":"1",
"decline_on_single_step":"1",
"manual_review":"0",
"show_privacy_policy":"1",
"show_results":"1",
"show_feedback_form":"1",
"allow_na_ocr_inputs":"0",
"ttl":60,
"enhanced_originality_checks":"0"
}
Common Parameters
| Parameters | Description |
|---|---|
| reference | Required: 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. |
| country | Required: 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. |
| language | Required: 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. |
| Required: No Type: string Minimum: 6 characters Maximum: 128 characters This field represents email of the end-user. | |
| callback_url | Required: 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_url | Required: 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_mode | Required: 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. |
| show_consent | Required: No Type: string Accepted Values: 0, 1 Default Value: 1 If enabled, it shows the Shufti Pro terms and conditions to the user at the start of the verification. |
| allow_na_ocr_inputs | Required: 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_step | Required: 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_privacy_policy | Required: No Type: string Accepted Values: 0, 1 Default Value: 1 This parameter displays data privacy policy to end-user after the verification process is completed. If the value is set 1, the data privacy policy will be displayed to end-user. If the value is set 0, the data privacy policy will not be displayed. Under the GDPR, we acknowledge the end-users right to request for data deletion therefore the default value is 1 but you can set it to 0 if you’ve another alternative mechanism in place. |
| show_results | Required: 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_form | Required: 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. |
| manual_review | Required: 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_checks | Required: 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. |
| ttl | Required: No Type: int Minimum: 60 Give a numeric value for minutes that you want the verification url to remain active. |
Onsite Verification
On-site verification means that Shufti Pro will be interacting directly with end-user and will be responsible for data collection in order to perform Identity verification. Shufti Pro customer will only be notified about the verification status via Shufti Pro Back Office.
NOTE: In onsite verification, Shufti Pro customers will make an API call, and will receive a verification URL in the response. The end-users will be redirected to the URL and Shufti Pro’s AI technology will perform verification, interacting directly with the end-users.Given below is the flow for EIDV verification for onsite customers.
Verification Request
Payload
{
"ekyc": {
}
}
Calling an E-IDV API
Clients need to send an API Request to the server with the parameters mentioned below.
| Parameters | Description |
|---|---|
| eKYC | Required: No Type: array eKYC refers to the process of verifying the identity of an individual or business electronically. E-IDV is commonly used by businesses and institutions to comply with regulations requiring them to verify the identity of their customers. |
Offsite Verification
Offsite Verification means that Shufti Pro will not be interacting with end-user and Shufti Pro customer will be responsible to collect and provide verification data.
Verification Request
Payload
{
"ekyc": {
"service_data": {
"address": {
"addressLine1": "121 CORAL SANDS PL NE",
"postalCode": "A2w 1J2",
"locality": "Calgary",
"countryCode": "CA",
"province": "",
"thoroughfare": "",
"houseNumberAddition": "",
"houseNumber": ""
},
"identity": {
"completename": "John Doe",
"surname_first": "",
"givenfullname": "",
"nationalid": "12345678",
"dob": "07/11/2000"
},
"phone": {
"phone_number": "+412345678900"
},
"email": {
"full_email_address": "[email protected]"
}
}
}
}
Calling an E-IDV API
Clients need to send an API Request to the server with the parameters mentioned below.
| Parameters | Description |
|---|---|
| eKYC | Required: No Type: array eKYC is parameter to perform ekyc/eidv verification. it refers to the process of verifying the identity of an individual or business electronically. E-IDV is commonly used by businesses and institutions to comply with regulations requiring them to verify the identity of their customers. |
| Service Data | Required: No Type: array Service data refers to the user's data that client will provide to perform user's verification electronically. |