Generate OTP

Owned by Enterprise IT
May 10, 2024
2 min read

This API authentication generates and sends OTP to the required medium based on the configuration. Either you select the configuration as SMS or E-mail, the OTP is generated and send to the respective mobile or email id using the following API Request with details. 

To authenticate the below API, see API Authentication and Authorization.

Service NameHTTP Method
ADM_GenerateOTP

POST


Sample Request
{
    "ServiceName": "ADM_GenerateOTP",
    "objCommonParameters": {
        "_ProxyDetails": {
            "SAASOrgID": "0",
            "LoginUID": 0,
            "RequestType": "mobile",
            "MobileVersion": "5.10.3",
            "Password": "XXXX@123",
            "AuthType": "FORM",
            "ProxyID": 0,
            "OrgID": "1",
            "TokenID": "",
            "ReturnType": "JSON",
            "UserName": "google@sum.com"
        },
        "objUserInformation": {
            "DomainId": 1,
            "UserID": 967,
            "LoginUID": 967,
            "UserName": "abcd"
        }
    }
}

Request Parameters

Parameter NameTypeDescriptionMandatory
Domain ID

STRING

Name of the Instance.

For Example: Info

TRUE

User ID

STRING

Is the SR logged for a user?

TRUE

LoginUID

STRING

Logged in users unique identification number.

TRUE

User Name

STRING

The name of the user.

TRUE

Sample Response
{
    "Errors": "",
    "Message": "",
    "Output": "",
    "TokenID": "4AB085C27C9D1DE05653BC81205B0F1286ECF5107FEB2B709822AFF208113322467E937BB8E75B6E19EF7265178AA86AFE67B8EF1AA95087CC8BC38A5D1D3573884E47A78169B0646B7D37ED099CF47A5B6D711E4C79DFD0DF7762D80596FCD5C76B598DC798FC3931DE65CC699CCA6FAC1AA3B269064DECE1CA298582FDBE360D7CBD1D67EECA5167C39D46B1B7859C",
    "OrgID": 0,
    "OutputObject": {
        "OTP_Communication": [
            {
                "Message": "",
                "AuthenticationType": "password",
                "TransactionID": "36d97a51-07ee-480e-a50e-e6fb53baf14f"
            }
        ]
    },
    "OutputID": 0,
    "Input": null
}

Status and Error Codes

For more information, see Status and Error Messages.