Merchant Biometric Kyc

Merchant Biometric KYC enables verification of a merchant’s identity using their Aadhaar-based biometric authentication. During this process, the merchant’s Aadhaar details (such as fingerprint) are securely captured and validated against UIDAI records to confirm authenticity.

Header Parameters

NameTypeDescriptionMandatory (M) , Optional (O)Provided by INSTANTPAY (Y/N)
X-Ipay-Auth-CodeStringAuth Code -1 (Fixed)MY
X-Ipay-Client-IdStringUnique Client IDMY
X-Ipay-Client-SecretStringUnique secret keyMY
X-Ipay-Endpoint-IpStringEnd Customer IP AddressMN
X-Ipay-Outlet-IpStringMerchant's unique Identification numberMN

Request Parameters

ParametersTypeMandatory (M) , Optional(O)Description
referenceKeyStringMCan be obtained from the response of MErchant biometric ekyc status API
latitudeStringMLatitude of the transaction's location
longitudeStringMLongitude of the transaction's location
externalRefStringMUnique to every transaction
captureTypeStringOType of biometric data (face/ finger)
biometricDataarrayMMobile Number of Customers
encryptedAadhaarStringO(Mandatory if outletAadhaarNumber is empty)Aadhaar number encrypted in aes-256 format
biometricData.dcStringMReturned by RD Service when using biometric authentication. Registered Device code.
biometricData.ciStringMReturned by RD Service when using biometric authentication. Public key certificate identifier of UIDAI using which skey was encrypted.
biometricData.hmacStringMReturned by RD Service when using biometric authentication. SHA -256 Hash of PID XML and then encrypted and base 64 encoded
biometricData.dpIdStringMReturned by RD Service when using biometric authentication. Device provider Id.
biometricData.mcStringMReturned by RD Service when using biometric authentication. encrypted registered device public key certificate
biometricData.pidDataTypeStringMReturned by RD Service when using biometric authentication
biometricData.rdsIdStringMReturned by RD Service when using biometric authentication. RD Service Id
biometricData.sessionKeyStringMReturned by RD Service when using biometric authentication. AES session key generated dynamically for every txn.
biometricData.miStringMReturned by RD Service when using biometric authentication. RD model Id.
biometricData.errInfoStringMInformation about the error
biometricData.errCodeStringM0(Default)- Request success
biometricData.fCountStringMTotal number of FIR records which was part of input.
biometricData.fTypeStringMWhen connecting the Device to RD service send ftype 2 in the request.
biometricData.iCountStringMTotal number of IIR records which was part of input.
biometricData.iTypeStringMISO format (0 for IIR), 0 (IIR) is default.
biometricData.pCountStringMNumber of face photo records to be captured (0 to 1).
biometricData.pTypeStringMFace format
biometricData.srnoStringMSerial Number of biometric device.
biometricData.sysidStringMSystem Id
biometricData.tsStringMCurrent Timestamp
biometricData.pidDataStringMReturned by RD Service when using biometric authentication.
biometricData.qScoreStringMIf quality check is done, send a normalized score that is between 0 and 100. Device providers may allow configuration within RD service to use specific quality check algorithms to be enabled.
biometricData.nmPointStringMNumber of minutiae points when FMR is captured. Applications may use this for accepting or retrying the capture.
biometricData.rdsVerStringMReturned by RD Service when using biometric authentication. RD Service version.

Request Parameters

POST https://api.instantpay.in/user/outlet/signup/biometricKyc
X-Ipay-Endpoint-Ip: 139.13.159.24
X-Ipay-Client-Id: **********
X-Ipay-Client-Secret: **********
X-Ipay-Auth-Code: 1
X-Ipay-Outlet-Id:1234

{
    "referenceKey": "qgvE86a9iLnUDjF+QICtLQYdUQP3rTipRtxaE9T6IcpEeO6ifmZV+7QA28rp9gFp",
    "latitude": "28.70406",
    "longitude": "77.10249",
    "externalRef":"1762931326-ABC-123",
    "biometricData": {  
        "encryptedAadhaar" : "",
        "dc" : "",
        "ci" : "",
        "hmac" : "",
        "dpId" : "",
        "mc" : "",
        "pidDataType":"",
        "rdsId" : "",
        "sessionKey" : "",
        "mi" : "",
        "errCode" :"",
        "errInfo" :"",
        "fCount" :"",
        "fType" :"",
        "iCount" :"",
        "iType" :"",
        "pCount" :"",
        "pType" :"",
        "srno":"",
        "sysid":"",
        "ts":"",
        "pidData":"",
        "qScore":"",
        "nmPoints":"",
        "rdsVer" : ""
    }
}
POST /user/outlet/list 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}}
Content-Type: application/json

{
    "pagination" : {
        "pageNumber" : 1,
        "recordsPerPage": "10"
    },
    "filters" : {
        "outletId" : 0,
        "mobile" : "",
        "pan" : ""
    }
}

Response Parameters

NameTypeDescription
statuscodeStringInstantPay Status Code
actcodeStringAction Code
statusStringStatus Message
dataArrayResponse Data (If Present)
timestampStringCurrent time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Success",
    "data": null,
    "timestamp": "2025-11-12 12:38:21",
    "ipay_uuid": "h000a0567163-d19d-42fb-9539-4658fcc33167-uLVR1Bqhtg9K",
    "orderid": null,
    "environment": "LIVE"
} 
Language
Click Try It! to start a request and see the response here!