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

# Check for a DigiLocker account

> Check whether a DigiLocker account exists for an Aadhaar number or a mobile.



## OpenAPI

````yaml /suite/api-reference/openapi.json post /digilocker-simple/v1/user/verify
openapi: 3.1.0
info:
  title: Privue API Suite
  description: >-
    Identity and account verification against government and banking sources.


    **Authentication.** Every request takes your API key as a bearer token:
    `Authorization: Bearer <your-key>`. A successful call to a billed endpoint
    deducts one credit; a call that fails is not charged.


    **Versioning.** Each endpoint is versioned on its own, directly in its path.
    A new version of one endpoint never moves another, so no release requires
    migrating every integration at once.


    **Retention.** Nothing you send and nothing we return is stored. Documents
    are returned as the issuer's own download links, and the response is the
    only copy, so retrieve what you need when you receive it. We record that a
    call happened, for billing and audit, never what it was about.
  version: 1.0.0
servers:
  - url: https://api.privue.ai
    description: Production
security: []
paths:
  /digilocker-simple/v1/user/verify:
    post:
      tags:
        - DigiLocker Simple
      summary: Check for a DigiLocker account
      description: >-
        Check whether a DigiLocker account exists for an Aadhaar number or a
        mobile.
      operationId: check_digilocker_user
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserVerificationRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserVerificationResponse'
        default:
          description: The request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    UserVerificationRequest:
      properties:
        aadhaar_number:
          anyOf:
            - type: string
              pattern: ^[0-9]{12}$
            - type: 'null'
          title: Aadhaar Number
          description: 12-digit Aadhaar number
        mobile:
          anyOf:
            - type: string
              pattern: ^(?:\+91)?[6-9]\d{9}$
            - type: 'null'
          title: Mobile
          description: 10-digit Indian mobile number
      type: object
      title: UserVerificationRequest
      description: Request to check whether a DigiLocker account exists.
    UserVerificationResponse:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code of the response
        timestamp:
          type: integer
          title: Timestamp
          description: Unix millisecond timestamp of when the response was produced
        transaction_id:
          type: string
          title: Transaction Id
          description: Identifier for this call. Quote it when raising a query about one
        data:
          $ref: '#/components/schemas/UserExists'
      type: object
      required:
        - code
        - timestamp
        - transaction_id
        - data
      title: UserVerificationResponse
      description: Response to an account-existence check.
    ErrorResponse:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code of the response
        timestamp:
          type: integer
          title: Timestamp
          description: Unix millisecond timestamp of when the response was produced
        message:
          type: string
          title: Message
          description: What went wrong, in one sentence
        transaction_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Transaction Id
          description: >-
            Identifier for the call, present when it reached the source. Quote
            it when raising a query
      type: object
      required:
        - code
        - timestamp
        - message
      title: ErrorResponse
      description: Why a request failed.
    UserExists:
      properties:
        user_exists:
          type: boolean
          title: User Exists
          description: Whether DigiLocker holds an account for the identifier given
      type: object
      required:
        - user_exists
      title: UserExists
      description: Whether a DigiLocker account exists for the identifier given.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````