--- page_title: Enabling/Disabling BioAuth product: UPI TPAP SDK platform: Android page_source: https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/enabling-disabling-bioauth llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt --- ## Enabling / Disabling BioAuth The **Enable BioAuth** API is used to activate biometric authentication for a linked bank account. Once enabled, users can authenticate transactions using device-supported biometrics such as **Fingerprint** or **Face Recognition** instead of entering the MPIN. ### Process Parameters ## Request Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: Example: abcd-12345-abcd-12345 - Tags: String, Mandatory - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String, Mandatory - **Payload**: - Description: Parameters required to call Hyper SDK API - Value: - **Action**: - Description: Operation to be performed in the SDK. - Value: upiBioAuth - Tags: String, Mandatory - **UpiRequestId**: - Description: Unique request identifier - Tags: String, Mandatory - **AccountReferenceId**: - Description: Account reference ID for the target account - Tags: String, Mandatory - **Command**: - Description: This is used to enable or disable biometric authentication (BioAuth) for a user account. - Value: ENABLE/DISABLE - Tags: String, Mandatory - Tags: JSON, Mandatory ## Response Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: Example: abcd-12345-abcd-12345 - Tags: String - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String - **Payload**: - Description: Response Parameters - Value: - **Action**: - Description: Operation to be performed in the SDK. - Value: upiBioAuth - Tags: String, Mandatory - **Command**: - Description: This is used to enable or disable biometric authentication (BioAuth) for a user account. - Value: ENABLE/DISABLE - Tags: String, Mandatory - **Status**: - Description: Operation status - Value: SUCCESS / FAILURE - Tags: String, Mandatory - **VpaAccount**: - Description: It will contain the **bioAuthEnabled** - Value: True/false - Tags: String, Mandatory - **GatewayTransactionId**: - Description: PSP transaction identifier - Tags: String, Mandatory - **GatewayResponseStatus**: - Description: PSP response status - Tags: String, Mandatory - **GatewayResponseCode**: - Description: PSP response code - Tags: String, Mandatory - **GatewayResponseMessage**: - Description: PSP response message - Tags: String, Mandatory - Tags: JSON - **Error**: - Description: Possible values :- true/false - Tags: Boolean - **ErrorMessage**: - Description: Error Message - Tags: String - **ErrorCode**: - Description: Error Code - Tags: String - **Event**: - Description: Value: process_result - Tags: String ## Sample Code Snippets: ### Top Header: #### Request Code Snippet: ```request // block:start:listEmiReqH { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action" : "upiListEmi", "upiRequestId" : "YJP1234567890qwsjpasdfghjk1234", "startDate" : "2025-07-01", "endDate" : "2025-10-01", "accountRefId" : "Ace797b05c1d453ca3b0d060695192", "signature": "", "signaturePayload": "", "merchantKeyId": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:listEmiReqH // block:start:selectemiReqH1 { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action" : "upiSelectEmi", "emiTxnType" : "POST" "originalTxnUpiRequestId" : "YJP1234567890qwsjpasdfghjk1234", "checkEmiUpiRequestId" : "YJPr4r4r467890qwsjpasdfghjk1234", "originalTxnAmt" : "1000.00", "originalTxnTs" : "1750397231000", "customerVpa" : "xxx@ypay", "payeeVpa" : "swiggytest@ypay", "mcc" : "5812", "accountReferenceId" : "Ace797b05c1d453ca3b0d060695192", "signature": "", "signaturePayload": "", "merchantKeyId": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:selectemiReqH1 // block:start:upiCheckEmiReqH1 { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckEmi", "upiRequestId": "YJP1234567890qwsjpasdfghjk1234", "emiTxnType": "FORECLOSE", "originalTxnUpiRequestId": "TXNef1a2908395239df56663244f8c7deed", "originalTxnAmt": "10000.00", "originalTxnTs": "2023-10-07T17:57:49+05:30", "customerVpa": "vpa@handle", "accountReferenceId": "Ace797b05c1d453ca3b0d060695192", "payeeVpa": "vpa@handle", "mcc": "6540", "forecloseEmiId": "Ahask1a2908395239df56663244f8c7deef", "udfParameters": "{}" "signature": "", "signaturePayload": "", "merchantKeyId": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:upiCheckEmiReqH1 // block:start:upiBioAuthReq { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action": "upiBioAuth", "command": "ENABLE/DISABLE", "upiRequestId": "YJP1234567890qwsjpasdfghjk1234", "accountReferenceId": "Ace797b05c1d453ca3b0d060695192", "signature": "", "signaturePayload": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:upiBioAuthReq // block:start:upiBioAuthResp { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "gatewayResponseStatus": "SUCCESS/FAILURE", "command": "ENABLE/DISABLE", "status": "SUCCESS/FAILURE", "gatewayResponseCode": "00", "action": "upiBioAuth", "gatewayTransactionId": "YJP97aafb074120437b896049235796f6e6", "gatewayResponseMessage": "Your ENABLE action has been completed successfully", "vpaAccount": { "vpa": "user@ypay", "account": { "ifsc": "XXXN0010780", "name": "XXXX", "type": "SAVINGS", "branchName": "", "bankAccountUniqueId": "ac5053GDH8ec8614bc050ead2f32add119ed7302b660ff678a0da2f95f19ce556", "mpinSet": "true", "bankCode": "5XX548", "atmPinLength": "4", "bioAuthEnabled": true/false, "supportedFeatures": { "recurrenceMandate": true/false, "upiCredit": true/false, "aadhaar": true/false, "fir": true/false, "emi": true/false, "liteOffline": true/false, "base": true/false, "bioAuth": true/false, "nfs": true/false, "global": true/falsee, "ccBill": true/false, "clDynamicKeys": true/false, "voucherManagementSystem": true/false, "credit": true/false, "mandate": true/false, "lite": true/false }, "mpinLength": "6", "referenceId": "Af3663x24b9a4b52b11e7834d214ad", "maskedAccountNumber": "XXXXXX8714", "isPrimary": "false", "bankName": "State Bank Of India", "otpLength": "6" } } } } // block:end:upiBioAuthResp / ``` ### Bottom Header: #### Response: ```plaintext // block:start:listEmiReqH { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action" : "upiListEmi", "upiRequestId" : "YJP1234567890qwsjpasdfghjk1234", "startDate" : "2025-07-01", "endDate" : "2025-10-01", "accountRefId" : "Ace797b05c1d453ca3b0d060695192", "signature": "", "signaturePayload": "", "merchantKeyId": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:listEmiReqH // block:start:selectemiReqH1 { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action" : "upiSelectEmi", "emiTxnType" : "POST" "originalTxnUpiRequestId" : "YJP1234567890qwsjpasdfghjk1234", "checkEmiUpiRequestId" : "YJPr4r4r467890qwsjpasdfghjk1234", "originalTxnAmt" : "1000.00", "originalTxnTs" : "1750397231000", "customerVpa" : "xxx@ypay", "payeeVpa" : "swiggytest@ypay", "mcc" : "5812", "accountReferenceId" : "Ace797b05c1d453ca3b0d060695192", "signature": "", "signaturePayload": "", "merchantKeyId": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:selectemiReqH1 // block:start:upiCheckEmiReqH1 { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckEmi", "upiRequestId": "YJP1234567890qwsjpasdfghjk1234", "emiTxnType": "FORECLOSE", "originalTxnUpiRequestId": "TXNef1a2908395239df56663244f8c7deed", "originalTxnAmt": "10000.00", "originalTxnTs": "2023-10-07T17:57:49+05:30", "customerVpa": "vpa@handle", "accountReferenceId": "Ace797b05c1d453ca3b0d060695192", "payeeVpa": "vpa@handle", "mcc": "6540", "forecloseEmiId": "Ahask1a2908395239df56663244f8c7deef", "udfParameters": "{}" "signature": "", "signaturePayload": "", "merchantKeyId": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:upiCheckEmiReqH1 // block:start:upiBioAuthReq { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action": "upiBioAuth", "command": "ENABLE/DISABLE", "upiRequestId": "YJP1234567890qwsjpasdfghjk1234", "accountReferenceId": "Ace797b05c1d453ca3b0d060695192", "signature": "", "signaturePayload": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:upiBioAuthReq // block:start:upiBioAuthResp { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "gatewayResponseStatus": "SUCCESS/FAILURE", "command": "ENABLE/DISABLE", "status": "SUCCESS/FAILURE", "gatewayResponseCode": "00", "action": "upiBioAuth", "gatewayTransactionId": "YJP97aafb074120437b896049235796f6e6", "gatewayResponseMessage": "Your ENABLE action has been completed successfully", "vpaAccount": { "vpa": "user@ypay", "account": { "ifsc": "XXXN0010780", "name": "XXXX", "type": "SAVINGS", "branchName": "", "bankAccountUniqueId": "ac5053GDH8ec8614bc050ead2f32add119ed7302b660ff678a0da2f95f19ce556", "mpinSet": "true", "bankCode": "5XX548", "atmPinLength": "4", "bioAuthEnabled": true/false, "supportedFeatures": { "recurrenceMandate": true/false, "upiCredit": true/false, "aadhaar": true/false, "fir": true/false, "emi": true/false, "liteOffline": true/false, "base": true/false, "bioAuth": true/false, "nfs": true/false, "global": true/falsee, "ccBill": true/false, "clDynamicKeys": true/false, "voucherManagementSystem": true/false, "credit": true/false, "mandate": true/false, "lite": true/false }, "mpinLength": "6", "referenceId": "Af3663x24b9a4b52b11e7834d214ad", "maskedAccountNumber": "XXXXXX8714", "isPrimary": "false", "bankName": "State Bank Of India", "otpLength": "6" } } } } // block:end:upiBioAuthResp / ``` --- ## See Also - [Feature Description](https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/feature-description) - [P2M Transaction Status](https://juspay.io/in/docs/upi-tpap-sdk/android/backend-apis/p2m-transaction-s)