> ## Documentation Index
> Fetch the complete documentation index at: https://docs.konnectnxt.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Aadhaar Basic

> Verifies the Aadhaar number provided in the request payload.

The Aadhaar Without OTP API is designed to validate an Aadhaar number and return relevant details about the individual associated with it. When a request is made with a valid Aadhaar number, the API performs the verification process and responds with key information. This includes the verification status, which indicates whether the Aadhaar number is valid and verified (`true` or `false`). Additionally, the API provides the individual's age band (e.g., `20-30`), their state of residence, a masked version of their mobile number (for privacy), and their gender.

The response also includes a unique case ID for tracking the verification process. Furthermore, the API tracks the number of credits consumed during the verification and the remaining credits in the user's account, which can be used for future requests.

This service is typically used for background verification processes where the Aadhaar number needs to be validated, providing an easy and secure way to fetch the required details without the need for OTP verification.


## OpenAPI

````yaml POST /verification/aadhaar-without-otp
openapi: 3.0.0
info:
  title: KonnectNXT API Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://bgv.konnectnxt.com/api
    description: Production
  - url: https://testbgv.konnectnxt.com/api
    description: QA
security:
  - bearerAuth: []
paths:
  /verification/aadhaar-without-otp:
    post:
      tags:
        - Identity Verification
        - Aadhaar
      description: Verifies the Aadhaar number provided in the request payload.
      operationId: verification_get_aadhaar
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                aadhaar_number:
                  type: string
                  description: The 12-digit Aadhaar number to verify.
                  example: '123456789012'
              required:
                - aadhaar_number
      responses:
        '200':
          description: Successful response with Aadhaar verification details.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/APIBaseResponse'
                  - type: object
                    required:
                      - data
                    properties:
                      data:
                        allOf:
                          - $ref: '#/components/schemas/AadhaarWithoutOTPResult'
                          - type: object
                            required:
                              - case_id
                            properties:
                              case_id:
                                $ref: '#/components/schemas/CaseId'
                  - $ref: '#/components/schemas/Credits'
              examples:
                Success:
                  description: Aadhaar Fetched Successfully.
                  value:
                    status: success
                    code: 200
                    message: Data Fetched Successfully.
                    data:
                      verified: 'true'
                      ageBand: 20-30
                      state: Tamil Nadu
                      mobileNumber: '*******999'
                      gender: FEMALE
                      case_id: bca44880420446a454acaeade83edb28c
                    credits_used: 2
                    credits_remaining: 775
        '400':
          $ref: '#/components/responses/400_WithCredits'
          content:
            application/json:
              examples:
                Missing Aadhaar Number:
                  summary: Missing Aadhaar Number
                  value:
                    status: error
                    code: 400
                    message: >-
                      Aadhaar Number is missing. Please check the documentation
                      for query structure.
                    data: null
                    credits_used: 0
                    credits_remaining: 8858
                Not a Number or String:
                  summary: Invalid Type
                  value:
                    status: error
                    code: 400
                    message: Aadhaar Number is neither a number nor a string.
                    data: null
                    credits_used: 0
                    credits_remaining: 8858
                Incorrect Length:
                  summary: Invalid Length
                  value:
                    status: error
                    code: 400
                    message: Aadhaar Number '3349223860' must be 12 Digits.
                    data: null
                    credits_used: 0
                    credits_remaining: 8858
                Non Digit Characters:
                  summary: Contains Non-Digit Characters
                  value:
                    status: error
                    code: 400
                    message: >-
                      Aadhaar number '33492abcd60' contains non-digit
                      characters.
                    data: null
                    credits_used: 0
                    credits_remaining: 8858
                Invalid Aadhaar Number:
                  summary: Invalid Aadhaar
                  value:
                    status: error
                    code: 400
                    message: Aadhaar Number is invalid.
                    data: null
                    credits_used: 0
                    credits_remaining: 8858
        '401':
          $ref: '#/components/responses/401'
        '402':
          $ref: '#/components/responses/402'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404_WithCredits'
          content:
            application/json:
              examples:
                Not Found:
                  summary: Aadhaar Not Found
                  value:
                    status: error
                    code: 404
                    message: Aadhaar number is not found.
                    data: null
                    credits_used: 0
                    credits_remaining: 8858
        '409':
          $ref: '#/components/responses/409_WithCredits'
          description: Conflict. Upstream service issue.
          content:
            application/json:
              examples:
                upstream_down:
                  summary: Upstream Service Issue
                  value:
                    status: error
                    code: 409
                    message: Upstream Down
                    data: null
                    credits_used: 0
                    credits_remaining: 8858
        '500':
          $ref: '#/components/responses/500_WithCredits'
