GETDigiLocker Verification Status

Check whether a user has completed the DigiLocker consent and verification flow.

GET/tools/kyc/digilocker/status

Poll this endpoint after redirecting the user to the DigiLocker URL. Returns the user's consent status and basic identity details (name, DOB, gender, mobile) once the consent flow is complete. Use reference_id from the Create DigiLocker URL response.

Request

Query parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`client_ref_id`	string	optional	Unique reference ID per API call, generated by your system (max 20 characters).e.g. 2026010100123456789
`reference_id`	number	required	Unique identifier received from the Create DigiLocker URL API response.e.g. 12345

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

client_ref_idstringoptional

Unique reference ID per API call, generated by your system (max 20 characters).

example: 2026010100123456789

reference_idnumberRequired

Unique identifier received from the Create DigiLocker URL API response.

example: 12345

These headers authenticate and sign every request. See How Auth Works for details.

Field	Type	Required	Description
`developer_key`	string	required	Static API key issued to your account after KYC.
`secret-key`	string	required	Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
`secret-key-timestamp`	string	required	Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
`content-type`	string	required	application/jsone.g. application/json

developer_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

application/json

example: application/json

Responses

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
Granular status id; see the shared error-codes table.
response_type_idnumber
A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobject
API-specific response payload.
- user_detailsobject
  Identity details of the individual who completed the DigiLocker consent flow.
  - namestring
    Full name of the individual as registered in DigiLocker.
  - dobstring
    Date of birth in DD-MM-YYYY format.
  - genderstring
    Gender of the individual (M / F / T).
  - eaadhaarstring
    Indicates whether the individual's e-Aadhaar is available in DigiLocker.
  - mobilestring
    Mobile number linked to the individual's DigiLocker account.
- document_requestedarray
  List of document types that were requested in the original session.
- document_consentarray
  Consent status objects per requested document type. Indicates which documents the user approved for sharing.

GETDigiLocker Verification Status

Request

Query parameters

Responses

Next steps

Related