Skip to main content

Offsite Integration

Offsite Verification means Shufti Pro doesn't interact directly with the end-user. The task of collecting and providing verification data lies with the Shufti Pro customer. In this process, the client shares customer data with Shufti Pro, which then employs diverse data sources to verify the information.

caution

Only passive verifications are performed in Offsite verification.


Given below is the flow for eIDV verification for offsite customers.

eidv_offsite

Parameters and Descriptions

The parameters mentioned below are applicable for both Onsite and Offsite verifications in eIDV service.

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 the 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: 3 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
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.
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.
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.
ekycRequired: Yes
Type: Object
eIDV/eKYC refers to the process of verifying the identity of an individual electronically. The eIDV is commonly used by businesses and institutions to comply with regulations requiring them to verify the identity of their customers.
allow_fallbackRequired: No
Type: boolean
Accepted Values: 0, 1
This service key corresponds to fallback onsite kyc verification. If onsite electronic identity verification fails, users will presented the option to choose basic KYC for the verification process. allow_fallback can be sent inside the ekyc object with value 0 or 1.

Run in Postman


//POST / HTTP/1.1
//Host: api.shuftipro.com
//Content-Type: application/json
//Authorization: Basic NmI4NmIyNzNmZjM0ZmNlMTlkNmI4WJRTUxINTJHUw==
{
"reference" : "1234567",
"callback_url" : "http://www.example.com/",
"email" : "[email protected]",
"country" : "BR",
"language" : "EN",
"ekyc" : {
"national_id": "40442820135"
}
}

Request Payloads for Offsite Verifications

Loading...

note

For more detailed information of offsite responses click here