v1

latestOpenAPI 3.0.32026-07-14108241269.2 KB
DigiLocker

Verify DigiLocker account

Verifies a DigiLocker account using mobile number.

HTTP StatusCodeReasonMessageMerchant Action
2002002ACCOUNT_NOT_FOUNDNo DigiLocker account linked.Skip DigiLocker or redirect to sign-up.
2001004ACCOUNT_FOUNDDigiLocker account exists.Proceed with initiate session.
4003000INVALID_INPUTMobile number invalid/missing.Validate input and retry.
post/verify/digilocker/verify_account

Request body

mobile_numberstring required

Mobile number in 10-digit format.

Example request

{
  "mobile_number": "9123456789"
}

Response

Lookup result

statusstring required

Overall API response status

codeinteger required

Provider-specific response code

chargeblestring

Indicates if the operation is chargeable ('true'|'false')

user_consentstring

Indicates if user consent was obtained ('true'|'false')

Example response

{
  "status": "success",
  "code": 1004,
  "result": {
    "registered": true,
    "digilockerid": "11111111-2222-3333-4444-555555555555",
    "source": "misc"
  },
  "chargeble": "true",
  "user_consent": "true"
}