Skip to main content

Video KYC

The Video KYC workflow module enables verification through a real-time video interaction. It confirms the individual's presence, providing a secure and efficient remote verification process.

How to Setup​

1 Go to Workspace > Workflows, and click on the flow created for Video KYC. If you need understanding in creating a workflow, refer to the step-by-step guide here.

2 Hover over the plus (+) symbol and select Workflow. From the list, click Video KYC to add it.

Video KYC

3 Click on the newly added workflow, then select the General tab to customize your preferences.

General

Manage General​

(*) Indicates an action to be mandatory.

NameDescription
Display Name*Set a name to the workflow for easy identification.
DescriptionSummarize the purpose and functionality of this workflow module.
EnableThis toggle is enabled by default. When enabled, the particular workflow module begins its execution. Conversely, if disabled, the workflow module remains inactive and won't proceed.
SkipAllows the user to skip this specific workflow module during execution. When selected, it provides an option to bypass the particular workflow without affecting other modules in the sequence.
RuleThis determines the criteria for triggering the particular workflow module. When the selected rule is evaluated, and is satisfied, the workflow proceeds as provided. If not, the workflow will not be executed. Note: If no rules are set, the workflow defaults to its standard action without any rule. For more information about the rules, refer here.

4 Then, click on the Configs tab to set the necessary configurations.

Configs

Manage Configs​

(*) Indicates an action to be mandatory.

NameDescription
Video KYC ClaimsClaims specify the information that should appear in the generated response. Note that only the selected claims will appear in the final response. The claims for Video KYC are,
Display Camera and Mic OptionsEnable this to show camera and mic controls to the user, allowing them to mute or turn off their camera during the session. If disabled, the camera and mic will be turned on by default with no option for the user to control them.
Hook URL*Provide the endpoint where the agent meeting endpoint will be sent. The data is transmitted via a POST request.
Auth TokenProvide an auth token if the endpoint requires secure access.
Selfie ComparisonEnable this option to perform a face match between the selfie and the image on the ID document.
OCR VerificationEnable this to extract text from the provided ID document image using OCR and verify the extracted details.
Selfie InstructionsProvide instructions to help the user capture a clear, front-facing selfie for verification. Make sure the face is well-lit and visible.
PAN InstructionsGuide the user to hold the PAN card properly, ensuring all information is fully visible, not cropped, and free from blur or glare.
Selfie Comparison InstructionsHelp the user understand how to capture an image of the document in a way that supports accurate face comparison with the selfie.
PAN OCR InstructionsGuide the user to provide a clear image of the PAN card so that both text and photo can be read properly using OCR.

5 After you've configured everything needed, click on the SAVE button.

6 Proceed to attach the workflow to the relevant application for execution. Refer to instructions on how to attach a workflow to an application here.

How it Works​

1 Launch Postman or your preferred API tool and execute the flow by configuring the suitable Method, URL, and Body settings. If you're seeking guidance on how to perform these actions, see here.

2 Upon initiating the API call, a verification request will be sent to your configured Verification Way settings.

In the application's configuration for the selected verification way, please set the "link expiry" to a high value.

3 Based on the request, execute the flow in an incognito browser and follow the prompts to complete the flow.

4 This flow has two perspectives: one for the User and one for the KYC Agent:

  • Begin the flow in an incognito browser, you will be displayed with instructions before joining the meeting.

Instructions

  • Click Start to proceed.

Once Start is clicked, the meeting link will be sent to the KYC agent.

  • A prompt will appear asking for microphone and camera access. Grant the required permissions.

Permissions

  • Click JOIN NOW to proceed.

  • Wait for the KYC agent to allow you into the meeting.

Wait

  • Once you join, the session will proceed as per the required steps.

KYC

  • Follow the instructions given by the KYC agent to complete the verification process.

  • After all necessary steps are completed, the KYC agent will end the meeting.

Note that, the onboarding/verification process is only completed when the KYC agent ends the meeting. If the meeting is not ended, the process remains in a pending state.

5 The verification process is considered complete only when the KYC agent successfully ends the meeting.

If "force onboarding" is enabled in the API request, all users, regardless of status, will be directed to the onboarding flow first, followed by the verification flow if configured.

Completed

6 Here is a sample response for Video KYC:

{ 
  "request_id": "0c7c03c0-744e-4290-8d02-6c85b0aabc86",
  "workflow": "verification",
  "user_id": "mark@gmail.com",
  "vkyc_verified": "true/false",
  "vkyc_selfie_verification_status": "Verified",
  "vkyc_pan_verification_status": "Verified",
  "vkyc_id_type": "PAN",
  "vkyc_dob": "30/11/2000",
  "vkyc_front_ocr_image": "data:image/png;base64,xxxxxxxxxxxxxx",
  "vkyc_selfie_image": "data:image/png;base64,xxxxxxxxxxxxxx",
  "vkyc_verification_status": "Verified",
  "vkyc_recorded_video_status": "success",
  "vkyc_father_name": "ROBERT",
  "vkyc_full_name": "JHON ROBERT",
  "vkyc_verified_at": "1749461614",
  "vkyc_recorded_video": "https://xxxxxxxxxxxxx.eztovrfy.com/xxxxxxxxx",
  "vkyc_id_number": "XXXXXXXXX",
}