Validate OTP

Owned by Enterprise IT
May 29, 2024
2 min read

This API authentication validates the generated OTP to the required medium based on the configuration. using the following API Request with details. 

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

Service NameHTTP Method
ADM_ValidateOTP

POST


Sample Request
{
    "ServiceName": "ADM_ValidateOTP",
    "objCommonParameters": {
        "_ProxyDetails": {
            "SAASOrgID": "0",
            "LoginUID": 0,
            "RequestType": "mobile",
            "MobileVersion": "5.10.3",
            "Password": "test@123",
            "AuthType": "FORM",
            "ProxyID": 0,
            "OrgID": "1",
            "TokenID": "",
            "ReturnType": "JSON",
            "UserName": "google@sum.com"
        },
        "objUserInformation": {
            "OTP_Text": "TransactionID",
            "TransactionID":"1fc795a0-df9e-4b8d-b9ff-5734a409be43",
            "LoginUID":967
        }
    }
}

Request Parameters

Parameter NameTypeDescriptionMandatory
OTP Text

STRING

Name of the Instance.

For Example: Info

TRUE

Transaction ID

STRING

Is the SR logged for a user?

TRUE

LoginUID

STRING

Logged in users unique identification number.

STRING

Sample Response
{
    "Errors": "",
    "Message": "",
    "Output": "",
    "TokenID": "1F569386C85A0A9A299324F73B23722D86E9B09E051BF21D7BAD7E5FA42A3BCC283348F2F115677BF23A8B14A1EE43D51FC100C3A56C55C7564BBBDADF301D83C0C6EEC2F0BCFD4BA4200AB9A98850A2B33C297FCCB6D7B0707A5A534B8E4FE267DBBB467DA9F4204D689912F5AFBAA3E385DB7BB3DC2B89FE61066579298EAAFBF9238D0CB4F378248EAAF05D88BBE2",
    "OrgID": 0,
    "OutputObject": {
        "OTP_Validation": [
            {
                "Message": ""
            }
        ]
    },
    "OutputID": 0,
    "Input": null
}

Status and Error Codes

For more information, see Status and Error Messages.