post
https://pay2new.in/apis/aeps/v1/biometricKyc
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requestsā¦ | |||
Loadingā¦
Header Request
Accept : application/json
Content-Type: application/json
secret : Unique secret key (Provided by Pay2New)
outletId: Unique OutletID (Provided by Pay2New)
Request Parameters
| Fields | Type | Mandatory (M) , Optional (O) | Description |
|---|---|---|---|
| referenceKey | String | M | Reference key received from KYC status API |
| latitude | String | M | Current location latitude |
| longitude | String | M | Current location longitude |
| request_id | String | M | Unique Reference number |
| biometricData | Array | M | Biometric data details |
| biometricData.dc | String | M | Returned by RD Service when using biometric authentication. Registered Device code. |
| biometricData.ci | String | M | Returned by RD Service when using biometric authentication. Public key certificate identifier of UIDAI using which skey was encrypted. |
| biometricData.hmac | String | M | Returned by RD Service when using biometric authentication. SHA -256 Hash of PID XML and then encrypted and base 64 encoded. |
| biometricData.dpId | String | M | Returned by RD Service when using biometric authentication. Device provider Id. |
| biometricData.mc | String | M | Returned by RD Service when using biometric authentication. encrypted registered device public key certificate. |
| biometricData.pidDataType | String | M | Returned by RD Service when using biometric authentication. Protobuff format or XML format. |
| biometricData.sessionKey | String | M | Returned by RD Service when using biometric authentication. AES session key is generated dynamically for every txn. |
| biometricData.mi | String | M | Returned by RD Service when using biometric authentication. RD model Id. |
| biometricData.rdsId | String | M | Returned by RD Service when using biometric authentication. RD Service Id. |
| biometricData.errCode | String | O | 0(Default)- Request Success |
| biometricData.errInfo | String | O | Information about the error |
| biometricData.fCount | String | O | Total number of FIR records which was part of input. |
| biometricData.fType | String | M | When connecting the Device to RD service send ftype 2 in the request. |
| biometricData.iCount | String | O | Total number of IIR records which was part of input. |
| biometricData.iType | String | O | ISO format (0 for IIR), 0 (IIR) is the default. |
| biometricData.pCount | String | O | A number of face photo records are to be captured (0 to 1). |
| biometricData.pType | String | M | Face format |
| biometricData.srno | String | M | Serial Number of the biometric device. |
| biometricData.pidData | String | M | Returned by RD Service when using biometric authentication. |
| biometricData.qScore | String | M | If a 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.nmPoints | String | M | Number of minutiae points when FMR is captured. Applications may use this for accepting or retrying the capture. |
| biometricData.rdsVer | String | M | Returned by RD Service when using biometric authentication. RD Service version. |
| biometricData.aadhaar_number | String | M | Customer Aadhaar Number |
Sample Reques
curl --location 'https://pay2new.in/apis/aeps/v1/biometricKycStatus' \
--header 'Content-Type: application/json' \
--header 'secret: YOUR_SECRET' \
--header 'outletId: CUSTOMER_OUTLET_ID' \
--data '{
"referenceKey": "qgvE86a9iLnUDjF+QICtLQYdUQP3rTipRtxaE9T6IcpEeO6ifmZV+7QA28rp9gFp",
"latitude": "28.70406",
"longitude": "77.10249",
"request_id":"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" : ""
}
}'
Response Parameters
| Field | Type | Description |
|---|---|---|
| status | Integer | Pay2New Transaction Status |
| message | String | Message from API |
| data | Array | KYC infromation data |
| order_id | Array | Pay2New Order Id |
Sample Response
//Success response
{
"status": 1,
"message": "KYC completed successfully",
"data": [],
"order_id": "BIOKYC123456"
}
//Failed validation response
{
"status": 2,
"message": "Invalid Parameters",
"errors": {
"referenceKey": "The referenceKey field is required.",
"biometricData.aadhaar_number": "The biometricData.aadhaar_number field must be exactly 12 characters in length."
}
}
Please Note:
request_idis returned asorder_id.If provider returns
action = NO-ACTION-REQUIREDandstatus = APPROVED, system marks AEPS biometric KYC as completed