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

# Verify Udyam

> Use this API to verify an Udyam registration using the Udyam reference number. For a valid registration, the response returns enterprise details such as NIC classification and enterprise unit information. 

View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#udyam) and use the information to trigger the validations. The test data can be used only in the sandbox environment.



## OpenAPI

````yaml post /udyam
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:
  /udyam:
    post:
      tags:
        - Udyam
      summary: Verify Udyam
      description: >-
        Use this API to verify an Udyam registration using the Udyam reference
        number. For a valid registration, the response returns enterprise
        details such as NIC classification and enterprise unit information. 


        View the [test
        data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#udyam)
        and use the information to trigger the validations. The test data can be
        used only in the sandbox environment.
      operationId: VrsUdyamVerification
      parameters:
        - $ref: '#/components/parameters/x_cf_signature'
      requestBody:
        $ref: '#/components/requestBodies/UdyamRequest'
      responses:
        '200':
          $ref: '#/components/responses/UdyamResponse'
        '400':
          $ref: '#/components/responses/Response400VoterId'
        '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/Response500V2'
        '502':
          $ref: '#/components/responses/Response502V2'
      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:
    UdyamRequest:
      description: >-
        Find the request parameters to retrieve the information of a Udyam
        number.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UdyamVerificationRequestSchema'
  responses:
    UdyamResponse:
      description: Success response for Udyam verification.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UdyamVerificationResponseSchema'
          examples:
            SUCCESS:
              value:
                verification_id: tfqgzsXu3Z
                reference_id: 3478283
                status: SUCCESS
                udyam_number: UDYAM-UP-43-1234567
                enterprise_name: helloscholar
                owner_name: John Doe
                organization_type: Proprietary
                major_activity: Services
                gender: Male
                social_category: General
                date_of_incorporation: '2020-05-29'
                date_of_commencement: '2020-05-29'
                date_of_udyam_registration: '2022-01-02'
                enterprise_type: Micro
                classification_year: 2024-25
                classification_date: '2025-06-02'
                udyam_certificate_url: UDYAM_CERTIFICATE_PDF_URL
                classification_history:
                  - serial_number: '1'
                    data_year: 2023-24
                    classification_year: 2024-25
                    enterprise_type: Micro
                    classification_date: '2025-06-02'
                  - serial_number: '2'
                    data_year: 2022-23
                    classification_year: 2023-24
                    enterprise_type: Micro
                    classification_date: '2023-05-09'
                  - serial_number: '3'
                    data_year: 2022-23
                    classification_year: 2022-23
                    enterprise_type: Micro
                    classification_date: '2022-06-26'
                split_address:
                  flat: Ground Floor
                  building: 05 Raman Vihar
                  village: Naubasta
                  block: Naubasta
                  street: Naubasta
                  city: Kanpur
                  district: KANPUR NAGAR
                  state: UTTAR PRADESH
                  pincode: '208021'
                  mobile: 70*****210
                  email: helloscholar.edu@gmail.com
                unit_locations:
                  - serial_number: '1'
                    unit_name: hellobanker
                    flat: Ground Floor
                    building: 05 Raman Vihar Naubasta
                    village: KANPUR NAGAR
                    block: KANPUR NAGAR
                    street: 05 Raman Vihar Naubasta Bamba
                    city: Kanpur
                    district: KANPUR NAGAR
                    state: UTTAR PRADESH
                    pincode: '208021'
                  - serial_number: '2'
                    unit_name: helloscholar
                    flat: Ground Floor
                    building: 05 Raman Vihar Naubasta
                    village: Kanpur
                    block: Kanpur
                    street: Kanpur
                    city: Kanpur
                    district: KANPUR NAGAR
                    state: UTTAR PRADESH
                    pincode: '208021'
                nic_codes:
                  - serial_number: '1'
                    nic_2_digit: '85'
                    nic_2_description: Education
                    nic_4_digit: '8550'
                    nic_4_description: Educational support services
                    nic_5_digit: '85500'
                    nic_5_description: Educational support services
                    activity: Services
                    date: '2022-01-02'
                dic: KANPUR NAGAR
                msme_di: KANPUR
                msme_dfo: KANPUR
            UDYAM_NOT_FOUND:
              value:
                verification_id: kIagmEcyQd
                reference_id: 3689515
                status: UDYAM_NOT_FOUND
                udyam_number: null
                enterprise_name: null
                owner_name: null
                organization_type: null
                major_activity: null
                gender: null
                social_category: null
                date_of_incorporation: null
                date_of_commencement: null
                date_of_udyam_registration: null
                enterprise_type: null
                classification_year: null
                classification_date: null
                udyam_certificate_url: null
                classification_history: []
                split_address: null
                unit_locations: []
                nic_codes: []
                dic: null
                msme_di: null
                msme_dfo: null
            UDYAM_IS_CANCELLED:
              value:
                verification_id: xYzAbCdEfG
                reference_id: 3689516
                status: UDYAM_IS_CANCELLED
                udyam_number: null
                enterprise_name: null
                owner_name: null
                organization_type: null
                major_activity: null
                gender: null
                social_category: null
                date_of_incorporation: null
                date_of_commencement: null
                date_of_udyam_registration: null
                enterprise_type: null
                classification_year: null
                classification_date: null
                udyam_certificate_url: null
                classification_history: []
                split_address: null
                unit_locations: []
                nic_codes: []
                dic: null
                msme_di: null
                msme_dfo: null
    Response400VoterId:
      description: Validation errors for Verify Voter ID API.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            Verification ID missing:
              $ref: '#/components/examples/VerificationIdMissing'
            Verification ID has special characters:
              $ref: '#/components/examples/VerificationIdWithSpecialCharacter'
            Client ID/Client Secret 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
    Response500V2:
      description: Internal error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            Internal Server Error:
              value:
                type: internal_error
                code: verification_failed
                message: something went wrong
    Response502V2:
      description: Gateway error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseSchema'
          examples:
            Bad Gateway:
              value:
                type: internal_error
                code: verification_failed
                message: verification attempt failed
  schemas:
    UdyamVerificationRequestSchema:
      type: object
      example:
        verification_id: tfqgzsXu3Z
        udyam: UDYAM-UP-43-1234567
      required:
        - verification_id
        - udyam
      properties:
        verification_id:
          type: string
          description: >-
            It is the unique ID you create to identify the verification request.
            The maximum character limit is 50. Alphanumeric, period (.), hyphen
            (-), and underscore ( _ ) are allowed.
          example: tfqgzsXu3Z
        udyam:
          type: string
          description: It is the Udyam registration number to be verified.
          example: UDYAM-UP-43-1234567
    UdyamVerificationResponseSchema:
      type: object
      properties:
        verification_id:
          type: string
          description: >-
            It displays the unique ID you created to identify the verification
            request.
          example: tfqgzsXu3Z
        reference_id:
          type: integer
          description: >-
            It displays the unique ID created by Cashfree Payments for reference
            purposes.
          example: 3478283
        status:
          type: string
          description: It displays the status of the verification request.
          enum:
            - SUCCESS
            - UDYAM_NOT_FOUND
            - UDYAM_IS_CANCELLED
          example: SUCCESS
        udyam_number:
          type: string
          nullable: true
          description: It displays the Udyam registration number.
          example: UDYAM-UP-43-1234567
        enterprise_name:
          type: string
          nullable: true
          description: It displays the enterprise name.
          example: helloscholar
        owner_name:
          type: string
          nullable: true
          description: It displays the owner name.
          example: John Doe
        organization_type:
          type: string
          nullable: true
          description: It displays the organization type.
          example: Proprietary
        major_activity:
          type: string
          nullable: true
          description: It displays the major activity of the enterprise.
          example: Services
        gender:
          type: string
          nullable: true
          description: It displays the gender.
          example: Male
        social_category:
          type: string
          nullable: true
          description: It displays the social category.
          example: General
        date_of_incorporation:
          type: string
          nullable: true
          description: It displays the date of incorporation.
          example: '2020-05-29'
        date_of_commencement:
          type: string
          nullable: true
          description: It displays the date of commencement.
          example: '2020-05-29'
        date_of_udyam_registration:
          type: string
          nullable: true
          description: It displays the date of Udyam registration.
          example: '2022-01-02'
        enterprise_type:
          type: string
          nullable: true
          description: It displays the type of enterprise.
          example: Micro
        classification_year:
          type: string
          nullable: true
          description: It displays the classification year.
          example: 2024-25
        classification_date:
          type: string
          nullable: true
          description: It displays the classification date.
          example: '2025-06-02'
        udyam_certificate_url:
          type: string
          nullable: true
          description: It displays the URL to download the Udyam certificate.
          example: UDYAM_CERTIFICATE_PDF_URL
        classification_history:
          type: array
          description: It contains the classification history for different years.
          items:
            type: object
            properties:
              serial_number:
                type: string
                example: '1'
              data_year:
                type: string
                nullable: true
                example: 2024-25
              classification_year:
                type: string
                example: 2024-25
              enterprise_type:
                type: string
                example: Micro
              classification_date:
                type: string
                example: '2025-06-02'
        split_address:
          type: object
          nullable: true
          description: It contains the enterprise address information.
          properties:
            flat:
              type: string
              example: Ground Floor
            building:
              type: string
              example: 05 Raman Vihar
            village:
              type: string
              example: Naubasta
            block:
              type: string
              example: Naubasta
            street:
              type: string
              example: Naubasta
            city:
              type: string
              example: Kanpur
            district:
              type: string
              example: KANPUR NAGAR
            state:
              type: string
              example: UTTAR PRADESH
            pincode:
              type: string
              example: '208021'
            mobile:
              type: string
              description: It displays the masked mobile number.
              example: 70*****210
            email:
              type: string
              description: It displays the enterprise email.
              example: helloscholar.edu@gmail.com
        unit_locations:
          type: array
          description: It contains the list of enterprise unit locations.
          items:
            type: object
            properties:
              serial_number:
                type: string
                example: '1'
              unit_name:
                type: string
                example: hellobanker
              flat:
                type: string
                example: Ground Floor
              building:
                type: string
                example: 05 Raman Vihar Naubasta
              village:
                type: string
                example: KANPUR NAGAR
              block:
                type: string
                example: KANPUR NAGAR
              street:
                type: string
                example: 05 Raman Vihar Naubasta Bamba
              city:
                type: string
                example: Kanpur
              district:
                type: string
                example: KANPUR NAGAR
              state:
                type: string
                example: UTTAR PRADESH
              pincode:
                type: string
                example: '208021'
        nic_codes:
          type: array
          description: It contains the NIC codes information.
          items:
            type: object
            properties:
              serial_number:
                type: string
                example: '1'
              nic_2_digit:
                type: string
                example: '85'
              nic_2_description:
                type: string
                example: Education
              nic_4_digit:
                type: string
                example: '8550'
              nic_4_description:
                type: string
                example: Educational support services
              nic_5_digit:
                type: string
                example: '85500'
              nic_5_description:
                type: string
                example: Educational support services
              activity:
                type: string
                example: Services
              date:
                type: string
                example: '2022-01-02T00:00:00.000Z'
        dic:
          type: string
          nullable: true
          description: It displays the DIC (District Industries Centre).
          example: KANPUR NAGAR
        msme_di:
          type: string
          nullable: true
          description: It displays the MSME DI (Development Institute).
          example: KANPUR
        msme_dfo:
          type: string
          nullable: true
          description: It displays the MSME DFO (Development Field Officer).
          example: KANPUR
    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.
  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).

````