Class UserAPI

User API

This is the main class to communicate with LoginRadius Customer Registration Authentication API.

Namespace: LoginRadiusSDK\CustomerRegistration\Authentication
Located at LoginRadiusSDK/CustomerRegistration/Authentication/UserAPI.php

Methods summary
`public`	# `__construct( type $apikey = '', type $apisecret = '', type $options = array() )` Parameters `$apikey` `$apisecret` `$options`
`public {"isPosted":`	# `registerByEmail( $payload, string $verification_url = '', string $email_template = '', string $options = '', $fields = '' )` This API creates a user in the database as well as sends a verification email to the user. This API creates a user in the database as well as sends a verification email to the user. Parameters `$payload` '{ "FirstName": "", "LastName": "", "Password": "********", "Email":[ { "Type": "Primary", "Value": "[email protected]" } ]}'; `$verification_url` email verification url(Optional) `$email_template` email template name (Optional) `$options` Prevent verification email (Optional) `$fields` Returns {"isPosted": "true"}
`public type`	# `authLoginByEmail( $payload, string $verification_url = '', string $login_url = '', string $email_template = '', string $g_recaptcha_response = '', $fields = '*' )` This API retrieves a copy of the user data based on the Email. This API retrieves a copy of the user data based on the Email. Parameters `$payload` '{ "email":"[email protected]", "password": "xxxxxxxx", "securityanswer": "" }'; `$verification_url` email verification url (Optional) `$login_url` url from where user is going login (Optional) `$email_template` email template name (Optional) `$g_recaptcha_response` It is only required for locked accounts when logging in (Optional) `$fields` Returns type userprofile object
`public type`	# `authLoginByUsername( $payload, string $verification_url = '', string $login_url = '', string $email_template = '', string $g_recaptcha_response = '', $fields = '*' )` This API retrieves a copy of the user data based on the username. This API retrieves a copy of the user data based on the username. Parameters `$payload` "username":"xxxxxx", "password": "xxxxxxxx", "securityanswer": "" }'; `$verification_url` email verification (Optional) `$login_url` url from where user is going login (Optional) `$email_template` email template name (Optional) `$g_recaptcha_response` It is only required for locked accounts when logging in (Optional) `$fields` Returns type userprofile object
`public type`	# `addEmail( $access_token, $email, $type, $verification_url = '', $email_template = '', $fields = '*' )` Add email to account. Add email to account. Parameters `$access_token` (Required) `$email` to be added to the user's account(Required) `$type` to identify the type of email(Required) `$verification_url` verification url(Optional) `$email_template` of the email template(Optional) `$fields` Returns type
`public type`	# `forgotPassword( $email, $reset_password_url, $email_template = '', $fields = '*' )` Forgot password Forgot password Parameters `$email` `$reset_password_url` `$email_template` (Optional) `$fields` Returns type
`public type`	# `checkAvailablityOfEmail( $email, $fields = '*' )` check email exist. check email exist. Parameters `$email` `$fields` Returns type
`public type`	# `checkUsername( $username, $fields = '*' )` check username.exist check username.exist Parameters `$username` `$fields` Returns type
`public userprofile`	# `getProfile( $access_token, $fields = '*' )` Get profile by access token. Get profile by access token. Parameters `$access_token` `$fields` Returns userprofile object
`public userprofile`	# `privacyPolicyAccept( $access_token, $fields = '*' )` This API is used update the privacy policy stored in the user's profile. This API is used update the privacy policy stored in the user's profile. Parameters `$access_token` `$fields` Returns userprofile object
`public IsPosted`	# `sendWelcomeEmail( $access_token, $welcome_email_template = '', $fields = '*' )` This API will send welcome email. This API will send welcome email. Parameters `$access_token` `$welcome_email_template` `$fields` Returns IsPosted object
`public type`	# `getSocialProfile( $access_token, $fields = '*' )` Get Social Profile. Get Social Profile. Parameters `$access_token` `$fields` Returns type
`public object`	# `checkTokenValidity( $access_token, $fields = '' )` Validates access token,if valid then returns a response with its expiry otherwise error Validates access token,if valid then returns a response with its expiry otherwise error Parameters `$access_token` `$fields` Returns object type
`public type`	# `verifyEmail( $vtoken, $url = '', $welcome_email_template = '', $fields = '' )` Verify email Verify email * Parameters `$vtoken` `$url` `$welcome_email_template` `$fields` Returns type
`public type`	# `deleteAccount( $deletetoken, $fields = '*' )` Delete Account. Delete Account. Parameters `$deletetoken` `$fields` Returns type
`public "IsPosted":`	# `invalidateTokenByAccessToken( $access_token, $fields = '' )` Invalidates access token or expires an access token validity. Invalidates access token or expires an access token validity. Parameters `$access_token` `$fields` Returns "IsPosted": "true"
`public type`	# `getSecurityQuestionsByAccessToken( string $access_token, $fields = '*' )` This API is used to retrieve the list of questions using access token. This API is used to retrieve the list of questions using access token. Parameters `$access_token` `$fields` Returns type json object
`public type`	# `getSecurityQuestionsByEmail( type $email, type $fields = '*' )` This API is used to retrieve the list of questions using email. This API is used to retrieve the list of questions using email. Parameters `$email` `$fields` Returns type json object
`public type`	# `getSecurityQuestionsByUserName( string $username, $fields = '*' )` This API is used to retrieve the list of questions using username. This API is used to retrieve the list of questions using username. Parameters `$username` `$fields` Returns type json object
`public type`	# `getSecurityQuestionsByPhone( string $phone, $fields = '*' )` This API is used to retrieve the list of questions using phone id. This API is used to retrieve the list of questions using phone id. Parameters `$phone` `$fields` Returns type json object
`public type`	# `verifyEmailByOtp( $payload, $url = '', $welcome_email_template = '', $fields = '*' )` Verify email by OTP . Verify email by OTP . Parameters `$payload` data `$url` URL to log the main URL(Domain name) in Database(Optional) `$welcome_email_template` template for welcome email(Optional) `$fields` Returns type
`public`	# `changeAccountPassword( $access_token, $old_password, $new_password, $fields = '*' )`
`public type`	# `accountLink( $access_token, $candidate_token, $fields = '*' )` Link account. Link account. Parameters `$access_token` `$candidate_token` `$fields` Returns type
`public {"isPosted":`	# `resendEmailVerification( $email, string $verification_url = '', string $email_template = '', $fields = '*' )` This api used to resend email verification link. This api used to resend email verification link. Parameters `$email` `$verification_url` `$email_template` `$fields` Returns {"isPosted": "true"}
`public type`	# `resetPassword( $reset_token, $password, string $welcome_email_template = '', string $reset_password_email_template = '', $fields = '*' )` Reset Password by reset token. Reset Password by reset token. Parameters `$reset_token` `$password` `$welcome_email_template` (Optional) `$reset_password_email_template` (Optional) `$fields` Returns type
`public type`	# `resetPasswordByOtp( $password, $otp, $email, $welcome_email_template = '', $reset_password_email_template = '', $fields = '*' )` Reset Password by OTP. Reset Password by OTP. Parameters `$password` `$otp` `$email` `$welcome_email_template` (Optional) `$reset_password_email_template` (Optional) `$fields` Returns type
`public {"IsPosted"`	# `authResetPasswordBySecurityAnswerAndEmail( $payload, $fields = '' )` This API is used to reset password for the specified account By email. This API is used to reset password for the specified account By email. Parameters `$payload` '{ "securityanswer": { "cb7****3e40ef8a01fb**20": "Answer" }, "email": "", "password": "xxxxxxxxxx", "resetpasswordemailtemplate": "" }'; `$fields` Returns {"IsPosted" : "true"}
`public {"IsPosted"`	# `authResetPasswordBySecurityAnswerAndPhone( $payload, $fields = '' )` This API is used to reset password for the specified account By phone. This API is used to reset password for the specified account By phone. Parameters `$payload` '{ "securityanswer": { "cb7****3e40ef8a01fb**20": "Answer" }, "phone": "", "password": "xxxxxxxxxx", "resetpasswordemailtemplate": "" }'; `$fields` Returns {"IsPosted" : "true"}
`public {"IsPosted"`	# `authResetPasswordBySecurityAnswerAndUserName( $payload, $fields = '' )` This API is used to reset password for the specified account By UserName. This API is used to reset password for the specified account By UserName. Parameters `$payload` '{ "securityanswer": { "cb7****3e40ef8a01fb**20": "Answer" }, "userName": "", "password": "xxxxxxxxxx", "resetpasswordemailtemplate": "" }'; `$fields` Returns {"IsPosted" : "true"}
`public type`	# `changeUsername( $access_token, $username, $fields = '*' )` change Username . change Username . Parameters `$access_token` `$username` `$fields` Returns type
`public type`	# `updateProfile( $access_token, $payload, string $verification_url = '', string $email_template = '', string $sms_template = '', $fields = '*' )` Update user profile by access token. Update user profile by access token. Parameters `$access_token` `$payload` '{ "Prefix":"", "FirstName":"Joe", "MiddleName":null, "LastName":"Smith", "BirthDate":"10-12-1985", "Gender":"M", "Website":null }'; `$verification_url` (Optional) `$email_template` (Optional) `$sms_template` (Optional) `$fields` Returns type object
`public type`	# `updateSecurityQuestionByAccessToken( string $access_token, $payload, $fields = '' )` This API is used to update security questions by the access token. This API is used to update security questions by the access token. Parameters `$access_token` `$payload` '{ "securityquestionanswer": { "db7*8a73e4**bd9**8c20": "Answer" } }'; `$fields` Returns type json object
`public type`	# `deleteAccountByEmailConfirmation( $access_token, string $delete_url = '', string $email_template = '', $fields = '*' )` Delete account after email confirmation. Delete account after email confirmation. Parameters `$access_token` `$delete_url` $deleteUrl `$email_template` `$fields` Returns type
`public type`	# `removeEmail( $access_token, $email, $fields = '*' )` Remove Email to account. Remove Email to account. Parameters `$access_token` `$email` "[email protected]" `$fields` Returns type
`public type`	# `accountUnlink( $access_token, $provider_id, $provider, $fields = '*' )` Unlink account. Unlink account. Parameters `$access_token` `$provider_id` ID of the linked account `$provider` of the provider `$fields` Returns type
`public type`	# `validateRegistrationDataCode( json $payload, $fields = '*' )` This API allows you to validate code for a particular dropdown member. This API allows you to validate code for a particular dropdown member. Parameters `$payload` `$fields` Returns type json object
`public type`	# `authGetRegistrationDataServer( $type, string $parent_id = '', string $skip = '', string $limit = '', $fields = '*' )` This API is used to retrieve dropdown data. This API is used to retrieve dropdown data. Parameters `$type` `$parent_id` $parentid `$skip` `$limit` `$fields` Returns type json object
`public type`	# `passwordLessLoginByEmail( $email, string $verificationurl = '', string $passwordlesslogintemplate = '' )` This API is used to send a Passwordless Login verification link to the provided Email ID. This API is used to send a Passwordless Login verification link to the provided Email ID. Parameters `$email` `$verificationurl` $passwordlesslogintemplate (Optional) `$passwordlesslogintemplate` $verificationurl (Optional) Returns type {"IsPosted": true}
`public type`	# `passwordLessLoginByUserName( $username, string $verificationurl = '', string $passwordlesslogintemplate = '' )` This API is used to send a Passwordless Login Verification Link to a user by providing their UserName. This API is used to send a Passwordless Login Verification Link to a user by providing their UserName. Parameters `$username` `$verificationurl` $passwordlesslogintemplate (Optional) `$passwordlesslogintemplate` $verificationurl (Optional) Returns type {"IsPosted": true}
`public type`	# `passwordLessLoginVerification( $verificationtoken, string $welcomeemailtemplate = '' )` This API is used to verify the Passwordless Login verification link. This API is used to verify the Passwordless Login verification link. Parameters `$verificationtoken` `$welcomeemailtemplate` (Optional) Returns type object
`public type`	# `phoneSendOtp( $phone, $sms_template )` API can be used to send a One-time Passcode. API can be used to send a One-time Passcode. Parameters `$phone` `$sms_template` (Optional) Returns type object
`public type`	# `phoneLoginByOtp( $data, $sms_template = '' )` This API verifies an account by OTP and allows the user to login. This API verifies an account by OTP and allows the user to login. Parameters `$data` `$sms_template` (Optional) Returns type object
`public type`	# `smartLoginByEmail( type $clientguid, type $email, type $smartloginemailtemplate = "", type $welcomeemailtemplate = "", type $redirecturl = "" )` This API sends a Smart Login link to the user's Email Id. This API sends a Smart Login link to the user's Email Id. Parameters `$clientguid` `$email` `$smartloginemailtemplate` (Optional) `$welcomeemailtemplate` (Optional) `$redirecturl` (Optional) Returns type {"IsPosted": true}
`public type`	# `smartLoginByUserName( type $clientguid, type $username, type $smartloginemailtemplate = "", type $welcomeemailtemplate = "", type $redirecturl = "" )` This API sends a Smart Login link to the user's Email Id. This API sends a Smart Login link to the user's Email Id. Parameters `$clientguid` `$username` `$smartloginemailtemplate` (Optional) `$welcomeemailtemplate` (Optional) `$redirecturl` (Optional) Returns type {"IsPosted": true}
`public type`	# `smartLoginPing( type $clientguid )` This API is used to check if the Smart Login link has been clicked or not. This API is used to check if the Smart Login link has been clicked or not. Parameters `$clientguid` Returns type object
`public type`	# `smartLoginVerifyToken( type $verificationtoken, type $welcomeemailtemplate = "" )` This API verifies the provided token for Smart Login. This API verifies the provided token for Smart Login. Parameters `$verificationtoken` `$welcomeemailtemplate` (Optional) Returns type {"IsPosted": true,"IsVerified": true}
`public {"isPosted"`	# `oneTouchLoginByEmail( $payload, type $redirecturl = '', type $onetouchloginemailtemplate = '', type $welcomeemailtemplate = '' )` This API is used to send a link to a specified email for a frictionless login/registration This API is used to send a link to a specified email for a frictionless login/registration Parameters `$payload` '{ "clientguid": "", "email": "", "name": "", "qq_captcha_ticket": "", "qq_captcha_randstr": "", "g-recaptcha-response ": "" }'; `$redirecturl` (Optional) `$onetouchloginemailtemplate` (Optional) `$welcomeemailtemplate` (Optional) Returns {"isPosted" : true}
`public type`	# `oneTouchLoginByPhone( $payload, string $smstemplate = '' )` This API is used to send one time password to a given phone number for a frictionless login/registration. This API is used to send one time password to a given phone number for a frictionless login/registration. Parameters `$payload` '{ "phone": "", "name": "", "qq_captcha_ticket": "", "qq_captcha_randstr": "", "g-recaptcha-response ": "" }' `$smstemplate` (Optional) Returns type object
`public type`	# `oneTouchOtpVerification( $otp, $phone, $sms_template = '' )` This API is used to verify the otp for One Touch Login. This API is used to verify the otp for One Touch Login. Parameters `$otp` "xxxxxx" `$phone` "xxxxxxxxx" `$sms_template` (Optional) Returns type object
`public type`	# `authLoginByPhone( $payload, string $login_url = '', string $sms_template = '', string $g_recaptcha_response = '', $fields = '*' )` This API retrieves a copy of the user data based on the Phone. This API retrieves a copy of the user data based on the Phone. Parameters `$payload` '{ "phone":"xxxxxxxxxx", "password": "xxxxxxxx", "securityanswer": "" }'; `$login_url` url from where user is going login `$sms_template` sms template name `$g_recaptcha_response` It is only required for locked accounts when logging in `$fields` Returns type userprofile object
`public type`	# `forgotPasswordByOtp( $phone, $sms_template = '' )` Phone Forgot password By OTP Phone Forgot password By OTP Parameters `$phone` "xxxxxxxx" The Registered Phone Number `$sms_template` (Optional) Returns type object
`public type`	# `resendOTP( $phone, string $sms_template = '' )` Phone Resend OTP. Phone Resend OTP. Parameters `$phone` "xxxxxxxx" The Registered Phone Number `$sms_template` (Optional) Returns type object
`public type`	# `resendOTPByToken( $access_token, $phone, string $sms_template = '' )` Phone Resend OTP by token. Phone Resend OTP by token. Parameters `$access_token` `$phone` "xxxxxxxx" The Registered Phone Number `$sms_template` (Optional) Returns type object
`public {"isPosted":`	# `registerByPhone( $payload, string $verification_url = '', string $sms_template = '', $options = '' )` This API used to register a user using phone. This API used to register a user using phone. Parameters `$payload` '{ "FirstName": "", "PhoneId": "************", "Password": "*******", "Email":[ { "Type": "Primary", "Value": "[email protected]" } ]}'; `$verification_url` email verification `$sms_template` email template name `$options` Returns {"isPosted": "true"}
`public type`	# `checkAvailablityOfPhone( $phone )` Check Phone number exist. Check Phone number exist. Parameters `$phone` "xxxxxxxxx" The Registered Phone Number Returns type {"IsExist": true}
`public type`	# `updatePhone( $access_token, $phone, string $sms_template = '' )` Update phone number. Update phone number. Parameters `$access_token` `$phone` "xxxxxxxx" New Phone number `$sms_template` (Optional) Returns type object
`public type`	# `phoneResetPasswordByOtp( $phone, $otp, $password, $sms_template = '', $reset_password_email_template = '' )` Phone reset password by OTP. Phone reset password by OTP. Parameters `$phone` Registered Phone Number `$otp` Verification Code `$password` password `$sms_template` Template Name (Optional) `$reset_password_email_template` Password Email Template (Optional) Returns type {"IsPosted": true}
`public type`	# `verifyOTP( $otp, $phone, $sms_template = '', $fields = '*' )` Phone Verify OTP. Phone Verify OTP. Parameters `$otp` 'xxxxxxxxx' `$phone` 'xxxxxxxxxxx' `$sms_template` (Optional) `$fields` Returns type object
`public type`	# `verifyOTPByToken( $access_token, $otp, $sms_template )` Verify OTP by token. Verify OTP by token. Parameters `$access_token` 'xxxxxxxxxxxx' `$otp` 'xxxxxx' `$sms_template` (Optional) Returns type {"IsPosted": true}
`public type`	# `deletePhoneIdByAccessToken( $access_token )` This API is used to delete the Phone ID. This API is used to delete the Phone ID. Parameters `$access_token` Returns type {"IsDeleted": true}
`public type`	# `mfaEmailLogin( $payload, string $login_url = '', string $verification_url = '', string $email_template = '', string $sms_template_2fa = '', $fields = '*' )` This API used to provide multi factor login with email/password combination. This API used to provide multi factor login with email/password combination. Parameters `$payload` '{ "email":"[email protected]", "password": "xxxxxx" }'; `$login_url` url from where user is going login (Optional) `$verification_url` email verification (Optional) `$email_template` email template name (Optional) `$sms_template_2fa` sms template 2fa name (Optional) `$fields` Returns type SecondFactorAuthentication object
`public type`	# `mfaUserNameLogin( $payload, string $login_url = '', string $verification_url = '', string $email_template = '', string $sms_template_2fa = '', $fields = '*' )` This API used to provide multi factor login with username/password combination. This API used to provide multi factor login with username/password combination. Parameters `$payload` '{ "username":"xxxxxxx", "password": "xxxxxx" }'; `$login_url` url from where user is going login (Optional) `$verification_url` email verification (Optional) `$email_template` email template name (Optional) `$sms_template_2fa` sms template 2fa name (Optional) `$fields` Returns type SecondFactorAuthentication object
`public type`	# `mfaPhoneLogin( $payload, string $login_url = '', string $verification_url = '', string $sms_template = '', string $sms_template_2fa = '', $fields = '*' )` This API used to provide multi factor login with phone/password combination. This API used to provide multi factor login with phone/password combination. Parameters `$payload` '{ "phone":"xxxxxxx", "password": "xxxxxx" }'; `$login_url` url from where user is going login (Optional) `$verification_url` email verification (Optional) `$sms_template` sms template name (Optional) `$sms_template_2fa` sms template 2fa name (Optional) `$fields` Returns type SecondFactorAuthentication object
`public type`	# `mfaValidateAccessToken( $access_token, string $sms_template_2fa = '', $fields = '*' )` MFA Validate Access Token This API is used to configure the multi-factor-authentication after login by using the access token MFA Validate Access Token This API is used to configure the multi-factor-authentication after login by using the access token Parameters `$access_token` `$sms_template_2fa` (Optional) `$fields` Returns type object
`public type`	# `getBackupCodeForLoginbyAccessToken( type $access_token, $fields = '*' )` MFA Backup Code by Access Token MFA Backup Code by Access Token Parameters `$access_token` `$fields` Returns type backup codes object
`public type`	# `resetBackupCodebyAccessToken( type $access_token, $fields = '*' )` Reset Back Up code by access token Reset Back Up code by access token Parameters `$access_token` `$fields` Returns type
`public type`	# `getLoginbyBackupCode( type $second_factor_auth_token, type $backupcode, $fields = '*' )` MFA Validate Backup code MFA Validate Backup code Parameters `$second_factor_auth_token` Second factor authentication token `$backupcode` = 'xxxxxxxx' Backup Code for login `$fields` Returns type
`public type`	# `mfaValidateOtp( $second_factor_auth_token, $payload, string $sms_template_2fa = '', $fields = '*' )` This API is used to log in by completing the multi-factor-authentication by passing the one time passcode. This API is used to log in by completing the multi-factor-authentication by passing the one time passcode. Parameters `$second_factor_auth_token` `$payload` data `$sms_template_2fa` sms template 2fa name (optional) `$fields` Returns type
`public type`	# `mfaValidateGoogleAuthCode( $second_factor_auth_token, $google_auth_code, $sms_template_2fa = '', $fields = '*' )` This API is used to log in by completing the multi-factor-authentication by passing the google authenticator code. This API is used to log in by completing the multi-factor-authentication by passing the google authenticator code. Parameters `$second_factor_auth_token` `$google_auth_code` The code generated by google authenticator app. `$sms_template_2fa` Template Name (optional) `$fields` Returns type
`public type`	# `mfaUpdatePhoneNo( $second_factor_auth_token, $phoneno2fa, string $sms_template_2fa = '' )` This API is used to update the multi-factor-authentication phone number by sending the verification OTP to the provided phone number. This API is used to update the multi-factor-authentication phone number by sending the verification OTP to the provided phone number. Parameters `$second_factor_auth_token` `$phoneno2fa` 'xxxxxxxxxx' `$sms_template_2fa` (optional) Returns type
`public type`	# `mfaUpdatePhoneNoByToken( $access_token, $phoneno2fa, string $sms_template_2fa = '' )` This API is used to update the multi-factor-authentication phone number by sending the access token to the provided phone number. This API is used to update the multi-factor-authentication phone number by sending the access token to the provided phone number. Parameters `$access_token` `$phoneno2fa` 'xxxxxxxxxx' `$sms_template_2fa` (optional) Returns type
`public type`	# `updateMfaByGoogleAuthCode( $access_token, $google_auth_code, string $sms_template = '', $fields = '*' )` Update MFA by Access Token This API is used to Enable Multi-factor authentication by access token on user login. Update MFA by Access Token This API is used to Enable Multi-factor authentication by access token on user login. Parameters `$access_token` `$google_auth_code` 'xxxxxxxxxx' The code generated by google authenticator app after scanning QR code `$sms_template` (optional) `$fields` Returns type
`public type`	# `updateMfaByOtp( $access_token, $payload, string $sms_template = '', $fields = '*' )` Update MFA Setting This API is used to trigger the Multi-factor authentication settings after login for secure actions. Update MFA Setting This API is used to trigger the Multi-factor authentication settings after login for secure actions. Parameters `$access_token` `$payload` `$sms_template` (optional) `$fields` Returns type
`public {"IsDeleted":`	# `resetGoogleAuthenticatorByToken( $access_token, $googleauthenticator, $fields = '*' )` MFA Reset Google Authenticator by Token This API Removes/Reset Google Authenticator By Token. MFA Reset Google Authenticator by Token This API Removes/Reset Google Authenticator By Token. Parameters `$access_token` `$googleauthenticator` boolean(true) to remove Google Authenticator `$fields` Returns {"IsDeleted": "true"}
`public "IsDeleted":`	# `resetSMSAuthenticatorByToken( $access_token, $otpauthenticator, $fields = '*' )` MFA Reset SMS Authenticator by Token This API Removes/Reset SMS Authenticator By Token. MFA Reset SMS Authenticator by Token This API Removes/Reset SMS Authenticator By Token. Parameters `$access_token` `$otpauthenticator` boolean(true) to remove SMS Authenticator `$fields` Returns "IsDeleted": "true"
`public type`	# `mfaReAuthentiation( $access_token, $sms_template_2fa = '', $fields = '*' )` Multi Factor Re-Authenticate This API can be used to trigger Multi-Factor Autentication workflow for the provided access_token. Multi Factor Re-Authenticate This API can be used to trigger Multi-Factor Autentication workflow for the provided access_token. Parameters `$access_token` `$sms_template_2fa` (optional) `$fields` Returns type
`public type`	# `validateMfaByGoogleAuthCode( $access_token, $google_authenticator, $fields = '*' )` Validate MFA by Google Authenticator Code This API is used to re-authenticate via Multi-factor-authentication by passing the google authenticator code. Validate MFA by Google Authenticator Code This API is used to re-authenticate via Multi-factor-authentication by passing the google authenticator code. Parameters `$access_token` `$google_authenticator` 'xxxxxxxxxx' `$fields` Returns type
`public type`	# `validateMfaByBackupCode( $access_token, $backupcode, $fields = '*' )` Validate MFA by Backup Code This API is used to re-authenticate by set of backup codes via access token. Validate MFA by Backup Code This API is used to re-authenticate by set of backup codes via access token. Parameters `$access_token` `$backupcode` 'xxxxxxxx' `$fields` Returns type
`public type`	# `validateMfaByOtp( $access_token, $payload, string $sms_template_2fa = '', $fields = '*' )` Validate MFA by OTP This API is used to re-authenticate via Multi-factor authentication by passing the One Time Password received via SMS. Validate MFA by OTP This API is used to re-authenticate via Multi-factor authentication by passing the One Time Password received via SMS. Parameters `$access_token` `$payload` data `$sms_template_2fa` (Optional) `$fields` Returns type
`public type`	# `validateMfaByPassword( $access_token, $payload, string $sms_template_2fa = '', $fields = '*' )` This API can be used to verify event based multi factor authentication by Password. This API can be used to verify event based multi factor authentication by Password. Parameters `$access_token` `$payload` data `$sms_template_2fa` (Optional) `$fields` Returns type

Namespaces

Classes

Class UserAPI

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns