Merchant Biometric Ekyc Status

Header Parameters

Name	Type	Description	Mandatory (M) , Optional (O)	Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-Code	String	Auth Code -1 (Fixed)	M	Y
X-Ipay-Client-Id	String	Unique Client ID	M	Y
X-Ipay-Client-Secret	String	Unique secret key	M	Y
X-Ipay-Endpoint-Ip	String	End Customer IP Address	M	N
X-Ipay-Outlet-Id	String	Merchant unique ID	M	Y

Request Parameters

Parameters	Type	Mandatory (M) , Optional(O)	Description
spKey	String	M	Service key (fixed value:"DMI")

Request Parameters

curl --location --request POST 'https://api.instantpay.in/user
/outlet/signup/biometricKycStatus' \
--header 'Accept: application/json' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'X-Ipay-Outlet-Id: {{outletId}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "spKey": "DMI"
}'

POST /user
/outlet/signup/biometricKycStatus HTTP/1.1
Host: api.instantpay.in
Accept: application/json
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
X-Ipay-Outlet-Id: {{outletId}}
Content-Type: application/json

{
"spKey": "DMI"
}

Response Parameters

Name	Type	Description
statuscode	String	InstantPay Status Code
actcode	String	Action Code
status	String	Status Message
data	Array	Response Data (If Present)
timestamp	String	Current time (YYYY-MM-DD HH:II:SS)
ipay_uuid	String	Request reference number
orderid	String	Transaction Id ( If transaction otherwise it is null )
environment	String	Live

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Biometric authentication required",
    "data": {
        "outletId": null,
        "outletAadhaarNumber": "XXXX-XXXX-9262",
        "action": "ACTION-REQUIRED",
        "status": "PENDING",
        "isFaceAuthAvailable": false,
        "isBiometricKycMandatory": false,
        "pidOptionWadh": "E0jzJ/P8UopUHAieZn8CKqS4WPMi5ZSYXgfnlfkWjrc=",
        "referenceKey": "qgvE86a9iLnUDjF+QICtLQYdUQP3rTipRtxaE9T6IcpEeO6ifmZV+7QA28rp9gFp",
        "referenceKeyType": "OutletBiometicKyc"
    },
    "timestamp": "2025-11-12 12:33:50",
    "ipay_uuid": "h000a0566fc7-c799-48ac-b89a-ebdce602bc7d-28rzhjPMnPK2",
    "orderid": null,
    "environment": "LIVE"
}

📘
Note :
If action is ACTION-REQUIRED then initiate the Merchant Biometric KYC.
If action is NO-ACTION-REQUIRED then Merchant biometric kyc is successfully done.
If outletAadhaarNumber contains the last 4 digits of the Aadhaar, then in the Merchant Biometric KYC, encryptedAadhaar is optional.
However, if outletAadhaarNumber is empty, then encryptedAadhaar becomes mandatory and should contain the merchant’s Aadhaar number.