# Privue

> Documentation for Privue's verification products.

## Docs

- [Verify with Privue](https://docs.privue.ai/verification/introduction.md): Verify your users' identity and business details through Privue's hosted flow.
- [Authentication](https://docs.privue.ai/verification/authentication.md): How every request to the verification API is authenticated.
- [Verification lifecycle](https://docs.privue.ai/verification/lifecycle.md): Statuses, identifiers, timestamps, and the redirect back to your app.
- [Reading results](https://docs.privue.ai/verification/results.md): Status versus data, the journey steps, and downloading documents.
- [Sample verification data](https://docs.privue.ai/verification/sample-verification-data.md): A complete data endpoint response, with what is fixed and what varies by journey.
- [Errors](https://docs.privue.ai/verification/errors.md): Status codes the verification API returns and what they mean.
- [Initiate a user's verification](https://docs.privue.ai/api-reference/verifications/initiate-a-users-verification.md): Start the user's verification session and return the id to poll. Idempotent per phone.
- [Read verification status](https://docs.privue.ai/api-reference/verifications/read-verification-status.md): Status and per-step progress for one verification. Safe to poll.
- [Read verification data](https://docs.privue.ai/api-reference/verifications/read-verification-data.md): Return normalized result plus per-step detail. Valid at any status, partial before completion.
- [Cancel a verification](https://docs.privue.ai/api-reference/verifications/cancel-a-verification.md): Terminate a verification early. Idempotent.
- [Reset a verification](https://docs.privue.ai/api-reference/verifications/reset-a-verification.md): Clear a verification's collected steps and documents and return it to created, so the user starts over.
- [List a verification's documents](https://docs.privue.ai/api-reference/verifications/list-a-verifications-documents.md): Return the documents collected for this verification; use the download endpoint to fetch one.
- [Get a document download link](https://docs.privue.ai/api-reference/verifications/get-a-document-download-link.md): Return a short-lived link to download one document.
- [Privue API Suite](https://docs.privue.ai/suite/introduction.md): Identity and account verification against government and banking sources.
- [Authentication](https://docs.privue.ai/suite/authentication.md): How to authenticate, what a call costs, and what happens when credits run out.
- [DigiLocker](https://docs.privue.ai/suite/digilocker.md): Retrieve a user's government-issued documents after they grant consent.
- [Bank accounts](https://docs.privue.ai/suite/bank.md): Confirm an account exists and read the name the bank holds against it.
- [Usage](https://docs.privue.ai/suite/usage.md): Read back what you have called, what it cost, and what credits remain.
- [Versioning](https://docs.privue.ai/suite/versioning.md): Each endpoint is versioned on its own, directly in its path.
- [Errors](https://docs.privue.ai/suite/errors.md): Status codes the suite returns, which are worth retrying, and the successful responses that still say no.
- [Check for a DigiLocker account](https://docs.privue.ai/api-reference/digilocker-simple/check-for-a-digilocker-account.md): Check whether a DigiLocker account exists for an Aadhaar number or a mobile.
- [Initiate a consent session](https://docs.privue.ai/api-reference/digilocker-simple/initiate-a-consent-session.md): Initiate a consent session and return the DigiLocker URL to redirect the user to.
- [Read session status](https://docs.privue.ai/api-reference/digilocker-simple/read-session-status.md): Read a session's live consent status; poll this until it reports ``succeeded``.
- [Read the account holder's profile](https://docs.privue.ai/api-reference/digilocker-simple/read-the-account-holders-profile.md): Read the DigiLocker account holder's profile for a consented session.
- [Fetch a consented document](https://docs.privue.ai/api-reference/digilocker-simple/fetch-a-consented-document.md): Fetch the download links for the files DigiLocker issued for a consented document.
- [Verify a PAN](https://docs.privue.ai/api-reference/pan/verify-a-pan.md): Verify a PAN and the holder details claimed for it against official PAN records.
- [Verify an account by penny drop](https://docs.privue.ai/api-reference/bank/verify-an-account-by-penny-drop.md): Verify an account by crediting one rupee to it, returning the name the credit landed against.
- [Verify an account penny-less](https://docs.privue.ai/api-reference/bank/verify-an-account-penny-less.md): Verify an account through the banking network without moving any money.
- [Usage totals for a period](https://docs.privue.ai/api-reference/usage/usage-totals-for-a-period.md): Total your calls over a period, broken down by endpoint, with your remaining credits.
- [Individual calls for a period](https://docs.privue.ai/api-reference/usage/individual-calls-for-a-period.md): List your individual calls over a period, newest first, to reconcile against an invoice.

## OpenAPI Specs

- [openapi](https://docs.privue.ai/suite/api-reference/openapi.json)