> ## Documentation Index
> Fetch the complete documentation index at: https://cashfreepayments-d00050e9-handbook-faq-creation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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\_template\_v1

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

<CardGroup cols={3}>
  <Card title="Step 1" icon="mobile" className="max-w-[250px] mx-auto text-center">
    <img src="https://mintcdn.com/cashfreepayments-d00050e9-handbook-faq-creation/nkSs8iR4g98wNXYX/static/secure-id/vkyc/mobile-login.png?fit=max&auto=format&n=nkSs8iR4g98wNXYX&q=85&s=887aa1321305b64a3de114ec99ce51d3" className="max-w-[220px] mx-auto mb-3 border border-gray-300 rounded-lg" alt="Mobile OTP authentication" width="1080" height="1909" data-path="static/secure-id/vkyc/mobile-login.png" />

    <p className="text-sm">Mobile OTP authentication</p>
  </Card>

  <Card title="Step 2" icon="id-card" className="max-w-[250px] mx-auto text-center">
    <img src="https://mintcdn.com/cashfreepayments-d00050e9-handbook-faq-creation/nkSs8iR4g98wNXYX/static/secure-id/vkyc/vkyc-aadhaar-digilocker.png?fit=max&auto=format&n=nkSs8iR4g98wNXYX&q=85&s=750112012e53d71716824b16245c6452" className="max-w-[220px] mx-auto mb-3 border border-gray-300 rounded-lg" alt="Verification via DigiLocker" width="868" height="1586" data-path="static/secure-id/vkyc/vkyc-aadhaar-digilocker.png" />

    <p className="text-sm">Verification via DigiLocker</p>
  </Card>

  <Card title="Step 3" icon="video" className="max-w-[250px] mx-auto text-center">
    <img src="https://mintcdn.com/cashfreepayments-d00050e9-handbook-faq-creation/nkSs8iR4g98wNXYX/static/secure-id/vkyc/vkyc-start-screen.png?fit=max&auto=format&n=nkSs8iR4g98wNXYX&q=85&s=e6c29170317265f74c5f050c833b4818" className="max-w-[220px] mx-auto mb-3 border border-gray-300 rounded-lg" alt="Agent-assisted video call" width="1080" height="1890" data-path="static/secure-id/vkyc/vkyc-start-screen.png" />

    <p className="text-sm">Agent-assisted video call</p>
  </Card>
</CardGroup>

<Note>To create a custom `user_template`, contact your account manager.</Note>

## 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.

<Card title="Default agent template" icon="user" className="max-w-[250px] mx-auto text-center">
  <img src="https://mintcdn.com/cashfreepayments-d00050e9-handbook-faq-creation/nkSs8iR4g98wNXYX/static/secure-id/vkyc/vkyc-agent-template.png?fit=max&auto=format&n=nkSs8iR4g98wNXYX&q=85&s=bf6ea03ff63fb97f88bc672e76f92f85" width="200" height="200" className="mx-auto mb-3 border border-gray-300 rounded-lg shadow-md" alt="Default agent template" width="239" height="410" data-path="static/secure-id/vkyc/vkyc-agent-template.png" />
</Card>

<Note>To create a custom `agent_template`, contact your account manager.</Note>