Skip to main content
POST
Check if a DigiLocker account exists

Authorizations

x-api-key
string
header
required

Your API key for authentication. Use sandbox-with-json-responses as Sandbox key.

Body

application/json
aadhaar_number
string

12-digit Aadhaar number.

Example:

"123456789012"

mobile
string

10-digit Indian mobile number.

Example:

"9876543210"

reference_id
string

Optional caller-side request identifier.

Response

Account lookup result

status
string
Example:

"success"

registered
boolean

Whether the identifier has a DigiLocker account.

digilocker_id
string | null

DigiLocker username if registered, null otherwise.

suggested_user_flow
enum<string>
Available options:
signin,
signup
reference_id
string | null
next_step
object