> ## Documentation Index > Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Generate KYC Link > Use this API to generate a verification form to verify the KYC information of your users digitally. ## OpenAPI ````yaml post /form openapi: 3.0.0 info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html contact: email: developers@cashfree.com name: API Support url: https://discord.com/invite/QdZkNSxXsB title: Cashfree Verification API's. version: '2023-12-18' description: >- Cashfree's Verification APIs provide different types of verification to our merchants. servers: - description: Sandbox Server url: https://sandbox.cashfree.com/verification - description: Production Server url: https://api.cashfree.com/verification security: [] tags: - name: Aadhaar description: Operations related to Aadhaar verification. - name: BAV V2 description: Operations related to Bank account verification v2. - name: PAN description: Operations related to PAN verification. - name: Digilocker description: Operations related to Digilocker verification. - name: E-sign description: Operations related to E-sign verification. - name: Reverse Penny Drop description: Operations related to Reverse Penny Drop verification. - name: UPI Penny Drop description: Operations related to UPI Penny Drop verification. - name: Mobile Penny Drop description: Operations related to Mobile Penny Drop verification. - name: IP description: Operation related to IP verification. - name: UPI description: Operations related to UPI verification. - name: Passport description: Operation related to Passport verification. - name: CIN description: Operation related to CIN verification. - name: Name Match description: Operation related to Name Match verification. - name: PAN to GSTIN description: Operation related to PAN to GSTIN. - name: Face Match description: Operation related to Face Match verification. - name: Voter ID description: Operation related to Voter ID verification. - name: Reverse Geocoding description: Operation related to Reverse Geocoding. - name: Vehicle RC description: Operation related to Vehicle RC verification. - name: Driving License description: Operation related to Driving License verification. - name: GSTIN description: Operation related to GSTIN verification. - name: Account Aggregator description: Operations related to Account aggregator. - name: OTPLess description: Operations related to OTPLess Verification. - name: 1-Click description: Operations related to 1-Click. - name: Smart OCR description: Operations related to Smart OCR. - name: Geocoding description: Operations related to Geocoding. - name: Udyam description: Operation related to Udyam verification. - name: PAN to Udyam description: Operation related to PAN to Udyam. paths: /form: post: tags: - Generate KYC Link summary: Generate KYC Link description: >- Use this API to generate a verification form to verify the KYC information of your users digitally. operationId: VrsGenerateKYCLink parameters: - $ref: '#/components/parameters/x_cf_signature' requestBody: $ref: '#/components/requestBodies/GenerateKYCLinkRequest' responses: '200': $ref: '#/components/responses/GenerateFormLinkResponse' '400': $ref: '#/components/responses/Response400KYCLinkGeneration' '401': $ref: '#/components/responses/Response401' '403': $ref: '#/components/responses/Response403' '409': $ref: '#/components/responses/Response409DuplicateId' '422': $ref: '#/components/responses/Response422' '429': $ref: '#/components/responses/Response429' '500': $ref: '#/components/responses/Response500' security: - XClientID: [] XClientSecret: [] components: parameters: x_cf_signature: description: >- Send the signature if two-factor authentication is selected as Public Key. [More details](https://www.cashfree.com/docs/api-reference/vrs/getting-started#2fa-api-signature-generation). name: x-cf-signature in: header required: false schema: type: string example: '' requestBodies: GenerateKYCLinkRequest: description: Find the request parameters for Generate KYC Link. required: true content: application/json: schema: $ref: '#/components/schemas/GenerateKYCLinkRequestSchema' responses: GenerateFormLinkResponse: description: Response Body for Generate KYC Link API. content: application/json: schema: $ref: '#/components/schemas/GenerateFormLinkResponseSchema' Response400KYCLinkGeneration: description: Validation errors for Generate KYC Link API. content: application/json: schema: $ref: '#/components/schemas/ErrorResponseSchema' examples: Verification ID Missing: $ref: '#/components/examples/VerificationIdMissing' Verification ID With Special Chars: $ref: '#/components/examples/VerificationIdWithSpecialCharacter' Verification_id Character Limit Exceeded: value: type: validation_error code: verification_id_length_exceeded message: verification_id can include a maximum of 50 characters. Name Invalid: value: type: validation_error code: name_value_invalid message: name should only contains alphanumeric, space, dot and hyphen. Template Name Invalid: value: type: validation_error code: Bad request, please check API documentation message: template name should be valid Expiry Date Invalid: value: type: validation_error code: REQUEST_INVALID message: Please enter valid expiry date Client ID/Client Secret in Missing: $ref: '#/components/examples/XClientIdMissing' Using-Test-Credentials-in-Prod: $ref: '#/components/examples/UsingTestCredentialsInProd' Response401: description: Invalid client ID and client secret combination. content: application/json: schema: $ref: '#/components/schemas/ErrorResponseSchema' examples: Invalid client ID and client secret combination: value: type: authentication_error code: authentication_failed message: Invalid clientId and clientSecret combination Response403: description: Authentication error (IP not whitelisted). content: application/json: schema: $ref: '#/components/schemas/ErrorResponseSchema' examples: IP not whitelisted: value: type: authentication_error code: ip_validation_failed message: >- IP not whitelisted your current ip is 106.51.91.104.For IP whitelisting assistance, visit our guide at https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification x-cf-signature header missing: value: type: validation_error code: authentication_failed message: x-cf-signature missing in the request header Response409DuplicateId: description: Conflict error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponseSchema' examples: Conflict Error: value: type: validation_error code: verification_id_already_exists message: verification ID already exists Response422: description: >- Validation error because of insufficient balance to process this request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponseSchema' examples: Insufficient balance: value: type: validation_error code: insufficient_balance message: Insufficient balance to process this request Response429: description: Rate limit exceed error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponseSchema' examples: Rate limit error per operation: value: type: rate_limit_error code: too_many_requests_per_operation message: Too many requests for this operation, rate limit reached Rate limit error per IP: value: type: rate_limit_error code: too_many_requests_per_ip message: Too many requests from the IP, rate limit reached Response500: description: Internal error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponseSchema' examples: Internal Server Error: value: type: internal_error code: request_failed message: Unable to process your request. Try again after some time schemas: GenerateKYCLinkRequestSchema: type: object required: - phone - template_name - verification_id properties: name: type: string description: It is the name of the individual. example: John Doe phone: type: string description: It is the phone number of the individual. example: '9999999999' email: type: string description: It is the email address of the individual. example: test@cashfree.com template_name: type: string description: >- It is the name of the template you created using the merchant dashboard. You can also use the default template found there to generate the verification form. The default template is Aadhaar_verification. Using merchant dashboard, customized KYC Link templates can be created. example: Aadhaar_verification link_expiry: type: string description: >- It is the expiry date of the link. Its value can be max 30 days from the current date. example: '2025-06-01' notification_types: type: array description: It is the type(s) of notification used for sending the link. items: oneOf: - $ref: '#/components/schemas/smsString' - $ref: '#/components/schemas/emailString' - $ref: '#/components/schemas/whatsappString' verification_id: type: string description: It is the unique ID you created to identify the KYC link. example: ABC00123 GenerateFormLinkResponseSchema: type: object properties: name: type: string description: It displays the name of the individual. example: John Doe phone: type: string description: It displays the phone number of the individual. example: '9999999999' email: type: string description: It displays the email address of the individual. example: test@cashfree.com verification_id: type: string description: It displays the unique ID you created to identity the form. example: ABC00123 reference_id: type: integer description: >- It displays the unique ID created by Cashfree Payments for reference purposes. example: 235461 form_link: type: string description: It displays the URL of the KYC Link. example: https://forms-test.cashfree.com/verification/Y7tpcan5ksm0 form_status: type: string description: It displays the status of the form. example: RECEIVED ErrorResponseSchema: type: object properties: code: type: string example: x-client-id_missing error: type: object example: ref_id: 102 message: type: string example: x-client-id is missing in the request. description: It displays the outcome of the error. type: type: string example: validation_error description: It displays the type of error. smsString: description: SMS string. type: string example: sms emailString: description: Email string. type: string example: email whatsappString: description: Whatsapp string. type: string example: whatsapp examples: VerificationIdMissing: value: type: validation_error code: verification_id_missing message: verification_id is missing in the request. VerificationIdWithSpecialCharacter: value: type: validation_error code: verification_id_value_invalid message: >- verification_id can include only alphanum, dot, hyphen and underscores. XClientIdMissing: value: type: validation_error code: x-client-id_missing message: x-client-id is missing in the request. UsingTestCredentialsInProd: value: type: validation_error code: x-client-secret_value_invalid message: Client secret belongs to test environment securitySchemes: XClientID: type: apiKey in: header name: x-client-id description: >- Your unique client identifier issued by Cashfree. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys). XClientSecret: type: apiKey in: header name: x-client-secret description: >- The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys). ````