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.
3 Click on the newly added workflow, then select the General tab to customize your preferences.
Manage General
(*) Indicates an action to be mandatory.
| Name | Description |
|---|---|
| Display Name* | Set a name to the workflow for easy identification. |
| Description | Summarize the purpose and functionality of this workflow module. |
| Enable | This 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. |
| Skip | Allows 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. |
| Rule | This 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.
Manage Configs
(*) Indicates an action to be mandatory.
| Name | Description |
|---|---|
| Display Camera and Mic Options | Enable 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 Token | Provide an auth token if the endpoint requires secure access. |
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.
Expected Result
Based on the provided configuration, the information that will be fetched for Video KYC includes the following parameters:
| Name | Description |
|---|---|
video_kyc_verified | This indicates whether Video KYC process has been completed. The value will be "True" if the onboarding/verification is successfully completed and "False" if it is not. |
video_kyc_verified_at | Timestamp (in Unix epoch format) indicating when the Video KYC details were verified. |
video_kyc_recorded_video | A URL link to access the recorded video of the Video KYC session. This is generated once the session is successfully completed. |
video_kyc_recorded_video_status | Indicates the status of the recorded video. Possible values include "success" (if the video is properly recorded and stored) or "failed" (if there was an issue with recording or storing the video). |
The response received will include the accurate information mentioned above. Note that, the response values can vary depending on the specific workflow modules.
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:
- Video KYC - User
- Video KYC - Agent
- Begin the flow in an incognito browser, you will be displayed with instructions before joining the meeting.
- 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.
Click JOIN NOW to proceed.
Wait for the KYC agent to allow you into the meeting.
- Once you join, the session will proceed as per the required steps.
- 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.
Once the user starts the flow, the KYC agent meeting link will be sent to the configured endpoint.
Join the meeting via the link sent in the endpoint as the KYC agent.
A prompt will appear asking for microphone and camera access. Grant the required permissions.
Click JOIN NOW to enter.
Then, you will be prompted to allow the user into the meeting. Approve their entry.
Note, only the KYC agent can start the meeting.
- Once the user joins, continue with the session as required.
- When all necessary steps are completed, end the meeting.
Only when the KYC agent ends the meeting will the onboarding/verification be considered successful.
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.
6 Here is a sample response for Video KYC:
{
"request_id": "0c7c03c0-744e-4290-8d02-6c85b0aabc86",
"workflow": "verification",
"user_id": "mark@gmail.com",
"video_kyc_verified": "true/false",
"video_kyc_verified_at": "1742203727",
"video_kyc_recorded_video": "https://api.eztovrfy.com/video-kyc-recordings/xxxxxxxxxxxxx",
"video_kyc_recorded_video_status": "success",
}