Header Parameters

Name	Type	Description	Mandatory/ Optional	Provided by Instantpay (Y/N)
X-Ipay-Auth-Code	String	Auth Code:"1" (Fixed)	M	Y
X-Ipay-Client-Id	String	Unique Client Id Provided by Instantpay	M	Y
X-Ipay-Client-Secret	String	Unique Client Secret Provided by Instantpay	M	Y
X-Ipay-Endpoint-Ip	String	End customer IP Address	M	N

Request Parameters

Parameter Name	Type	Requirement	Description
referenceId	String	Mandatory	reference ID can be fetched from the response of "Create URL" API

Sample Request

postman request POST 'https://api.instantpay.in/identity/digiLocker/status' \
  --header 'X-Ipay-Auth-Code: 1' \
  --header 'X-Ipay-Client-Id: YWY3OTAzYzNlM2ExZTJlOfh549Gzt+5IEcETrD5Yx+Q=' \
  --header 'X-Ipay-Client-Secret: 82e4755d7c1cf636816addfe1460936d7b64612208df87f3000aa5b56fc926d1' \
  --header 'X-Ipay-Endpoint-Ip: 14.142.186.142' \
  --header 'Content-Type: application/json' \
  --body '{
    "referenceId" : "692e742e225d7629e60aae29"
}'

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Success",
    "data": {
        "status": "AUTHORIZED",
        "referenceId": "69368e58ac0102180406d47c",
        "externalRef": "Vladimir",
        "userDetails": {
            "name": "Pradeep",
            "mobile": "7678684977",
            "dob": "1990-02-02",
            "gender": "M",
            "eaadhaar": "Y"
        }
    },
    "timestamp": "2025-12-08 14:08:56",
    "ipay_uuid": "h000a08adf60-d5c0-47f9-b764-bb42792d2f99-EFBURInlug8d",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}

📘
Possible Status Values :
PENDING: User has not completed the verification process.
AUTHORIZED: User has logged in and provided consent.
EXPIRED: The link expired before the process was completed.
CONSENT_DENIED: User rejected the consent request.