Generate MFA OTP

Generates OTP for MFA flow.

This API generates an OTP that the customer uses for MFA authentication. The API uses the session ID created by/mfa/token/generate.

API endpoint example


Resource information

Pagination supported?NA
Rate limitNA
Batch supportNA

Request body parameters

(Parameters marked with * are mandatory)
Data TypeDescription
identifierType*EnumCustomer identifier used for MFA token generation. Values: MOBILE, EMAIL, USERNAME, EXTERNALID
identifierValue*StringValue of the identifier. For example, if identifierType is MOBILE, the identifierValue is mobile number. If you want to send the OTP to WhatsApp or Zalo, you need to raise a JIRA ticket to the sustenance team to define the related configurations and configure the templates.
deviceId*StringDevice ID of the customer that receives OTP.
brand*StringName of the brand or organisation that needs verification.
sessionId*StringUnique session ID created from /mfa/token/generate API.
curl --location '' \
--header 'Content-Type: application/json' \
--data '{
    "deviceId": "1234",
    "brand": "Bukl",
    "sessionId": "P-b04c1001-ef08-4125-9886-f9d8b4c5d9b8"

Response parameters

ParameterData TypeDescription
statusobjectObject containing status information.
- successbooleanBoolean indicating the status of the request.
- codeintegerHTTP status code indicating the result. Example: 200 indicates success.
- messagestringMessage describing the status of the request.

    "status": {
        "success": true,
        "code": 200,
        "message": "SUCCESS"
Click Try It! to start a request and see the response here!