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

# DigiLocker consent scope

> Read what the person gave access to in their DigiLocker consent.



## OpenAPI

````yaml /suite/api-reference/openapi.json post /digilocker/v1/scope.1
openapi: 3.1.0
info:
  title: Privue API Suite
  version: 1.0.0
  description: >-
    Business, tax, registry, employment and identity verification against
    official Indian sources, a person's own documents read through DigiLocker
    with their consent, and an EPF member's passbook read with the OTP they
    receive.


    **Authentication.** Every request takes your API key as a bearer token:
    `Authorization: Bearer <your-key>`.


    **One envelope.** Every check returns the reasons behind a refusal and the
    record the source held, and an empty `reasons` means the check passed.
    Branch on `reasons` rather than on the status code, because a call the
    source answered returns `200` whatever it concluded.


    **DigiLocker and EPFO passbook.** A DigiLocker endpoint returns `details`
    alone: what it read, as the source holds it. So do submitting an EPFO
    passbook OTP and reading the passbook; sending the OTP answers like a check.


    **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.
servers:
  - url: https://api.privue.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Checks
    description: One check on one subject, answered in the envelope every check shares.
  - name: DigiLocker
    description: >-
      A person's own documents, read through the consent they give at
      DigiLocker.
  - name: EPFO passbook
    description: >-
      A member's EPF passbook, read with the OTP sent to the mobile number on
      their account.
  - name: Orchestrated flows
    description: Every check on one business, asked and answered together in a single call.
  - name: Usage
    description: What you have called, and when.
paths:
  /digilocker/v1/scope.1:
    post:
      tags:
        - DigiLocker
      summary: DigiLocker consent scope
      description: Read what the person gave access to in their DigiLocker consent.
      operationId: digilocker.scope.1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsentRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigilockerScopeResponse'
              examples:
                scope:
                  summary: A consent to the account holder and two documents
                  value:
                    details:
                      scope:
                        - files.issueddocs
                        - issued/in.gov.uidai-ADHAR-XXXXXXXX1234
                        - issued/in.gov.transport-DRVLC-TN8920000007545
                        - userdetails
                        - email
                        - picture
        '401':
          description: The API key is missing, malformed or not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        '403':
          description: The key is valid but is not entitled to this feature.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        '404':
          description: >-
            No consent link you created in the last 30 days carries this
            `request_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        '422':
          description: >-
            The request failed validation, or the source would not accept the
            details in it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        '429':
          description: >-
            The key is not cleared for this feature, or is sending too many
            requests. Nothing was called.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        '503':
          description: >-
            The source could not be reached, or authentication is temporarily
            unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
        default:
          description: The request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
components:
  schemas:
    ConsentRequest:
      properties:
        request_id:
          type: string
          minLength: 1
          title: Request Id
          description: The `request_id` the consent link was created with
          examples:
            - 652523835a9f9000112b1ee6
      additionalProperties: false
      type: object
      required:
        - request_id
      title: ConsentRequest
      description: The consent to read through.
    DigilockerScopeResponse:
      properties:
        details:
          $ref: '#/components/schemas/DigilockerScope'
          description: Everything the consent covers
      type: object
      required:
        - details
      title: DigilockerScopeResponse
      description: What the person gave access to in their consent.
    SuiteError:
      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
      type: object
      required:
        - code
        - timestamp
        - message
      title: SuiteError
      description: Why a request failed.
    DigilockerScope:
      properties:
        scope:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Scope
      type: object
      title: DigilockerScope
      description: >-
        What the person gave access to: `issued/<file id>` for each document,
        and entries such as `userdetails`.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key, sent as `Authorization: Bearer <your-key>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.