DigiLocker Check Status

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Before you call this API

Send your issued secret header and Content-Type: application/json. Your source IP must be registered on the partner account, and the account, KYC, wallet, API access, and DigiLocker service must be active. The body ip field does not replace the source-IP check.

Checks whether the user has completed DigiLocker authentication and document consent.

POST https://pay2new.in/apis/v1/verification/digilocker/status

Request fields

FieldTypeRequiredDescription
order_idstringYesorder_id returned by Create URL.
operator_referencestring/integerYesoperator_reference returned by Create URL.
curl --request POST \
  --url 'https://pay2new.in/apis/v1/verification/digilocker/status' \
  --header 'secret: <YOUR_PAY2NEW_SECRET>' \
  --header 'Content-Type: application/json' \
  --data '{
    "order_id": "P2NDL202608260001",
    "operator_reference": "12345678"
  }'

Authenticated response example

{
  "status": 1,
  "message": "AUTHENTICATED",
  "operator_reference": 12345678,
  "data": {
    "user_details": {
      "name": "SAMPLE CUSTOMER",
      "dob": "02-02-1995",
      "gender": "M",
      "eaadhaar": "Y",
      "mobile": "9999999999"
    },
    "status": "AUTHENTICATED",
    "document_requested": ["AADHAAR", "PAN"],
    "document_consent": ["AADHAAR", "PAN"],
    "document_consent_validity": "2026-08-26T12:30:00Z",
    "verification_id": "P2NDL202608260001",
    "reference_id": 12345678
  }
}
data.statusMeaningClient action
PENDINGUser has not completed consent.Keep the journey open; poll at a reasonable interval.
AUTHENTICATEDUser authenticated and gave document consent.Fetch only documents included in document_consent.
EXPIREDConsent URL expired before completion.Create a new URL with a new request_id.
CONSENT_DENIEDUser denied document access.Stop the fetch flow; request consent again only through an appropriate user journey.

📘

Status handling

Top-level status: 1 means the status lookup itself succeeded. It does not mean the DigiLocker journey is complete. Always evaluate data.status.

🚧

Check the application result

Always inspect JSON status, message, and any errors object. A successful HTTP response does not establish verification completion. Invalid JSON, invalid parameters, authentication failure, or unavailable service can return status: 2. For field validation errors, errors maps field names to messages.

See the Verification Integration Guide for the full consent journey, status handling, and examples.

Body Params
string
required

order_id returned by Create URL.

string
required

operator_reference returned by Create URL.

Headers
string
required

Pay2New-issued API secret.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json