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

# Call history

> List your individual calls over a period, newest first, to reconcile against an invoice.



## OpenAPI

````yaml /suite/api-reference/openapi.json get /usage/v1/calls
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:
  /usage/v1/calls:
    get:
      tags:
        - Usage
      summary: Call history
      description: >-
        List your individual calls over a period, newest first, to reconcile
        against an invoice.
      operationId: usage_calls
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            description: Calls per page
            default: 100
            title: Limit
          description: Calls per page
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: '`next_cursor` from the previous page'
            title: Cursor
          description: '`next_cursor` from the previous page'
        - name: from
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: First day to count, inclusive
            title: From
          description: First day to count, inclusive
        - name: to
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: Last day to count, inclusive
            title: To
          description: Last day to count, inclusive
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallPage'
              examples:
                page:
                  summary: A page of calls, with more to read
                  value:
                    calls:
                      - id: 6f0c2a8e-3b1d-4c7a-9e52-1d8b4f6a2c90
                        at: '2026-09-30T17:42:08.512000'
                        operation: gst.gst-info.1
                        version: v1
                        status_code: 200
                        credits: 2
                      - id: b4e19d37-82a6-4f05-a1c3-7e9d2b5f8a14
                        at: '2026-09-30T17:40:51.087000'
                        operation: bank.penny-drop.1
                        version: v1
                        status_code: 200
                        credits: 0
                      - id: 2d7a5c91-e04b-4b3e-8f26-c95a1e7d03b8
                        at: '2026-09-30T17:38:12.344000'
                        operation: pan.verify.3
                        version: v1
                        status_code: 422
                        credits: 0
                    next_cursor: >-
                      MjAyNi0wOS0zMFQxNzozODoxMi4zNDQwMDB8MmQ3YTVjOTEtZTA0Yi00YjNlLThmMjYtYzk1YTFlN2QwM2I4
        default:
          description: The request failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuiteError'
components:
  schemas:
    CallPage:
      properties:
        calls:
          items:
            $ref: '#/components/schemas/Call'
          type: array
          title: Calls
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Pass as `cursor` to fetch the next page; null on the last page
      type: object
      title: CallPage
      description: A page of calls, newest first.
    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.
    Call:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Our identifier for this call
        at:
          type: string
          format: date-time
          title: At
          description: When the call was made, in IST
        operation:
          type: string
          title: Operation
          description: The operation called, as endpoint and action
        version:
          type: string
          title: Version
          description: Version of that endpoint which served the call
        status_code:
          type: integer
          title: Status Code
          description: HTTP status the call returned
        credits:
          type: integer
          title: Credits
          description: Credits this call deducted, zero when it was not charged
      type: object
      required:
        - id
        - at
        - operation
        - version
        - status_code
        - credits
      title: Call
      description: One call, as it appears on a usage statement.
  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.