# VKYC Link Generation

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/partner/enKashCard/vkyc/link:
    get:
      summary: VKYC Link Generation
      deprecated: false
      description: >+
        :::highlight purple 📌

        This endpoint generates a secure, time-bound VKYC (Video KYC) link that
        allows a user to complete identity verification. The unique VKYC session
        can be shared via SMS, email, or shown within your application. Use this
        to onboard a user as a Full KYC wallet holder or to upgrade KYC level
        for access to full PPI limits.


        **Purpose**

        - Create a VKYC session for a specific user.

        - Provide a secure, time-limited URL for completing identity
        verification, including video capture, document submission, and liveness
        checks.

        :::



        :::caution[]

        Note: VKYC is only available between 10 AM TO 6 PM, Working Days 

        :::


      tags:
        - Wallet/APIs - Wallet/Wallet Setup
      parameters:
        - name: enKashCardId
          in: query
          description: ''
          required: true
          example: EKCHUZJWZW
          schema:
            type: string
        - name: partnerId
          in: header
          description: ''
          required: true
          example: CRM338L2H
          schema:
            type: string
        - name: Authorization
          in: header
          description: ''
          required: true
          example: ••••••
          schema:
            type: string
        - name: Cookie
          in: header
          description: ''
          required: true
          example: >-
            _cfuvid=jS8C5lxGW4Q6FRWotUQnMGhbxbpGmvk3fGg1kdmq4WM-1752680737979-0.0.1.1-604800000;
            JSESSIONID=0358753FB975001E868ABA71D2AA2204
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
                  payload:
                    type: object
                    properties:
                      enkashCardId:
                        type: string
                        description: Wallet ID
                      kycStatus:
                        type: string
                        description: Kyc Status
                      kycSubStatus:
                        type: string
                        description: Kyc Sub Status
                      kycLink:
                        type: string
                        description: Vkyc Link
                      kycExpiryDays:
                        type: integer
                        description: Vkyc link expiry days
                    required:
                      - enkashCardId
                      - kycStatus
                      - kycSubStatus
                      - kycLink
                      - kycExpiryDays
                    x-apidog-orders:
                      - enkashCardId
                      - kycStatus
                      - kycSubStatus
                      - kycLink
                      - kycExpiryDays
                required:
                  - code
                  - message
                  - payload
                x-apidog-orders:
                  - code
                  - message
                  - payload
              examples:
                '1':
                  summary: Success
                  value:
                    code: 0
                    message: Success
                    payload:
                      enkashCardId: EKCHUZJWZW
                      kycStatus: >-
                        EnumModel(name=MIN_KYC_VERIFIED, label=Min Kyc Verified,
                        description=null)
                      kycSubStatus: >-
                        EnumModel(name=VKYC_IN_PROGRESS, label=VKYC In Progress,
                        description=null)
                      kycLink: >-
                        https://investor-onboarding-preproduction.signzy.tech/encash_preprod/6811e8e00e53e2001c75059b/1b66af3a5ac0663e0ce927a63c0aad382da284599b18e8ebd78f3fd2a97f45de1154d88c232c98fe/eMain?ns=encash_preprod
                      kycExpiryDays: 1
                '2':
                  summary: Failure
                  value:
                    response_code: 1
                    response_message: Kyc Sub Status is invalid
                    payload: Kyc Sub Status is invalid
          headers: {}
          x-apidog-name: Success
        '422':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  response_code:
                    type: integer
                  response_message:
                    type: string
                  payload:
                    type: string
                required:
                  - response_code
                  - response_message
                  - payload
          headers: {}
          x-apidog-name: Failure
      security:
        - bearer: []
      x-apidog-folder: Wallet/APIs - Wallet/Wallet Setup
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-19202037-run
components:
  schemas: {}
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```