Skip to main content
Privue verifies a business against the bodies that issued its documents, and checks that those documents all name the same business. You read one record: every check, what it found, and why anything did not pass.

​
Which of the three are you?

Every workflow you have with us declares a mode, and the mode decides most of what you read next.

Hosted

"mode": "hosted". You do not hold the documents. Create a verification with the person’s phone number and send them the link; they sign in, work through the steps on our screens, and submit. You read the result when they are done.

Staged

"mode": "staged". The documents reach you over time, through your own onboarding. Upload each one as it arrives, send the values the steps take, then ask for the checks to run. We tell you when they have, and the files stay on the record for you to download.

Instant

"mode": "instant". You hold everything already. Send the whole submission in one call and read the finished record in the reply. The documents are read as they arrive and kept nowhere.
A workflow is one of the three, never more, and we set the mode with you when we publish it. Every endpoint belonging to another mode is refused on it with 409: handing a user into a workflow you supply yourself, uploading a file to an instant one, or sending a whole submission to a staged one. GET /workflows lists the mode of each workflow you have. Everything after that split is shared. Authentication, environments, credits, statuses, the record you read at the end, and the reference for every step type and error code all work the same whichever way the documents arrived.

​
What a verification does

Whatever the route in, every document goes through the same four things.
1

Documents in

Uploaded by the person, or by you.
2

Read

The details on each document are extracted automatically, by a language model. See Accuracy and limits for what that means for the values you receive.
3

Confirmed at source

Each detail is checked with the body that issued it: Income Tax for a PAN, the GST Network for a GSTIN, the bank for an account.
4

Cross-checked

The names those documents established are scored against one another, so a set of individually genuine documents belonging to different businesses does not pass as one.
However the documents arrived, you read one record: every step, its state, what it collected, and why anything did not pass. An instant verification hands you that record in its reply; otherwise poll until the status is completed, or gated where a gate check of yours stopped the journey, or register a callback and be told when either happens.
Start with Authentication, which is also where the two environments are, then whichever of Hosted, Staged or Instant your workflow’s mode calls for. Recipes has a runnable walkthrough, and API reference has every endpoint with a live playground. Credits and limits is what a verification costs and what stops when a workflow runs out, and Going live is what we configure with you, and what to have handled before a real subject goes through.