v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-022830130.4 KB
KYC

Check if a DigiLocker account exists

Check whether a mobile number or Aadhaar number is already registered with DigiLocker. This is a pre-consent lookup: it helps you decide whether to start the user in signin or signup flow.

Provide exactly one of aadhaar_number or mobile.

Credits: Free.

post/v1/kyc/digilocker/account-lookup

Request body

aadhaar_numberstring

12-digit Aadhaar number.

mobilestring

10-digit Indian mobile number.

reference_idstring

Optional caller-side request identifier.

Example request

{
  "aadhaar_number": "123456789012",
  "mobile": "9876543210"
}

Response

Account lookup result

statusstring
registeredboolean

Whether the identifier has a DigiLocker account.

digilocker_idstring nullable

DigiLocker username if registered, null otherwise.

suggested_user_flow'signin' | 'signup'
reference_idstring nullable

Example response

{
  "status": "success",
  "next_step": {
    "action": "start_session",
    "endpoint": "POST /v1/kyc/digilocker/session"
  }
}