Request

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.
email	Required: Yes 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.
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.
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.
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.
allow_offline	Required: 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_online	Required: 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
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.

Verification Request

Payload

{
    "kyi": {
    “questionnaire_type”: “pre_kyc”
    "uuid": [
            "TZJAEG","XYZABC"
        ]
    }
}

Shufti Pro offers its clients a KYI service that helps them collect additional information from their customers. The service allows you to create a KYI-Model that includes multiple questions with different answer types to choose from, including drop-downs, radio buttons, CSV files, text, integers, float values, etc. Shufti Pro’s clients have the option to use KYI with or without KYC service.

The KYI service includes two parts:

1. Creation of a KYI-Model
2. Calling a KYI-Model via API

1. Creation of a KYI-Model

For creating a KYI-Model, the client needs to follow these steps in the back office under the Products Section.

• In the Product listing, you can see the KYI section.
• Click on the Proceed button.
• On the top right side, click the Create New button.
• A new page will open, where you can set the title & description of the KYI-Model.
• Moving forward, you can create multiple questions inside a single KYI-Model.

2. Calling a KYI-Model via API

To use the KYI service and ask the end-users to fill in the KYI-Model, clients need to send an API Request to the server with the following parameters.

NOTE: The KYI service is available for on-site only and before passing the kyi object in the API, please make sure that you have copied the correct UUID from the KYI Section listed in Products Section and the KYI-Model must be active as well.

Parameters	Description
uuid	Required: Yes Type: array Example 1: ["example_uuid_1"] Example 2: ["example_uuid_1”,”example_uuid_2"] The UUID parameter is an array that takes one or multiple UUIDs (max five) in the array to execute the KYI service for your end users.
questionnaire_type	Required: No Type: string Accepted Values: pre_kyc, post_kyc Default-Value: pre_kyc The questionnaire type parameters tell whether you want to execute the KYI for your end-users before KYC (“pre_kyc”) or after KYC (“post_kyc”).