> ## 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. # Usage summary > Total your calls over a period, broken down by endpoint, with your remaining credits. ## OpenAPI ````yaml /suite/api-reference/openapi.json get /usage/v1/summary 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 `. **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/summary: get: tags: - Usage summary: Usage summary description: >- Total your calls over a period, broken down by endpoint, with your remaining credits. operationId: usage_summary parameters: - 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/UsageSummary' examples: summary: summary: A month of calls value: start: '2026-09-01' end: '2026-09-30' total_calls: 250 billed_calls: 244 uncharged_calls: 6 credits_spent: 752 credits_remaining: 4248 by_operation: - operation: bank.penny-drop.1 version: v1 calls: 40 billed_calls: 37 uncharged_calls: 3 credits_spent: 148 - operation: bundle.business version: v1 calls: 10 billed_calls: 10 uncharged_calls: 0 credits_spent: 210 - operation: gst.gst-info.1 version: v1 calls: 120 billed_calls: 118 uncharged_calls: 2 credits_spent: 236 - operation: pan.verify.3 version: v1 calls: 80 billed_calls: 79 uncharged_calls: 1 credits_spent: 158 default: description: The request failed content: application/json: schema: $ref: '#/components/schemas/SuiteError' components: schemas: UsageSummary: properties: start: type: string format: date title: Start description: First day counted, inclusive end: type: string format: date title: End description: Last day counted, inclusive total_calls: type: integer title: Total Calls description: Calls made over the period, successful or not billed_calls: type: integer title: Billed Calls description: Calls that were charged uncharged_calls: type: integer title: Uncharged Calls description: >- Calls that cost nothing, whether they failed or answered without reaching a conclusion credits_spent: type: integer title: Credits Spent description: Credits deducted over the period, across every endpoint credits_remaining: anyOf: - type: integer - type: 'null' title: Credits Remaining description: >- Credits left on the key that made this request, null when it has no limit by_operation: items: $ref: '#/components/schemas/OperationUsage' type: array title: By Operation description: The same totals, broken down by endpoint type: object required: - start - end - total_calls - billed_calls - uncharged_calls - credits_spent title: UsageSummary description: Totals for a period, with the credit balance as it stands now. 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. OperationUsage: properties: 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 calls calls: type: integer title: Calls description: Calls made, successful or not billed_calls: type: integer title: Billed Calls description: Calls that were charged uncharged_calls: type: integer title: Uncharged Calls description: >- Calls that cost nothing, whether they failed or answered without reaching a conclusion credits_spent: type: integer title: Credits Spent description: Credits these calls deducted in total type: object required: - operation - version - calls - billed_calls - uncharged_calls - credits_spent title: OperationUsage description: What one endpoint was used for over the period. securitySchemes: bearerAuth: type: http scheme: bearer description: 'Your API key, sent as `Authorization: Bearer `.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.