Skip to main content
POST
Verify DigiLocker

DigiLocker Verification

DigiLocker verification lets users share their Aadhaar directly from the government DigiLocker service. This is a more user-friendly alternative to Aadhaar OTP verification.

Flow Overview

  1. Initialize - Get a DigiLocker consent URL
  2. User Consent - User opens URL and grants consent in DigiLocker app
  3. Check Status - Poll status until verification completes

Initialize DigiLocker Session

string
Optional URL DigiLocker sends the user to after consent. It must be a public https URL; anything else is ignored and the account’s default applies.
string
Device fingerprint/ID for FIU compliance. Must be captured from the client device.

Request

Response

Send the user to redirectUrl to complete DigiLocker consent. The session expires at expiresAt. If the user starts again, the new session replaces the old one: status always checks the most recent.

Check DigiLocker Status

Poll this endpoint until status is completed, failed or expired. It checks the user’s most recent session, so there is nothing to pass.

Request

Response (Completed)

Every poll after completion returns the same aadhaar details, so a lost response can be fetched again.

Response (Pending)

The status can also stay pending for a few seconds after the user finishes, until the Aadhaar details can be read.

Response (Expired)

Status Values

Benefits Over Aadhaar OTP

Errors