API to Generate and Validate OTP

Owned by Enterprise IT
May 08, 2024
6 min read

API to Generate OTP 

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

Service Name 

HTTP Method 

ADM_GenerateOTP 

Post 

Sample Request 
{ 

    "ServiceName": "ADM_GenerateOTP", 

    "objCommonParameters": { 

        "objUserInformation": { 

            "AuthType": "LOGIN_OTP", 

            "CountryCode": "91", 

            "EncryptedEmailID": "xxxxxxxxxxxx", 

            "DeviceId": "xxxxxxxxxx" 
        } 
    } 
}

Request Parameters 

Parameter Name 

Type 

Description 

Mandatory 

AuthType 

String 

Specifies the Authentication type.  

True 

Country Code 

String 

Specifies the numeric identification code for different countries.  

True 

Encrypted Email ID 

String 

Specifies the email ID of the user.  

True 

DeviceID 

String 

Specifies the Device ID of the mobile used.  

True 

Sample Response 
{ 

    "Errors": "", 

    "Message": "", 

    "Output": "", 

    "TokenID": null, 

    "OrgID": 0, 

    "OutputObject": { 

        "OTP_Communication": [ 

            { 

                "Message": "OTP sent to Vis*********@sy****.com and *******219", 

                "AuthenticationType": "otp", 

                "TransactionID": "77cd9db9-1e1c-4e86-860e-df5d42973afa" 

            } 

        ] 

    }, 

    "OutputID": 0, 

    "Input": null 

}

API to Validate OTP 

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

Service Name 

HTTP Method 

LoginApp 

Post 

 

Sample Request 
{ 

    "ServiceName": "LoginApp", 

    "objCommonParameters": { 

        "_ProxyDetails": { 

            "SAASOrgID": "0", 

            "ProxyID": 0, 

            "MobileVersion": "1.7.1", 

            "TokenID": null, 

            "LoginUID": 0, 

            "OrgID": "0", 

            "ReturnType": "JSON", 

            "Password": "xxxxxxxxxxxxxxx", 

            "RequestType": "mobile", 

            "AuthType": "OTP", 

            "UserName": "", 

            "TransactionID": "7ZgWIpqPCxAIXPfN7zhzRbewoP7F5cuhJIQva/aM614zP95HpFF+AH5SYce7a2hx", 

            "DeviceId": "xxxxxxxxxxxxxxx" 

        } 

    } 

}

Request Parameters 

Parameter Name 

Type 

Description 

Mandatory 

SAAS Org ID 

String 

Name of the user.  

True 

Proxy ID 

String 

Specifies the action taken in the API.  

True 

Mobile Version 

String 

Specifies the Device ID of the mobile used.  

True 

Token ID 

String 

Specifies the Token ID generated for authentication. 

True 

Login UID 

String 

Specifies the Login user ID. 

True 

Org ID 

String 

Specifies the organization ID. 

True 

Return Type 

String 

Specifies the format of the response that API returns after processing the request. 

True 

Password 

String 

Specifies the Password of the User. 

True 

Request Type 

 

Specifies the device which is used to generate the OTP. 

 

Auth Type 

String 

Specifies the authentication type used.  

True 

Username 

String 

Specify the username. 

True 

Transaction ID 

String 

Specifies the Transaction ID. 

True 

Device ID 

String 

Specifies the Device ID of the mobile used.  

True 

Sample Response 
{ 

    "User": { 

        "UserDetails": [ 

            { 

                "UserId": "836", 

                "EmailId": "abc.efg@xyz.com", 

                "UserName": "ABC EFG", 

                "TimezoneMins": "330", 

                "CustomLogo": "http:///Attachments///Web.gif", 

                "IsExecutive": "True", 

                "HasNTID": "0", 

                "Org_Id": "1", 

                "Org_Name": "xyz", 

                "Designation": null, 

                "Location": "2911", 

                "Location_Name": "Bangalore", 

                "WsVersion": "5.12.2", 

                "CallMe": "FALSE", 

                "GPS": "FALSE", 

                "Feedback_IM&SR": "NULL", 

                "RPT_Widgets_Access": "True", 

                "InstanceLable": "new Tenant", 

                "Feature": "", 

                "UserProfileImage": "http:///Attachments//elbrus-sp2-non-gdpr-userprofileimage-attachments/58fbe549-6c5d-44c1-a965-0260db81f8fb.jpg", 

                "DisplayDateFormat": "yyyy-MM-dd", 

                "DisplayDateTimeFormat": "yyyy-MM-dd hh:mm:ss tt", 

                "ExpiryTime": "6000", 

                "SessionIdleTimeout": "90", 

                "IsAppLogEnabled": "false", 

                "License_Modules": "IM,CM,PM,CMDB,KIOSK,KM,PFM,RM,SUMMIT,RPT,DB,ADDON_RA,SUMMIT,RPT,DB,SUMMIT,RPT,DB,EPROC,SUMMIT,RPT,DB,SUMMIT,RPT,DB,PT,SUMMIT,RPT,DB,AVM,AM,SR,SMSMGMT", 

                "PM_ApproveRecords_Access": "False", 

                "UserLicenseDetails": { 

                    "LicenseEdition": "SM_EP", 

                    "IsConcurrentAnalyst": false, 

                    "IsLoggedInAsEndUser": false, 

                    "ConcurrentLicenseCount": 0, 

                    "IsSessionKilled": false, 

                    "DomainId": null, 

                    "SupFun": null, 

                    "WorkgroupId": null, 

                    "LimitationCount": null, 

                    "IsPoolLicConsidered": false, 

                    "SessionId": null, 

                    "IsSessionExpired": false, 

                    "WorkgroupParentID": null 

                }, 

                "LoginUID": "1xxxx4", 

                "IsMultiLogin": "False", 

                "IsGDPRAccepted": "False", 

                "IsGDPREnabled": "False", 

                "mPIN_SkipCount": "1", 

                "Is_mPIN_Set": "True", 

                "MobileNo": "9xxxxxxxx1", 

                "Domain_ID": "1", 

                "NT_UID": null, 

                "Frm_UID": " abc.efg@xyz.com ", 

                "OTPLength": "4", 

                "OTPExpiryInMinutes": "15", 

                "MaxAttempts": "3" 

            } 

        ], 

        "DBDetails": [] 

    } 

}