components:
  schemas:
    APIBaseResponse:
      type: object
      required:
        - status
        - code
        - message
      properties:
        status:
          $ref: '#/components/schemas/APIStatus'
        code:
          $ref: '#/components/schemas/HTTPCode'
        message:
          $ref: '#/components/schemas/APIMessage'
    AadhaarWithoutOTPResult:
      required:
        - verified
        - ageBand
        - state
        - mobileNumber
        - gender
      type: object
      properties:
        verified:
          description: Indicates whether the Aadhaar verification is successful
          type: string
          enum:
            - 'true'
            - 'false'
        ageBand:
          description: Age range of the individual
          type: string
          example: 20-30
        state:
          description: The state where the individual resides
          type: string
          example: Uttar Pradesh
        mobileNumber:
          description: The mobile number associated with the individual (partially masked)
          type: string
          example: '*******090'
        gender:
          description: Gender of the individual
          type: string
          example: MALE
          enum:
            - MALE
            - FEMALE
            - OTHER
    CaseId:
      required:
        - case_id
      type: string
      description: Unique Case Id for BGV
    Credits:
      type: object
      properties:
        credits_used:
          $ref: '#/components/schemas/CreditsUsed'
        credits_left:
          $ref: '#/components/schemas/CreditsLeft'
      required:
        - credits_used
        - credits_left
    APIStatus:
      type: string
      enum:
        - success
        - error
      description: Overall status of the API
    HTTPCode:
      type: integer
      description: HTTP status code
      example: 400
    APIMessage:
      type: string
      description: Description of the response or error
      example: Invalid request parameters
    CreditsUsed:
      type: integer
      description: Represents the total number of credits used in this request.
      example: 3
    CreditsLeft:
      type: integer
      description: 'Represents the remaining credits available for use. '
      example: 4040
    Error:
      allOf:
        - $ref: '#/components/schemas/APIBaseResponse'
    APIErrorData:
      type: object
      properties:
        data:
          type: object
          nullable: true
          example: null
  responses:
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
          examples:
            Missing Token:
              summary: Bearer token is missing or invalid.
              value:
                status: error
                code: 401
                message: Bearer token is missing or invalid.
                data: null
            Incorrect Token Format:
              summary: Token format is incorrect
              value:
                status: error
                code: 401
                message: Token format is incorrect
                data: null
            No Admin Found:
              summary: No admin found for this request
              value:
                status: error
                code: 401
                message: No admin user found for this organization
                data: null
            Invalid API Key:
              summary: Invalid API Key
              value:
                status: error
                code: 401
                message: Invalid API key (organization ID)
                data: null
            User not Found:
              summary: User not found
              value:
                status: error
                code: 401
                message: User not found.
                data: null
    '402':
      description: Payment Required
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
          examples:
            Credit Limit Exceed:
              summary: Credit Limit Exceeded.
              value:
                status: error
                code: 402
                message: Credit Limit Exceeded.
                data: null
            Insufficient Credits:
              summary: Insufficient credits
              value:
                status: error
                code: 402
                message: 'Insufficient credits: 2 required, 1 remaining.'
                data: null
    '403':
      description: Forbidden
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
          examples:
            Token Revoked:
              summary: Token access has been Revoked, Contact Support.
              value:
                status: error
                code: 403
                message: Token access has been Revoked, Contact Support.
                data: null
            Token Inactive:
              summary: Token is Inactive, Contact Support.
              value:
                status: error
                code: 403
                message: Token is Inactive, Contact Support.
                data: null
    400_WithCredits:
      description: Bad Request
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
              - $ref: '#/components/schemas/Credits'
    404_WithCredits:
      description: Not Found
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
              - $ref: '#/components/schemas/Credits'
    409_WithCredits:
      description: Conflict
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
              - $ref: '#/components/schemas/Credits'
    500_WithCredits:
      description: Internal Server Error
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - $ref: '#/components/schemas/APIErrorData'
              - $ref: '#/components/schemas/Credits'
          examples:
            Internal Server Error:
              summary: Internal Server Error.
              value:
                status: error
                code: 500
                message: Internal Server Error.
                data: null
                credits_used: 3
                credits_remaining: 178
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key issued by KonnectNXT. Pass as `Authorization: Bearer
        <your_api_key>`.

````