Status Codes and Templates

This page explains the descriptions and possible values for VKYC request and response parameters.

Status and substatus mapping

The following table lists the possible status and substatus combinations and what each means.

Status	Sub Status	Explanation
REJECTED	INSUFFICIENT_BALANCE	The request is rejected due to insufficient balance.
RECEIVED	LINK_GENERATED	The link for Video KYC was generated. Share the link with the user.
PRE_VIDEO_CALL	AADHAAR_VERIFICATION_SUCCESS	The user’s Aadhaar details were verified successfully.
PRE_VIDEO_CALL	AADHAAR_VERIFICATION_FAILED	The user’s Aadhaar details could not be verified. Ask the user to retry.
PRE_VIDEO_CALL	AADHAAR_VERIFICATION_EXPIRED	The Aadhaar verification session expired. Restart the Aadhaar verification.
PRE_VIDEO_CALL	USER_IP_VERIFICATION_SUCCESSFUL	The user’s IP address was verified successfully.
PRE_VIDEO_CALL	USER_PROXY_DETECTED	A proxy or VPN was detected. Ask the user to disable it and retry.
PRE_VIDEO_CALL	TECHNICAL_FAILURE	A technical issue occurred. Retry after some time.
PRE_VIDEO_CALL	USER_LOCATION_VERIFICATION_SUCCESS	The user’s location was verified successfully.
PRE_VIDEO_CALL	USER_LOCATION_OUTSIDE_INDIA	The user is outside India. Reject the request or ask the user to retry from India.
PRE_VIDEO_CALL	USER_AUDIO_CHECK_FAILED	The user’s microphone is not enabled. Ask the user to enable it.
PRE_VIDEO_CALL	USER_VIDEO_CHECK_FAILED	The user’s camera is not enabled. Ask the user to enable it.
PRE_VIDEO_CALL	USER_LOCATION_PERMISSION_DISABLED	The user did not grant location access. Ask the user to allow it.
PRE_VIDEO_CALL	USER_DEVICE_CHECK_SUCCESS	The user’s device passed all checks. Proceed to the agent queue.
PRE_VIDEO_CALL	USER_QUEUED	The user is waiting for an agent to be assigned.
PRE_VIDEO_CALL	SCHEDULED_USER_QUEUED	The user is queued for a scheduled time.
PRE_VIDEO_CALL	NO_AGENT_FOUND	No agent is available. Retry after some time.
PRE_VIDEO_CALL	AGENT_ASSIGNED_TO_USER	An agent has been assigned to the user.
PRE_VIDEO_CALL	USER_MEETING_SCHEDULED	The user’s meeting is scheduled. Notify the user of the scheduled time.
PRE_VIDEO_CALL	USER_MEETING_CANCELLED	The user’s meeting was cancelled. Reschedule or retry.
VIDEO_CALL	USER_ACCEPTED_MEETING	The user accepted the meeting. Start the VKYC process.
VIDEO_CALL	USER_REJECTED_MEETING	The user rejected the meeting. Reschedule or mark it as failed.
VIDEO_CALL	USER_MISSED_MEETING	The user missed the meeting. Reschedule or retry.
VIDEO_CALL	USER_DROPPED_OFF	The user disconnected during the meeting. Log and investigate the issue.
VIDEO_CALL	AGENT_DROPPED_OFF	The agent disconnected during the meeting. Retry or assign another agent.
VIDEO_CALL	USER_ENDED_CALL	The user ended the call. Review the session for completeness.
VIDEO_CALL	AGENT_ENDED_CALL	The agent ended the call. Review the agent’s remarks.
FAILED	TECHNICAL_ERROR	A technical error occurred. Retry or escalate the issue.
AGENT_REVIEWED	AGENT_APPROVED	The agent approved the user’s KYC. Proceed to the auditor stage.
AGENT_REVIEWED	AGENT_REJECTED	The agent rejected the user’s KYC. Notify the user with the rejection reason.
AGENT_REVIEWED	AGENT_UNABLE_TO_VALIDATE	The agent could not validate the user’s KYC. Retry with another agent or session.
AUDITOR_REVIEWED	AUDITOR_APPROVED	The auditor approved the user’s KYC. Mark the verification as complete.
AUDITOR_REVIEWED	AUDITOR_REJECTED	The auditor rejected the user’s KYC. Mark the verification as failed.

User template (user_template)

A user template defines the customer journey and which steps are included in VKYC.
Possible values:

vkyc_user_okyc_template_v1

This template includes mobile OTP authentication, offline Aadhaar verification, and an agent-assisted video call.

• Mobile OTP authentication

  

  Login via OTP

• Offline Aadhaar verification

  

  Offline Aadhaar verification

• Agent-assisted video call

  

  Video call

vkyc_user_template_v1

This template includes mobile OTP authentication and an agent-assisted video call.

• Mobile OTP authentication

  

  Login via OTP

• Agent-assisted video call

  

  Video call

To create a custom user_template, contact your account manager.

Agent template (agent_template)

An agent template defines the steps that an agent must complete during VKYC.
Possible values:

vkyc_agent_template_v1

This is the default template used by agents for the VKYC process.

Default agent template

To create a custom agent_template, contact your account manager.