{"id":18611108,"url":"https://github.com/loginradius/php-sdk","last_synced_at":"2025-04-09T05:08:46.152Z","repository":{"id":3125919,"uuid":"4153600","full_name":"LoginRadius/php-sdk","owner":"LoginRadius","description":"The LoginRadius PHP library will let you integrate LoginRadius' customer identity platform with your PHP application(s).","archived":false,"fork":false,"pushed_at":"2025-03-24T12:23:30.000Z","size":5723,"stargazers_count":26,"open_issues_count":0,"forks_count":38,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-02T03:17:57.644Z","etag":null,"topics":["ciam","hacktoberfest","hacktoberfest2020","loginradius","loginradius-sdk","php","profile-data","user-profile"],"latest_commit_sha":null,"homepage":"https://www.loginradius.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LoginRadius.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-04-27T00:19:59.000Z","updated_at":"2025-03-24T12:22:00.000Z","dependencies_parsed_at":"2024-11-07T03:12:49.934Z","dependency_job_id":"c6049c6a-a720-4310-9e0c-825c553b39e1","html_url":"https://github.com/LoginRadius/php-sdk","commit_stats":{"total_commits":99,"total_committers":17,"mean_commits":5.823529411764706,"dds":0.7575757575757576,"last_synced_commit":"df1f3caadd79e9cf58cca50bb0c31f263a0cc7d0"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoginRadius%2Fphp-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoginRadius%2Fphp-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoginRadius%2Fphp-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoginRadius%2Fphp-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LoginRadius","download_url":"https://codeload.github.com/LoginRadius/php-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980837,"owners_count":21027808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ciam","hacktoberfest","hacktoberfest2020","loginradius","loginradius-sdk","php","profile-data","user-profile"],"created_at":"2024-11-07T03:12:41.500Z","updated_at":"2025-04-09T05:08:46.121Z","avatar_url":"https://github.com/LoginRadius.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\nLoginRadius\n==========\n\n![Home Image](http://docs.lrcontent.com/resources/github/banner-1544x500.png)\n\n-----------------------------------------------\nLoginRadius PHP wrapper provides access to LoginRadius.\n\nLoginRadius is a unified **Customer Identity Management** API platform that combines 30 major social platforms into a single simplified and maintenance-free API. With LoginRadius' API, websites and mobile apps can implement capture user profile data, enable social login, enable social sharing, add single sign-on and many more.\n\nLoginRadius helps businesses boost user engagement on their web/mobile platform, manage online identities, utilize social media for marketing, capture accurate consumer data and get unique social insight into their customer base.\n\n\nPHP Library\n=====\n\n\n-------\n\n\u003eDisclaimer\u003cbr\u003e\n\u003cbr\u003e\n\u003eThis library is meant to help you with a quick implementation of the LoginRadius platform and also to serve as a reference point for the LoginRadius API. Keep in mind that it is an open source library, which means you are free to download and customize the library functions based on your specific application needs.\n\n\n## Installation\n\nThe recommended way to install is through [Composer](http://getcomposer.org/).\n\n\n### Install Composer\n\n```\ncurl -sS https://getcomposer.org/installer | php\n```\n\nNext, run the Composer command to install the latest stable version of library:\n\n```\ncomposer require loginradius/php-sdk:11.7.0\n```\n\nInclude the following files in your Project Directory\n\n```php\nrequire_once \"src/LoginRadiusSDK/Utility/Functions.php\";\nrequire_once \"src/LoginRadiusSDK/Utility/SOTT.php\";\nrequire_once \"src/LoginRadiusSDK/LoginRadiusException.php\";\nrequire_once \"src/LoginRadiusSDK/Clients/IHttpClientInterface.php\";\nrequire_once \"src/LoginRadiusSDK/Clients/DefaultHttpClient.php\";\n\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Authentication/AuthenticationAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Authentication/OneTouchLoginAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Authentication/PasswordLessLoginAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Authentication/PhoneAuthenticationAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Authentication/PINAuthenticationAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Authentication/RiskBasedAuthenticationAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Authentication/SmartLoginAPI.php\";\n\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Account/AccountAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Account/RoleAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Account/SottAPI.php\";\n\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Advanced/ConfigurationAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Advanced/ConsentManagementAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Advanced/CustomObjectAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Advanced/MultiFactorAuthenticationAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Advanced/ReAuthenticationAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Advanced/WebHookAPI.php\";\n\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Social/NativeSocialAPI.php\";\nrequire_once \"src/LoginRadiusSDK/CustomerRegistration/Social/SocialAPI.php\";\nrequire_once \"../../src/LoginRadiusSDK/CustomerRegistration/Authentication/SlidingTokenAPI.php\";\n\n```\nModify the config.php file in the SDK to include your LoginRadius Credentials\n\n## Quickstart Guide\n\n### Configuration\n\nAfter successful install, you need to define the following LoginRadius Account info in your project anywhere before using the LoginRadius SDK or in the config file of your project:\n```php\ndefine('APP_NAME', 'LOGINRADIUS_SITE_NAME_HERE'); // Replace LOGINRADIUS_SITE_NAME_HERE with your site name that provide in LoginRadius account.\ndefine('LR_API_KEY', 'LOGINRADIUS_API_KEY_HERE'); // Replace LOGINRADIUS_API_KEY_HERE with your site API key that provide in LoginRadius account.\ndefine('LR_API_SECRET', 'LOGINRADIUS_API_SECRET_HERE'); // Replace LOGINRADIUS_API_SECRET_HERE with your site Secret key that provide in LoginRadius account.\n\ndefine('API_REQUEST_SIGNING', ''); // Pass boolean true if this option is enabled on you app.\ndefine('API_REGION', ''); // Pass APi Region for your app\ndefine('ORIGIN_IP', 'CLIENT_IP_ADDRESS');   // Replace CLIENT_IP_ADDRESS with the Client Ip Address,LoginRadius allows you add X-Origin-IP in your headers and it determines the IP address of the client's request,this can also be useful to overcome analytics discrepancies where the analytics depend on header data.\n\ndefine('PROTOCOL', 'PROXY_PROTOCOL'); // Replace PROXY_PROTOCOL with your proxy server protocoal ie http or https.\ndefine('HOST', 'PROXY_HOST'); // Replace PROXY_HOST with your proxy server host.\ndefine('PORT', 'PROXY_PORT'); // Replace PROXY_PORT with your proxy server port.\ndefine('USER', 'PROXY_USER'); // Replace PROXY_USER with your proxy server username.\ndefine('PASSWORD', 'PROXY_PASSWORD'); // Replace PROXY_PASSWORD with your proxy server password.\n\ndefine('API_DOMAIN', 'DEFINE_CUSTOM_API_DOMAIN');   // Custom API Domain\ndefine('REFERER', 'DEFINE_REFERER');   // The referer header is used to determine the registration source from which the user has created the account and is synced in the RegistrationSource field for the user profile. When initializing the SDK, you can optionally specify Referer Header.\n\n\n```\n\n\u003eReplace 'LOGINRADIUS_SITE_NAME_HERE', 'LOGINRADIUS_API_KEY_HERE' and  'LOGINRADIUS_API_SECRET_HERE' in the above code with your LoginRadius Site Name, LoginRadius API Key, and Secret.This information can be found in your LoginRadius account as described [here](https://www.loginradius.com/docs/api/v2/admin-console/platform-security/api-key-and-secret).\n\n\u003eAPI Request Signing:- define('API_REQUEST_SIGNING', true); When initializing the SDK, you can optionally specify enabling this feature. Enabling this feature means the customer does not need to pass an API secret in an API request. Instead, they can pass a dynamically generated hash value. This feature will also make sure that the message is not tampered during transit when someone calls our APIs.\n\n\u003ePass the **proxy configurations** if you want to **set Http Server Proxy Configuration** through your PHP SDK. Protocol, Host and port are required to set Http Server Proxy configuration (username and password are optional).\n\n\u003eIf you have Custom API Domain then define 'API_DOMAIN' then replaced it with your custom API domain, Otherwise no need to define this option in configuration.\n\n### Implementation\n\nImporting/aliasing with the use operator.\n\n```php\nuse \\LoginRadiusSDK\\Utility\\Functions;\nuse \\LoginRadiusSDK\\Utility\\SOTT;\nuse \\LoginRadiusSDK\\LoginRadiusException;\nuse \\LoginRadiusSDK\\Clients\\IHttpClientInterface;\nuse \\LoginRadiusSDK\\Clients\\DefaultHttpClient;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Account\\AccountAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Account\\RoleAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Account\\SottAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Advanced\\ConfigurationAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Advanced\\ConsentManagementAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Advanced\\CustomObjectAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Advanced\\MultiFactorAuthenticationAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Advanced\\ReAuthenticationAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Advanced\\WebHookAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Authentication\\AuthenticationAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Authentication\\OneTouchLoginAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Authentication\\PasswordLessLoginAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Authentication\\PhoneAuthenticationAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Authentication\\PINAuthenticationAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Authentication\\RiskBasedAuthenticationAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Authentication\\SmartLoginAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Social\\SocialAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Social\\NativeSocialAPI;\nuse \\LoginRadiusSDK\\CustomerRegistration\\Authentication\\SlidingTokenAPI; \n\n```\n\nCreate a LoginRadius object :\n```php\n$accountObject = new AccountAPI();\n\n```\n\n### API Examples\n\n#### Partial API response\nWe have an option to select fields(partial response) which you require as an API response.\u003cbr\u003e\nFor this, you need to pass an extra parameter(optional) at the end of each API function.\n\n- If any field passed does not exist in response, will be ignored.\n- In case of nested, only root object is selectable.\n- Values should be separated by the comma.\n\n**Example:**\n\n```php\n\n$fields= \"email, username\";\n$email = 'xxxxxr@xxxxx.com';\n\n$result = $accountObject-\u003eaccountProfileByEmail($email,$fields);\n\n```\n\n**Output Response:**\n\n```php\n{\n    UserName: 'test1213',\n    Email: [ { Type: 'Primary', Value: 'test1213@sthus.com' } ]\n}\n\n```\n\n\n\n### Authentication API\n\nList of APIs in this Section:\u003cbr\u003e\n[PUT : Auth Update Profile by Token](#UpdateProfileByAccessToken-put-)\u003cbr\u003e\n[PUT : Auth Unlock Account by Access Token](#UnlockAccountByToken-put-)\u003cbr\u003e\n[PUT : Auth Verify Email By OTP](#VerifyEmailByOTP-put-)\u003cbr\u003e\n[PUT : Auth Reset Password by Security Answer and Email](#ResetPasswordBySecurityAnswerAndEmail-put-)\u003cbr\u003e\n[PUT : Auth Reset Password by Security Answer and Phone](#ResetPasswordBySecurityAnswerAndPhone-put-)\u003cbr\u003e\n[PUT : Auth Reset Password by Security Answer and UserName](#ResetPasswordBySecurityAnswerAndUserName-put-)\u003cbr\u003e\n[PUT : Auth Reset Password by Reset Token](#ResetPasswordByResetToken-put-)\u003cbr\u003e\n[PUT : Auth Reset Password by OTP](#ResetPasswordByEmailOTP-put-)\u003cbr\u003e\n[PUT : Auth Reset Password by OTP and UserName](#ResetPasswordByOTPAndUserName-put-)\u003cbr\u003e\n[PUT : Auth Change Password](#ChangePassword-put-)\u003cbr\u003e\n[PUT : Auth Set or Change UserName](#SetOrChangeUserName-put-)\u003cbr\u003e\n[PUT : Auth Resend Email Verification](#AuthResendEmailVerification-put-)\u003cbr\u003e\n[POST : Auth Add Email](#AddEmail-post-)\u003cbr\u003e\n[POST : Auth Login by Email](#LoginByEmail-post-)\u003cbr\u003e\n[POST : Auth Login by Username](#LoginByUserName-post-)\u003cbr\u003e\n[POST : Auth Forgot Password](#ForgotPassword-post-)\u003cbr\u003e\n[POST : Auth Link Social Identities](#LinkSocialIdentities-post-)\u003cbr\u003e\n[POST : Auth Link Social Identities By Ping](#LinkSocialIdentitiesByPing-post-)\u003cbr\u003e\n[POST : Auth User Registration by Email](#UserRegistrationByEmail-post-)\u003cbr\u003e\n[POST : Auth User Registration By Captcha](#UserRegistrationByCaptcha-post-)\u003cbr\u003e\n[GET : Get Security Questions By Email](#GetSecurityQuestionsByEmail-get-)\u003cbr\u003e\n[GET : Get Security Questions By UserName](#GetSecurityQuestionsByUserName-get-)\u003cbr\u003e\n[GET : Get Security Questions By Phone](#GetSecurityQuestionsByPhone-get-)\u003cbr\u003e\n[GET : Get Security Questions By Access Token](#GetSecurityQuestionsByAccessToken-get-)\u003cbr\u003e\n[GET : Auth Validate Access token](#AuthValidateAccessToken-get-)\u003cbr\u003e\n[GET : Access Token Invalidate](#AuthInValidateAccessToken-get-)\u003cbr\u003e\n[GET : Access Token Info](#GetAccessTokenInfo-get-)\u003cbr\u003e\n[GET : Auth Read all Profiles by Token](#GetProfileByAccessToken-get-)\u003cbr\u003e\n[GET : Auth Send Welcome Email](#SendWelcomeEmail-get-)\u003cbr\u003e\n[GET : Auth Delete Account](#DeleteAccountByDeleteToken-get-)\u003cbr\u003e\n[GET : Get Profile By Ping](#GetProfileByPing-get-)\u003cbr\u003e\n[GET : Auth Check Email Availability](#CheckEmailAvailability-get-)\u003cbr\u003e\n[GET : Auth Verify Email](#VerifyEmail-get-)\u003cbr\u003e\n[GET : Auth Check UserName Availability](#CheckUserNameAvailability-get-)\u003cbr\u003e\n[GET : Auth Privacy Policy Accept](#AcceptPrivacyPolicy-get-)\u003cbr\u003e\n[GET : Auth Privacy Policy History By Access Token](#GetPrivacyPolicyHistoryByAccessToken-get-)\u003cbr\u003e\n[GET : Auth send verification Email for linking social profiles](#AuthSendVerificationEmailForLinkingSocialProfiles-get-)\u003cbr\u003e\n[DELETE : Auth Delete Account with Email Confirmation](#DeleteAccountWithEmailConfirmation-delete-)\u003cbr\u003e\n[DELETE : Auth Remove Email](#RemoveEmail-delete-)\u003cbr\u003e\n[DELETE : Auth Unlink Social Identities](#UnlinkSocialIdentities-delete-)\u003cbr\u003e\n\nIf you have not already initialized the Authentication object do so now\n```php\n$authenticationAPI = new AuthenticationAPI(); \n```\n\n\n\u003ch6 id=\"UpdateProfileByAccessToken-put-\"\u003eAuth Update Profile by Token (PUT)  \u003c/h6\u003e \n \n\n\nThis API is used to update the user's profile by passing the access token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-update-profile-by-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n $payload = '{\n\"firstName\" : \"\u003cfirstName\u003e\",\n\"lastName\" : \"\u003clastName\u003e\"\n}';  //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$fields = null; //Optional \n$nullSupport = true; //Optional \n$smsTemplate = \"smsTemplate\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional \n$isVoiceOtp = false; //Optional\n$options = \"options\"; //Optional \n \n$result = $authenticationAPI-\u003eupdateProfileByAccessToken($access_token,$payload,$emailTemplate,$fields,$nullSupport,$smsTemplate,$verificationUrl,$isVoiceOtp,$options);\n ```\n\n \n\u003ch6 id=\"UnlockAccountByToken-put-\"\u003eAuth Unlock Account by Access Token (PUT)\u003c/h6\u003e \n \n\nThis API is used to allow a customer with a valid access token to unlock their account provided that they successfully pass the prompted Bot Protection challenges. The Block or Suspend block types are not applicable for this API. For additional details see our Auth Security Configuration documentation.You are only required to pass the Post Parameters that correspond to the prompted challenges. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-unlock-account-by-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n $payload = '{\n\"g-recaptcha-response\" : \"\u003cg-recaptcha-response\u003e\"\n}';  //Required\n \n$result = $authenticationAPI-\u003eunlockAccountByToken($access_token,$payload);\n ```\n\n \n\u003ch6 id=\"VerifyEmailByOTP-put-\"\u003eAuth Verify Email By OTP (PUT)  \u003c/h6\u003e \n \n \n\nThis API is used to verify the email of user when the OTP Email verification flow is enabled, please note that you must contact LoginRadius to have this feature enabled.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-verify-email-by-otp/)\n\n ```php\n\n $payload = '{\n\"email\" : \"\u003cemail\u003e\",\n\"otp\" : \"\u003cotp\u003e\"\n}';  //Required \n$fields = null; //Optional \n$url = \"url\"; //Optional \n$welcomeEmailTemplate = \"welcomeEmailTemplate\"; //Optional\n \n$result = $authenticationAPI-\u003everifyEmailByOTP($payload,$fields,$url,$welcomeEmailTemplate);\n ```\n\n \n\u003ch6 id=\"ResetPasswordBySecurityAnswerAndEmail-put-\"\u003eAuth Reset Password by Security Answer and Email (PUT)  \u003c/h6\u003e \n \n\nThis API is used to reset password for the specified account by security question\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-email)\n\n ```php\n\n $payload = '{\n\"email\" : \"\u003cemail\u003e\",\n\"password\" : \"\u003cpassword\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"}\n}';  //Required\n \n$result = $authenticationAPI-\u003eresetPasswordBySecurityAnswerAndEmail($payload);\n ```\n\n \n\u003ch6 id=\"ResetPasswordBySecurityAnswerAndPhone-put-\"\u003eAuth Reset Password by Security Answer and Phone (PUT)  \u003c/h6\u003e \n \n\nThis API is used to reset password for the specified account by security question\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-phone)\n\n ```php\n\n $payload = '{\n\"password\" : \"\u003cpassword\u003e\",\n\"phone\" : \"\u003cphone\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"}\n}';  //Required\n \n$result = $authenticationAPI-\u003eresetPasswordBySecurityAnswerAndPhone($payload);\n ```\n\n \n\u003ch6 id=\"ResetPasswordBySecurityAnswerAndUserName-put-\"\u003eAuth Reset Password by Security Answer and UserName (PUT)  \u003c/h6\u003e \n \n\nThis API is used to reset password for the specified account by security question\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-username)\n\n ```php\n\n $payload = '{\n\"password\" : \"\u003cpassword\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"},\n\"userName\" : \"\u003cuserName\u003e\"\n}';  //Required\n \n$result = $authenticationAPI-\u003eresetPasswordBySecurityAnswerAndUserName($payload);\n ```\n\n \n\u003ch6 id=\"ResetPasswordByResetToken-put-\"\u003eAuth Reset Password by Reset Token (PUT)  \u003c/h6\u003e \n \n\nThis API is used to set a new password for the specified account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-reset-token)\n\n ```php\n\n $payload = '{\n\"password\" : \"\u003cpassword\u003e\",\n\"resetToken\" : \"\u003cresetToken\u003e\"\n}';  //Required\n \n$result = $authenticationAPI-\u003eresetPasswordByResetToken($payload);\n ```\n\n \n\u003ch6 id=\"ResetPasswordByEmailOTP-put-\"\u003eAuth Reset Password by OTP (PUT)  \u003c/h6\u003e \n \n\nThis API is used to set a new password for the specified account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-otp)\n\n ```php\n\n $payload = '{\n\"email\" : \"\u003cemail\u003e\",\n\"otp\" : \"\u003cotp\u003e\",\n\"password\" : \"\u003cpassword\u003e\"\n}';  //Required\n \n$result = $authenticationAPI-\u003eresetPasswordByEmailOTP($payload);\n ```\n\n \n\u003ch6 id=\"ResetPasswordByOTPAndUserName-put-\"\u003eAuth Reset Password by OTP and UserName (PUT)\u003c/h6\u003e \n \n\nThis API is used to set a new password for the specified account if you are using the username as the unique identifier in your workflow\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-reset-password-by-otp-and-username/)\n\n ```php\n\n $payload = '{\n\"otp\" : \"\u003cotp\u003e\",\n\"password\" : \"\u003cpassword\u003e\",\n\"userName\" : \"\u003cuserName\u003e\"\n}';  //Required\n \n$result = $authenticationAPI-\u003eresetPasswordByOTPAndUserName($payload);\n ```\n\n \n\u003ch6 id=\"ChangePassword-put-\"\u003eAuth Change Password (PUT)\u003c/h6\u003e \n \n\nThis API is used to change the accounts password based on the previous password\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-change-password)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$newPassword = \"newPassword\"; //Required \n$oldPassword = \"oldPassword\"; //Required\n \n$result = $authenticationAPI-\u003echangePassword($access_token,$newPassword,$oldPassword);\n ```\n\n \n\u003ch6 id=\"SetOrChangeUserName-put-\"\u003eAuth Set or Change UserName (PUT)\u003c/h6\u003e \n \n\nThis API is used to set or change UserName by access token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-set-or-change-user-name/)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$username = \"username\"; //Required\n \n$result = $authenticationAPI-\u003esetOrChangeUserName($access_token,$username);\n ```\n\n \n\u003ch6 id=\"AuthResendEmailVerification-put-\"\u003eAuth Resend Email Verification (PUT)\u003c/h6\u003e \n \n\nThis API resends the verification email to the user.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-resend-email-verification/)\n\n ```php\n \n$email = \"email\"; //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional\n \n$result = $authenticationAPI-\u003eauthResendEmailVerification($email,$emailTemplate,$verificationUrl);\n ```\n\n \n\u003ch6 id=\"AddEmail-post-\"\u003eAuth Add Email (POST)\u003c/h6\u003e \n \n\nThis API is used to add additional emails to a user's account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-add-email)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$email = \"email\"; //Required \n$type = \"type\"; //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional\n \n$result = $authenticationAPI-\u003eaddEmail($access_token,$email,$type,$emailTemplate,$verificationUrl);\n ```\n\n \n\u003ch6 id=\"LoginByEmail-post-\"\u003eAuth Login by Email (POST)\u003c/h6\u003e \n \n\nThis API retrieves a copy of the user data based on the Email\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-login-by-email)\n\n ```php\n\n $payload = '{\n\"email\" : \"\u003cemail\u003e\",\n\"password\" : \"\u003cpassword\u003e\"\n}';  //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$fields = null; //Optional \n$loginUrl = \"loginUrl\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional\n \n$result = $authenticationAPI-\u003eloginByEmail($payload,$emailTemplate,$fields,$loginUrl,$verificationUrl);\n ```\n\n \n\u003ch6 id=\"LoginByUserName-post-\"\u003eAuth Login by Username (POST)\u003c/h6\u003e \n \n\nThis API retrieves a copy of the user data based on the Username\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-login-by-username)\n\n ```php\n\n $payload = '{\n\"password\" : \"\u003cpassword\u003e\",\n\"username\" : \"\u003cusername\u003e\"\n}';  //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$fields = null; //Optional \n$loginUrl = \"loginUrl\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional\n \n$result = $authenticationAPI-\u003eloginByUserName($payload,$emailTemplate,$fields,$loginUrl,$verificationUrl);\n ```\n\n \n\u003ch6 id=\"ForgotPassword-post-\"\u003eAuth Forgot Password (POST)\u003c/h6\u003e \n \n\nThis API is used to send the reset password url to a specified account. Note: If you have the UserName workflow enabled, you may replace the 'email' parameter with 'username'\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-forgot-password)\n\n ```php\n \n$email = \"email\"; //Required \n$resetPasswordUrl = \"resetPasswordUrl\"; //Required \n$emailTemplate = \"emailTemplate\"; //Optional\n \n$result = $authenticationAPI-\u003eforgotPassword($email,$resetPasswordUrl,$emailTemplate);\n ```\n\n \n\u003ch6 id=\"LinkSocialIdentities-post-\"\u003eAuth Link Social Identities (POST)\u003c/h6\u003e \n \n\nThis API is used to link up a social provider account with an existing LoginRadius account on the basis of access token and the social providers user access token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-link-social-identities)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$candidateToken = \"candidateToken\"; //Required\n \n$result = $authenticationAPI-\u003elinkSocialIdentities($access_token,$candidateToken);\n ```\n\n \n\u003ch6 id=\"LinkSocialIdentitiesByPing-post-\"\u003eAuth Link Social Identities By Ping (POST)\u003c/h6\u003e \n \n\nThis API is used to link up a social provider account with an existing LoginRadius account on the basis of ping and the social providers user access token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-link-social-identities-by-ping)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$clientGuid = \"clientGuid\"; //Required\n \n$result = $authenticationAPI-\u003elinkSocialIdentitiesByPing($access_token,$clientGuid);\n ```\n\n \n\u003ch6 id=\"UserRegistrationByEmail-post-\"\u003eAuth User Registration by Email (POST)\u003c/h6\u003e \n \n\nThis API creates a user in the database as well as sends a verification email to the user.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-user-registration-by-email)\n\n ```php\n\n $payload = '{\n\"email\" : [   { \n \"type\" : \"\u003ctype\u003e\"  ,\n \"value\" : \"\u003cvalue\u003e\"   \n}  ] ,\n\"firstName\" : \"\u003cfirstName\u003e\",\n\"lastName\" : \"\u003clastName\u003e\",\n\"password\" : \"\u003cpassword\u003e\"\n}';  //Required \n$sott = \"sott\"; //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$fields = null; //Optional \n$options = \"options\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional \n$welcomeEmailTemplate = \"welcomeEmailTemplate\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $authenticationAPI-\u003euserRegistrationByEmail($payload,$sott,$emailTemplate,$fields,$options,$verificationUrl,$welcomeEmailTemplate,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"UserRegistrationByCaptcha-post-\"\u003eAuth User Registration By Captcha (POST)\u003c/h6\u003e \n \n\nThis API creates a user in the database as well as sends a verification email to the user.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-user-registration-by-recaptcha)\n\n ```php\n\n $payload = '{\n\"email\" : [   { \n \"type\" : \"\u003ctype\u003e\"  ,\n \"value\" : \"\u003cvalue\u003e\"   \n}  ] ,\n\"firstName\" : \"\u003cfirstName\u003e\",\n\"g-recaptcha-response\" : \"\u003cg-recaptcha-response\u003e\",\n\"lastName\" : \"\u003clastName\u003e\",\n\"password\" : \"\u003cpassword\u003e\"\n}';  //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$fields = null; //Optional \n$options = \"options\"; //Optional \n$smsTemplate = \"smsTemplate\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional \n$welcomeEmailTemplate = \"welcomeEmailTemplate\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $authenticationAPI-\u003euserRegistrationByCaptcha($payload,$emailTemplate,$fields,$options,$smsTemplate,$verificationUrl,$welcomeEmailTemplate,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"GetSecurityQuestionsByEmail-get-\"\u003eGet Security Questions By Email (GET)\u003c/h6\u003e \n \n\nThis API is used to retrieve the list of questions that are configured on the respective LoginRadius site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-email/)\n\n ```php\n \n$email = \"email\"; //Required\n \n$result = $authenticationAPI-\u003egetSecurityQuestionsByEmail($email);\n ```\n\n \n\u003ch6 id=\"GetSecurityQuestionsByUserName-get-\"\u003eGet Security Questions By UserName (GET)\u003c/h6\u003e \n \n\nThis API is used to retrieve the list of questions that are configured on the respective LoginRadius site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-user-name/)\n\n ```php\n \n$userName = \"userName\"; //Required\n \n$result = $authenticationAPI-\u003egetSecurityQuestionsByUserName($userName);\n ```\n\n \n\u003ch6 id=\"GetSecurityQuestionsByPhone-get-\"\u003eGet Security Questions By Phone (GET)\u003c/h6\u003e \n \n\nThis API is used to retrieve the list of questions that are configured on the respective LoginRadius site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-phone/)\n\n ```php\n \n$phone = \"phone\"; //Required\n \n$result = $authenticationAPI-\u003egetSecurityQuestionsByPhone($phone);\n ```\n\n \n\u003ch6 id=\"GetSecurityQuestionsByAccessToken-get-\"\u003eGet Security Questions By Access Token (GET)\u003c/h6\u003e \n \n\nThis API is used to retrieve the list of questions that are configured on the respective LoginRadius site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/security-questions-by-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $authenticationAPI-\u003egetSecurityQuestionsByAccessToken($access_token);\n ```\n\n \n\u003ch6 id=\"AuthValidateAccessToken-get-\"\u003eAuth Validate Access token (GET)\u003c/h6\u003e \n \n\nThis api validates access token, if valid then returns a response with its expiry otherwise error.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-validate-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $authenticationAPI-\u003eauthValidateAccessToken($access_token);\n ```\n\n \n\u003ch6 id=\"AuthInValidateAccessToken-get-\"\u003eAccess Token Invalidate (GET)\u003c/h6\u003e \n \n\nThis api call invalidates the active access token or expires an access token's validity.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-invalidate-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$preventRefresh = true; //Optional\n \n$result = $authenticationAPI-\u003eauthInValidateAccessToken($access_token,$preventRefresh);\n ```\n\n \n\u003ch6 id=\"GetAccessTokenInfo-get-\"\u003eAccess Token Info (GET)\u003c/h6\u003e \n \n\nThis api call provide the active access token Information\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-access-token-info/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $authenticationAPI-\u003egetAccessTokenInfo($access_token);\n ```\n\n \n\u003ch6 id=\"GetProfileByAccessToken-get-\"\u003eAuth Read all Profiles by Token (GET)\u003c/h6\u003e \n \n\nThis API retrieves a copy of the user data based on the access token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-read-profiles-by-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$fields = null; //Optional \n$emailTemplate = \"emailTemplate\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional \n$welcomeEmailTemplate = \"welcomeEmailTemplate\"; //Optional\n \n$result = $authenticationAPI-\u003egetProfileByAccessToken($access_token,$fields,$emailTemplate,$verificationUrl,$welcomeEmailTemplate);\n ```\n\n \n\u003ch6 id=\"SendWelcomeEmail-get-\"\u003eAuth Send Welcome Email (GET)\u003c/h6\u003e \n \n\nThis API sends a welcome email\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-send-welcome-email/)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$welcomeEmailTemplate = \"welcomeEmailTemplate\"; //Optional\n \n$result = $authenticationAPI-\u003esendWelcomeEmail($access_token,$welcomeEmailTemplate);\n ```\n\n \n\u003ch6 id=\"DeleteAccountByDeleteToken-get-\"\u003eAuth Delete Account (GET)\u003c/h6\u003e \n \n\nThis API is used to delete an account by passing it a delete token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-delete-account/)\n\n ```php\n \n$deletetoken = \"deletetoken\"; //Required\n \n$result = $authenticationAPI-\u003edeleteAccountByDeleteToken($deletetoken);\n ```\n\n\u003ch6 id=\"GetProfileByPing-get-\"\u003eGet Profile By Ping (GET)\u003c/h6\u003e \n \n\n\n This API is used to get a user's profile using the clientGuid parameter if no callback feature enabled.[More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/social-login-by-ping/)\n\n ```php\n \n$clientGuid = \"clientGuid\"; //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$fields = null; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional \n$welcomeEmailTemplate = \"welcomeEmailTemplate\"; //Optional\n \n$result = $authenticationAPI-\u003egetProfileByPing($clientGuid,$emailTemplate,$fields,$verificationUrl,$welcomeEmailTemplate);\n ```\n\n\u003ch6 id=\"CheckEmailAvailability-get-\"\u003eAuth Check Email Availability (GET)\u003c/h6\u003e \n \n\nThis API is used to check the email exists or not on your site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-email-availability/)\n\n ```php\n \n$email = \"email\"; //Required\n \n$result = $authenticationAPI-\u003echeckEmailAvailability($email);\n ```\n\n \n\u003ch6 id=\"VerifyEmail-get-\"\u003eAuth Verify Email (GET)\u003c/h6\u003e \n \n\nThis API is used to verify the email of user. Note: This API will only return the full profile if you have 'Enable auto login after email verification' set in your LoginRadius Admin Console's Email Workflow settings under 'Verification Email'.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-verify-email/)\n\n ```php\n \n$verificationToken = \"verificationToken\"; //Required \n$fields = null; //Optional \n$url = \"url\"; //Optional \n$welcomeEmailTemplate = \"welcomeEmailTemplate\"; //Optional\n$uuid = \"uuid\"; //Optional \n\n$result = $authenticationAPI-\u003everifyEmail($verificationToken,$fields,$url,$welcomeEmailTemplate,$uuid);\n ```\n\n \n\u003ch6 id=\"CheckUserNameAvailability-get-\"\u003eAuth Check UserName Availability (GET)\u003c/h6\u003e \n \n\nThis API is used to check the UserName exists or not on your site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-username-availability/)\n\n ```php\n \n$username = \"username\"; //Required\n \n$result = $authenticationAPI-\u003echeckUserNameAvailability($username);\n ```\n\n \n\u003ch6 id=\"AcceptPrivacyPolicy-get-\"\u003eAuth Privacy Policy Accept (GET)\u003c/h6\u003e \n \n\nThis API is used to update the privacy policy stored in the user's profile by providing the access token of the user accepting the privacy policy\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-privacy-policy-accept)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$fields = null; //Optional\n \n$result = $authenticationAPI-\u003eacceptPrivacyPolicy($access_token,$fields);\n ```\n\n \u003ch6 id=\"AuthSendVerificationEmailForLinkingSocialProfiles-get-\"\u003eAuth send verification Email for linking social profiles (GET)\u003c/h6\u003e\n\n This API is used to Send verification email to the unverified email of the social profile. This API can be used only incase of optional verification workflow. [More info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-send-verification-for-social-email/)\n\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$clientguid = \"clientguid\"; //Required\n \n$result = $authenticationAPI-\u003eauthSendVerificationEmailForLinkingSocialProfiles($access_token,$clientguid);\n ```\n\n \n\u003ch6 id=\"GetPrivacyPolicyHistoryByAccessToken-get-\"\u003eAuth Privacy Policy History By Access Token (GET)\u003c/h6\u003e \n \n\nThis API will return all the accepted privacy policies for the user by providing the access token of that user.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/privacy-policy-history-by-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $authenticationAPI-\u003egetPrivacyPolicyHistoryByAccessToken($access_token);\n ```\n\n \n\u003ch6 id=\"DeleteAccountWithEmailConfirmation-delete-\"\u003eAuth Delete Account with Email Confirmation (DELETE)\u003c/h6\u003e \n \n\nThis API will send a confirmation email for account deletion to the customer's email when passed the customer's access token\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-delete-account-with-email-confirmation/)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$deleteUrl = \"deleteUrl\"; //Optional \n$emailTemplate = \"emailTemplate\"; //Optional\n \n$result = $authenticationAPI-\u003edeleteAccountWithEmailConfirmation($access_token,$deleteUrl,$emailTemplate);\n ```\n\n \n\u003ch6 id=\"RemoveEmail-delete-\"\u003eAuth Remove Email (DELETE)\u003c/h6\u003e \n \n\nThis API is used to remove additional emails from a user's account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-remove-email)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$email = \"email\"; //Required\n \n$result = $authenticationAPI-\u003eremoveEmail($access_token,$email);\n ```\n\n \n\u003ch6 id=\"UnlinkSocialIdentities-delete-\"\u003eAuth Unlink Social Identities (DELETE)\u003c/h6\u003e \n \n\nThis API is used to unlink up a social provider account with the specified account based on the access token and the social providers user access token. The unlinked account will automatically get removed from your database.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/auth-unlink-social-identities)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$provider = \"provider\"; //Required \n$providerId = \"providerId\"; //Required\n \n$result = $authenticationAPI-\u003eunlinkSocialIdentities($access_token,$provider,$providerId);\n ```\n\n \n\n\n\n### Account API\n\nList of APIs in this Section:\u003cbr\u003e\n[PUT : Account Update](#UpdateAccountByUid-put-)\u003cbr\u003e\n[PUT : Update Phone ID by UID](#UpdatePhoneIDByUid-put-)\u003cbr\u003e\n[PUT : Account Set Password](#SetAccountPasswordByUid-put-)\u003cbr\u003e\n[PUT : Account Invalidate Verification Email](#InvalidateAccountEmailVerification-put-)\u003cbr\u003e\n[PUT : Reset phone ID verification](#ResetPhoneIDVerificationByUid-put-)\u003cbr\u003e\n[PUT : Upsert Email](#UpsertEmail-put-)\u003cbr\u003e\n[PUT : Update UID](#AccountUpdateUid-put-)\u003cbr\u003e\n[POST : Account Create](#CreateAccount-post-)\u003cbr\u003e\n[POST : Forgot Password token](#GetForgotPasswordToken-post-)\u003cbr\u003e\n[POST : Email Verification token](#GetEmailVerificationToken-post-)\u003cbr\u003e\n[POST : Multipurpose Email Token Generation API](#MultipurposeEmailTokenGeneration-post-)\u003cbr\u003e\n[POST : Multipurpose SMS OTP Generation API](#MultipurposeSMSOTPGeneration-post-)\u003cbr\u003e\n[GET : Get Privacy Policy History By Uid](#GetPrivacyPolicyHistoryByUid-get-)\u003cbr\u003e\n[GET : Account Profiles by Email](#GetAccountProfileByEmail-get-)\u003cbr\u003e\n[GET : Account Profiles by Username](#GetAccountProfileByUserName-get-)\u003cbr\u003e\n[GET : Account Profile by Phone ID](#GetAccountProfileByPhone-get-)\u003cbr\u003e\n[GET : Account Profiles by UID](#GetAccountProfileByUid-get-)\u003cbr\u003e\n[GET : Account Password](#GetAccountPasswordHashByUid-get-)\u003cbr\u003e\n[GET : Access Token based on UID or User impersonation API](#GetAccessTokenByUid-get-)\u003cbr\u003e\n[GET : Refresh Access Token by Refresh Token](#RefreshAccessTokenByRefreshToken-get-)\u003cbr\u003e\n[GET : Revoke Refresh Token](#RevokeRefreshToken-get-)\u003cbr\u003e\n[GET : Account Identities by Email](#GetAccountIdentitiesByEmail-get-)\u003cbr\u003e\n[DELETE : Account Delete](#DeleteAccountByUid-delete-)\u003cbr\u003e\n[DELETE : Account Remove Email](#RemoveEmail-delete-)\u003cbr\u003e\n[DELETE : Revoke All Refresh Token](#RevokeAllRefreshToken-delete-)\u003cbr\u003e\n[DELETE : Delete User Profiles By Email](#AccountDeleteByEmail-delete-)\u003cbr\u003e\n\nIf you have not already initialized the Account object do so now\n```php\n$accountAPI = new AccountAPI(); \n```\n\n\n\u003ch6 id=\"UpdateAccountByUid-put-\"\u003eAccount Update (PUT)\u003c/h6\u003e \n \n\nThis API is used to update the information of existing accounts in your Cloud Storage. See our Advanced API Usage section \u003ca href='https://www.loginradius.com/docs/api/v2/customer-identity-api/advanced-api-usage/'\u003eHere\u003c/a\u003e for more capabilities.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-update)\n\n ```php\n\n $payload = '{\n\"firstName\" : \"\u003cfirstName\u003e\",\n\"lastName\" : \"\u003clastName\u003e\"\n}';  //Required \n$uid = \"uid\"; //Required \n$fields = null; //Optional \n$nullSupport = true; //Optional\n \n$result = $accountAPI-\u003eupdateAccountByUid($payload,$uid,$fields,$nullSupport);\n ```\n\n \n\u003ch6 id=\"UpdatePhoneIDByUid-put-\"\u003eUpdate Phone ID by UID (PUT)\u003c/h6\u003e \n \n\nThis API is used to update the PhoneId by using the Uid's. Admin can update the PhoneId's for both the verified and unverified profiles. It will directly replace the PhoneId and bypass the OTP verification process.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/update-phoneid-by-uid)\n\n ```php\n \n$phone = \"phone\"; //Required \n$uid = \"uid\"; //Required \n$fields = null; //Optional\n \n$result = $accountAPI-\u003eupdatePhoneIDByUid($phone,$uid,$fields);\n ```\n\n \n\u003ch6 id=\"SetAccountPasswordByUid-put-\"\u003eAccount Set Password (PUT)\u003c/h6\u003e \n \n\nThis API is used to set the password of an account in Cloud Storage.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-set-password)\n\n ```php\n \n$password = \"password\"; //Required \n$uid = \"uid\"; //Required\n \n$result = $accountAPI-\u003esetAccountPasswordByUid($password,$uid);\n ```\n\n \n\u003ch6 id=\"InvalidateAccountEmailVerification-put-\"\u003eAccount Invalidate Verification Email (PUT)\u003c/h6\u003e \n \n\nThis API is used to invalidate the Email Verification status on an account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-invalidate-verification-email)\n\n ```php\n \n$uid = \"uid\"; //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional\n \n$result = $accountAPI-\u003einvalidateAccountEmailVerification($uid,$emailTemplate,$verificationUrl);\n ```\n\n \n\u003ch6 id=\"ResetPhoneIDVerificationByUid-put-\"\u003eReset phone ID verification (PUT)\u003c/h6\u003e \n \n\nThis API Allows you to reset the phone no verification of an end user’s account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/reset-phone-id-verification)\n\n ```php\n \n$uid = \"uid\"; //Required \n$smsTemplate = \"smsTemplate\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $accountAPI-\u003eresetPhoneIDVerificationByUid($uid,$smsTemplate,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"UpsertEmail-put-\"\u003eUpsert Email (PUT)\u003c/h6\u003e \n \n\nThis API is used to add/upsert another emails in account profile by different-different email types. If the email type is same then it will simply update the existing email, otherwise it will add a new email in Email array.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/upsert-email)\n\n ```php\n\n $payload = '{\n\"email\" : [   { \n \"type\" : \"\u003ctype\u003e\"  ,\n \"value\" : \"\u003cvalue\u003e\"   \n}  ] \n}';  //Required \n$uid = \"uid\"; //Required \n$fields = null; //Optional\n \n$result = $accountAPI-\u003eupsertEmail($payload,$uid,$fields);\n ```\n\n \n\u003ch6 id=\"AccountUpdateUid-put-\"\u003eUpdate UID (PUT)\u003c/h6\u003e \n\nThis API is used to update a user's Uid. It will update all profiles, custom objects and consent management logs associated with the Uid.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-update/)\n\n ```php\n\n $payload = '{\n\"newUid\" : \"\u003cnewUid\u003e\"\n}';  //Required \n$uid = \"uid\"; //Required\n \n$result = $accountAPI-\u003eaccountUpdateUid($payload,$uid);\n ```\n\n \n\u003ch6 id=\"CreateAccount-post-\"\u003eAccount Create (POST)\u003c/h6\u003e \n\nThis API is used to create an account in Cloud Storage. This API bypass the normal email verification process and manually creates the user. \u003cbr\u003e\u003cbr\u003eIn order to use this API, you need to format a JSON request body with all of the mandatory fields\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-create)\n\n ```php\n\n $payload = '{\n\"email\" : [   { \n \"type\" : \"\u003ctype\u003e\"  ,\n \"value\" : \"\u003cvalue\u003e\"   \n}  ] ,\n\"firstName\" : \"\u003cfirstName\u003e\",\n\"lastName\" : \"\u003clastName\u003e\",\n\"password\" : \"\u003cpassword\u003e\"\n}';  //Required \n$fields = null; //Optional\n \n$result = $accountAPI-\u003ecreateAccount($payload,$fields);\n ```\n\n \n\u003ch6 id=\"GetForgotPasswordToken-post-\"\u003eForgot Password token (POST)\u003c/h6\u003e \n\nThis API Returns a Forgot Password Token it can also be used to send a Forgot Password email to the customer. Note: If you have the UserName workflow enabled, you may replace the 'email' parameter with 'username' in the body.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/get-forgot-password-token)\n\n ```php\n \n$email = \"email\"; //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$resetPasswordUrl = \"resetPasswordUrl\"; //Optional \n$sendEmail = true; //Optional\n \n$result = $accountAPI-\u003egetForgotPasswordToken($email,$emailTemplate,$resetPasswordUrl,$sendEmail);\n ```\n\n \n\u003ch6 id=\"GetEmailVerificationToken-post-\"\u003eEmail Verification token (POST)\u003c/h6\u003e \n\nThis API Returns an Email Verification token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/get-email-verification-token)\n\n ```php\n \n$email = \"email\"; //Required\n \n$result = $accountAPI-\u003egetEmailVerificationToken($email);\n ```\n\n\u003ch6 id=\"MultipurposeEmailTokenGeneration-post-\"\u003eMultipurpose Email Token Generation API (POST)\u003c/h6\u003e\n\n This API generate Email tokens and Email OTPs for Email verification, Add email, Forgot password, Delete user, Passwordless login, Forgot pin, One-touch login and Auto login. [More info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/multipurpose-token-and-sms-otp-generation-api/multipurpose-email-token-generation/)\n\n\n ```php\n\n $payload = '{\n\"clientguid\" : \"\u003cclientguid\u003e\",\n\"email\" : \"\u003cemail\u003e\",\n\"name\" : \"\u003cname\u003e\",\n\"type\" : \"\u003ctype\u003e\",\n\"uid\" : \"\u003cuid\u003e\",\n\"userName\" : \"\u003cuserName\u003e\"\n}';  //Required \n$tokentype = \"tokentype\"; //Required\n \n$result = $accountAPI-\u003emultipurposeEmailTokenGeneration($payload,$tokentype);\n ```\n\n \n\u003ch6 id=\"MultipurposeSMSOTPGeneration-post-\"\u003eMultipurpose SMS OTP Generation API (POST)\u003c/h6\u003e\n\n This API generates SMS OTP for Add phone, Phone Id verification, Forgot password, Forgot pin, One-touch login, smart login and Passwordless login. [More info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/multipurpose-token-and-sms-otp-generation-api/multipurpose-sms-otp-generation/)\n\n\n ```php\n\n $payload = '{\n\"name\" : \"\u003cname\u003e\",\n\"phone\" : \"\u003cphone\u003e\",\n\"uid\" : \"\u003cuid\u003e\"\n}';  //Required \n$smsotptype = \"smsotptype\"; //Required\n \n$result = $accountAPI-\u003emultipurposeSMSOTPGeneration($payload,$smsotptype);\n ```\n \n\u003ch6 id=\"GetPrivacyPolicyHistoryByUid-get-\"\u003eGet Privacy Policy History By Uid (GET)\u003c/h6\u003e \n\nThis API is used to retrieve all of the accepted Policies by the user, associated with their UID.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/privacy-policy-history-by-uid/)\n\n ```php\n \n$uid = \"uid\"; //Required\n \n$result = $accountAPI-\u003egetPrivacyPolicyHistoryByUid($uid);\n ```\n\n \n\u003ch6 id=\"GetAccountProfileByEmail-get-\"\u003eAccount Profiles by Email (GET)\u003c/h6\u003e \n\nThis API is used to retrieve all of the profile data, associated with the specified account by email in Cloud Storage.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-email)\n\n ```php\n \n$email = \"email\"; //Required \n$fields = null; //Optional\n \n$result = $accountAPI-\u003egetAccountProfileByEmail($email,$fields);\n ```\n\n \n\u003ch6 id=\"GetAccountProfileByUserName-get-\"\u003eAccount Profiles by Username (GET)\u003c/h6\u003e \n\nThis API is used to retrieve all of the profile data associated with the specified account by user name in Cloud Storage.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-user-name)\n\n ```php\n \n$userName = \"userName\"; //Required \n$fields = null; //Optional\n \n$result = $accountAPI-\u003egetAccountProfileByUserName($userName,$fields);\n ```\n\n \n\u003ch6 id=\"GetAccountProfileByPhone-get-\"\u003eAccount Profile by Phone ID (GET)\u003c/h6\u003e \n\nThis API is used to retrieve all of the profile data, associated with the account by phone number in Cloud Storage.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-phone-id/)\n\n ```php\n \n$phone = \"phone\"; //Required \n$fields = null; //Optional\n \n$result = $accountAPI-\u003egetAccountProfileByPhone($phone,$fields);\n ```\n\n \n\u003ch6 id=\"GetAccountProfileByUid-get-\"\u003eAccount Profiles by UID (GET)\u003c/h6\u003e \n\nThis API is used to retrieve all of the profile data, associated with the account by uid in Cloud Storage.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-profiles-by-uid)\n\n ```php\n \n$uid = \"uid\"; //Required \n$fields = null; //Optional\n \n$result = $accountAPI-\u003egetAccountProfileByUid($uid,$fields);\n ```\n\n \n\u003ch6 id=\"GetAccountPasswordHashByUid-get-\"\u003eAccount Password (GET)\u003c/h6\u003e \n\nThis API use to retrive the hashed password of a specified account in Cloud Storage.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-password)\n\n ```php\n \n$uid = \"uid\"; //Required\n \n$result = $accountAPI-\u003egetAccountPasswordHashByUid($uid);\n ```\n\n \n\u003ch6 id=\"GetAccessTokenByUid-get-\"\u003eAccess Token based on UID or User impersonation API (GET)\u003c/h6\u003e \n\nThe API is used to get LoginRadius access token based on UID.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-impersonation-api)\n\n ```php\n \n$uid = \"uid\"; //Required\n \n$result = $accountAPI-\u003egetAccessTokenByUid($uid);\n ```\n\n \n\u003ch6 id=\"RefreshAccessTokenByRefreshToken-get-\"\u003eRefresh Access Token by Refresh Token (GET)\u003c/h6\u003e \n\nThis API is used to refresh an access token via it's associated refresh token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/refresh-access-token-by-refresh-token)\n\n ```php\n \n$refresh_Token = \"refresh_Token\"; //Required\n \n$result = $accountAPI-\u003erefreshAccessTokenByRefreshToken($refresh_Token);\n ```\n\n \n\u003ch6 id=\"RevokeRefreshToken-get-\"\u003eRevoke Refresh Token (GET)\u003c/h6\u003e \n\nThe Revoke Refresh Access Token API is used to revoke a refresh token or the Provider Access Token, revoking an existing refresh token will invalidate the refresh token but the associated access token will work until the expiry.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/revoke-refresh-token)\n\n ```php\n \n$refresh_Token = \"refresh_Token\"; //Required\n \n$result = $accountAPI-\u003erevokeRefreshToken($refresh_Token);\n ```\n\n \n\u003ch6 id=\"GetAccountIdentitiesByEmail-get-\"\u003eAccount Identities by Email (GET)\u003c/h6\u003e \n\nNote: This is intended for specific workflows where an email may be associated to multiple UIDs. This API is used to retrieve all of the identities (UID and Profiles), associated with a specified email in Cloud Storage.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-identities-by-email)\n\n ```php\n \n$email = \"email\"; //Required \n$fields = null; //Optional\n \n$result = $accountAPI-\u003egetAccountIdentitiesByEmail($email,$fields);\n ```\n\n \n\u003ch6 id=\"DeleteAccountByUid-delete-\"\u003eAccount Delete (DELETE)\u003c/h6\u003e \n\nThis API deletes the Users account and allows them to re-register for a new account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-delete)\n\n ```php\n \n$uid = \"uid\"; //Required\n \n$result = $accountAPI-\u003edeleteAccountByUid($uid);\n ```\n\n \n\u003ch6 id=\"RemoveEmail-delete-\"\u003eAccount Remove Email (DELETE)\u003c/h6\u003e \n\nUse this API to Remove emails from a user Account\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-email-delete)\n\n ```php\n \n$email = \"email\"; //Required \n$uid = \"uid\"; //Required \n$fields = null; //Optional\n \n$result = $accountAPI-\u003eremoveEmail($email,$uid,$fields);\n ```\n\n \u003ch6 id=\"RevokeAllRefreshToken-delete-\"\u003eRevoke All Refresh Token (DELETE)\u003c/h6\u003e\n\n The Revoke All Refresh Access Token API is used to revoke all refresh tokens for a specific user. [More info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/revoke-all-refresh-token/)\n\n\n ```php\n \n$uid = \"uid\"; //Required\n \n$result = $accountAPI-\u003erevokeAllRefreshToken($uid);\n ```\n\n \n\u003ch6 id=\"AccountDeleteByEmail-delete-\"\u003eDelete User Profiles By Email (DELETE)\u003c/h6\u003e \n\nThis API is used to delete all user profiles associated with an Email.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/account/account-email-delete/)\n\n ```php\n \n$email = \"email\"; //Required\n \n$result = $accountAPI-\u003eaccountDeleteByEmail($email);\n ```\n\n \n\n\n\n### Social API\n\nList of APIs in this Section:\u003cbr\u003e\n[GET : Access Token](#ExchangeAccessToken-get-)\u003cbr\u003e\n[GET : Refresh Token](#RefreshAccessToken-get-)\u003cbr\u003e\n[GET : Token Validate](#ValidateAccessToken-get-)\u003cbr\u003e\n[GET : Access Token Invalidate](#InValidateAccessToken-get-)\u003cbr\u003e\n[GET : Get Active Session Details](#GetActiveSession-get-)\u003cbr\u003e\n[GET : Get Active Session By Account Id](#GetActiveSessionByAccountID-get-)\u003cbr\u003e\n[GET : Get Active Session By Profile Id](#GetActiveSessionByProfileID-get-)\u003cbr\u003e\n\nIf you have not already initialized the Social object do so now\n```php\n$socialAPI = new SocialAPI(); \n```\n\n \n\u003ch6 id=\"ExchangeAccessToken-get-\"\u003eAccess Token (GET)\u003c/h6\u003e \n\nThis API Is used to translate the Request Token returned during authentication into an Access Token that can be used with other API calls.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/access-token)\n\n ```php\n \n$token = \"token\"; //Required\n \n$result = $socialAPI-\u003eexchangeAccessToken($token);\n ```\n\n \n\u003ch6 id=\"RefreshAccessToken-get-\"\u003eRefresh Token (GET)\u003c/h6\u003e \n\nThe Refresh Access Token API is used to refresh the provider access token after authentication. It will be valid for up to 60 days on LoginRadius depending on the provider. In order to use the access token in other APIs, always refresh the token using this API.\u003cbr\u003e\u003cbr\u003e\u003cb\u003eSupported Providers :\u003c/b\u003e Facebook,Yahoo,Google,Twitter, Linkedin.\u003cbr\u003e\u003cbr\u003e Contact LoginRadius support team to enable this API.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/refresh-token/refresh-token)\n\n ```php\n \n$access_Token = \"access_Token\"; //Required \n$expiresIn = 0; //Optional \n$isWeb = true; //Optional\n \n$result = $socialAPI-\u003erefreshAccessToken($access_Token,$expiresIn,$isWeb);\n ```\n\n \n\u003ch6 id=\"ValidateAccessToken-get-\"\u003eToken Validate (GET)\u003c/h6\u003e \n\nThis API validates access token, if valid then returns a response with its expiry otherwise error.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/validate-access-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $socialAPI-\u003evalidateAccessToken($access_token);\n ```\n\n \n\u003ch6 id=\"InValidateAccessToken-get-\"\u003eAccess Token Invalidate (GET)\u003c/h6\u003e \n\nThis api invalidates the active access token or expires an access token validity.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/invalidate-access-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $socialAPI-\u003einValidateAccessToken($access_token);\n ```\n\n \n\u003ch6 id=\"GetActiveSession-get-\"\u003eGet Active Session Details (GET)\u003c/h6\u003e \n\nThis api is use to get all active session by Access Token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/advanced-social-api/get-active-session-details)\n\n ```php\n \n$token = \"token\"; //Required\n \n$result = $socialAPI-\u003egetActiveSession($token);\n ```\n\n \n\u003ch6 id=\"GetActiveSessionByAccountID-get-\"\u003eGet Active Session By Account Id (GET)\u003c/h6\u003e \n\nThis api is used to get all active sessions by AccountID(UID).\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/active-session-by-account-id/)\n\n ```php\n \n$accountId = \"accountId\"; //Required\n \n$result = $socialAPI-\u003egetActiveSessionByAccountID($accountId);\n ```\n\n \n\u003ch6 id=\"GetActiveSessionByProfileID-get-\"\u003eGet Active Session By Profile Id (GET)\u003c/h6\u003e \n\nThis api is used to get all active sessions by ProfileId.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/active-session-by-profile-id/)\n\n ```php\n \n$profileId = \"profileId\"; //Required\n \n$result = $socialAPI-\u003egetActiveSessionByProfileID($profileId);\n ```\n\n\n### CustomObject API\n\nList of APIs in this Section:\u003cbr\u003e\n[PUT : Custom Object Update by Access Token](#UpdateCustomObjectByToken-put-)\u003cbr\u003e\n[PUT : Custom Object Update by UID](#UpdateCustomObjectByUid-put-)\u003cbr\u003e\n[POST : Create Custom Object by Token](#CreateCustomObjectByToken-post-)\u003cbr\u003e\n[POST : Create Custom Object by UID](#CreateCustomObjectByUid-post-)\u003cbr\u003e\n[GET : Custom Object by Token](#GetCustomObjectByToken-get-)\u003cbr\u003e\n[GET : Custom Object by ObjectRecordId and Token](#GetCustomObjectByRecordIDAndToken-get-)\u003cbr\u003e\n[GET : Custom Object By UID](#GetCustomObjectByUid-get-)\u003cbr\u003e\n[GET : Custom Object by ObjectRecordId and UID](#GetCustomObjectByRecordID-get-)\u003cbr\u003e\n[DELETE : Custom Object Delete by Record Id And Token](#DeleteCustomObjectByToken-delete-)\u003cbr\u003e\n[DELETE : Account Delete Custom Object by ObjectRecordId](#DeleteCustomObjectByRecordID-delete-)\u003cbr\u003e\n\nIf you have not already initialized the CustomObject object do so now\n```php\n$customObjectAPI = new CustomObjectAPI(); \n```\n\n\n\u003ch6 id=\"UpdateCustomObjectByToken-put-\"\u003eCustom Object Update by Access Token (PUT)\u003c/h6\u003e \n\nThis API is used to update the specified custom object data of the specified account. If the value of updatetype is 'replace' then it will fully replace custom object with the new custom object and if the value of updatetype is 'partialreplace' then it will perform an upsert type operation\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-update-by-objectrecordid-and-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$objectName = \"objectName\"; //Required \n$objectRecordId = \"objectRecordId\"; //Required\n $payload = '{\"customdata1\": \"Store my customdata1 value\" }';  //Required \n$updateType = \"updateType\"; //Optional\n \n$result = $customObjectAPI-\u003eupdateCustomObjectByToken($access_token,$objectName,$objectRecordId,$payload,$updateType);\n ```\n\n \n\u003ch6 id=\"UpdateCustomObjectByUid-put-\"\u003eCustom Object Update by UID (PUT)\u003c/h6\u003e \n\nThis API is used to update the specified custom object data of a specified account. If the value of updatetype is 'replace' then it will fully replace custom object with new custom object and if the value of updatetype is partialreplace then it will perform an upsert type operation.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-update-by-objectrecordid-and-uid)\n\n ```php\n \n$objectName = \"objectName\"; //Required \n$objectRecordId = \"objectRecordId\"; //Required\n $payload = '{\"customdata1\": \"Store my customdata1 value\" }';  //Required \n$uid = \"uid\"; //Required \n$updateType = \"updateType\"; //Optional\n \n$result = $customObjectAPI-\u003eupdateCustomObjectByUid($objectName,$objectRecordId,$payload,$uid,$updateType);\n ```\n\n \n\u003ch6 id=\"CreateCustomObjectByToken-post-\"\u003eCreate Custom Object by Token (POST)\u003c/h6\u003e \n\nThis API is used to write information in JSON format to the custom object for the specified account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/create-custom-object-by-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$objectName = \"objectName\"; //Required\n $payload = '{\"customdata1\": \"Store my customdata1 value\" }';  //Required\n \n$result = $customObjectAPI-\u003ecreateCustomObjectByToken($access_token,$objectName,$payload);\n ```\n\n \n\u003ch6 id=\"CreateCustomObjectByUid-post-\"\u003eCreate Custom Object by UID (POST)\u003c/h6\u003e \n\nThis API is used to write information in JSON format to the custom object for the specified account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/create-custom-object-by-uid)\n\n ```php\n \n$objectName = \"objectName\"; //Required\n $payload = '{\"customdata1\": \"Store my customdata1 value\" }';  //Required \n$uid = \"uid\"; //Required\n \n$result = $customObjectAPI-\u003ecreateCustomObjectByUid($objectName,$payload,$uid);\n ```\n\n \n\u003ch6 id=\"GetCustomObjectByToken-get-\"\u003eCustom Object by Token (GET)\u003c/h6\u003e \n\nThis API is used to retrieve the specified Custom Object data for the specified account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$objectName = \"objectName\"; //Required\n \n$result = $customObjectAPI-\u003egetCustomObjectByToken($access_token,$objectName);\n ```\n\n \n\u003ch6 id=\"GetCustomObjectByRecordIDAndToken-get-\"\u003eCustom Object by ObjectRecordId and Token (GET)\u003c/h6\u003e \n\nThis API is used to retrieve the Custom Object data for the specified account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-objectrecordid-and-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$objectName = \"objectName\"; //Required \n$objectRecordId = \"objectRecordId\"; //Required\n \n$result = $customObjectAPI-\u003egetCustomObjectByRecordIDAndToken($access_token,$objectName,$objectRecordId);\n ```\n\n \n\u003ch6 id=\"GetCustomObjectByUid-get-\"\u003eCustom Object By UID (GET)\u003c/h6\u003e \n\nThis API is used to retrieve all the custom objects by UID from cloud storage.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-uid)\n\n ```php\n \n$objectName = \"objectName\"; //Required \n$uid = \"uid\"; //Required\n \n$result = $customObjectAPI-\u003egetCustomObjectByUid($objectName,$uid);\n ```\n\n \n\u003ch6 id=\"GetCustomObjectByRecordID-get-\"\u003eCustom Object by ObjectRecordId and UID (GET)\u003c/h6\u003e \n\nThis API is used to retrieve the Custom Object data for the specified account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-by-objectrecordid-and-uid)\n\n ```php\n \n$objectName = \"objectName\"; //Required \n$objectRecordId = \"objectRecordId\"; //Required \n$uid = \"uid\"; //Required\n \n$result = $customObjectAPI-\u003egetCustomObjectByRecordID($objectName,$objectRecordId,$uid);\n ```\n\n \n\u003ch6 id=\"DeleteCustomObjectByToken-delete-\"\u003eCustom Object Delete by Record Id And Token (DELETE)\u003c/h6\u003e \n\nThis API is used to remove the specified Custom Object data using ObjectRecordId of a specified account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-delete-by-objectrecordid-and-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$objectName = \"objectName\"; //Required \n$objectRecordId = \"objectRecordId\"; //Required\n \n$result = $customObjectAPI-\u003edeleteCustomObjectByToken($access_token,$objectName,$objectRecordId);\n ```\n\n \n\u003ch6 id=\"DeleteCustomObjectByRecordID-delete-\"\u003eAccount Delete Custom Object by ObjectRecordId (DELETE)\u003c/h6\u003e \n\nThis API is used to remove the specified Custom Object data using ObjectRecordId of specified account.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/custom-object/custom-object-delete-by-objectrecordid-and-uid)\n\n ```php\n \n$objectName = \"objectName\"; //Required \n$objectRecordId = \"objectRecordId\"; //Required \n$uid = \"uid\"; //Required\n \n$result = $customObjectAPI-\u003edeleteCustomObjectByRecordID($objectName,$objectRecordId,$uid);\n ```\n\n \n\n\n\n### PhoneAuthentication API\n\nList of APIs in this Section:\u003cbr\u003e\n[PUT : Phone Reset Password by OTP](#ResetPasswordByPhoneOTP-put-)\u003cbr\u003e\n[PUT : Phone Verification OTP](#PhoneVerificationByOTP-put-)\u003cbr\u003e\n[PUT : Phone Verification OTP by Token](#PhoneVerificationOTPByAccessToken-put-)\u003cbr\u003e\n[PUT : Phone Number Update](#UpdatePhoneNumber-put-)\u003cbr\u003e\n[POST : Phone Login](#LoginByPhone-post-)\u003cbr\u003e\n[POST : Phone Forgot Password by OTP](#ForgotPasswordByPhoneOTP-post-)\u003cbr\u003e\n[POST : Phone Resend Verification OTP](#PhoneResendVerificationOTP-post-)\u003cbr\u003e\n[POST : Phone Resend Verification OTP By Token](#PhoneResendVerificationOTPByToken-post-)\u003cbr\u003e\n[POST : Phone User Registration by SMS](#UserRegistrationByPhone-post-)\u003cbr\u003e\n[GET : Phone Number Availability](#CheckPhoneNumberAvailability-get-)\u003cbr\u003e\n[DELETE : Remove Phone ID by Access Token](#RemovePhoneIDByAccessToken-delete-)\u003cbr\u003e\n\nIf you have not already initialized the PhoneAuthentication object do so now\n```php\n$phoneAuthenticationAPI = new PhoneAuthenticationAPI(); \n```\n\n\n\u003ch6 id=\"ResetPasswordByPhoneOTP-put-\"\u003ePhone Reset Password by OTP (PUT)\u003c/h6\u003e \n\nThis API is used to reset the password\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-reset-password-by-otp)\n\n ```php\n\n $payload = '{\n\"otp\" : \"\u003cotp\u003e\",\n\"password\" : \"\u003cpassword\u003e\",\n\"phone\" : \"\u003cphone\u003e\"\n}';  //Required\n \n$result = $phoneAuthenticationAPI-\u003eresetPasswordByPhoneOTP($payload);\n ```\n\n \n\u003ch6 id=\"PhoneVerificationByOTP-put-\"\u003ePhone Verification OTP (PUT)\u003c/h6\u003e \n\nThis API is used to validate the verification code sent to verify a user's phone number\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-verify-otp)\n\n ```php\n \n$otp = \"otp\"; //Required \n$phone = \"phone\"; //Required \n$fields = null; //Optional \n$smsTemplate = \"smsTemplate\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $phoneAuthenticationAPI-\u003ephoneVerificationByOTP($otp,$phone,$fields,$smsTemplate,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"PhoneVerificationOTPByAccessToken-put-\"\u003ePhone Verification OTP by Token (PUT)\u003c/h6\u003e \n\nThis API is used to consume the verification code sent to verify a user's phone number. Use this call for front-end purposes in cases where the user is already logged in by passing the user's access token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-verify-otp-by-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$otp = \"otp\"; //Required \n$smsTemplate = \"smsTemplate\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $phoneAuthenticationAPI-\u003ephoneVerificationOTPByAccessToken($access_token,$otp,$smsTemplate,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"UpdatePhoneNumber-put-\"\u003ePhone Number Update (PUT)\u003c/h6\u003e \n\nThis API is used to update the login Phone Number of users\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-number-update)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$phone = \"phone\"; //Required \n$smsTemplate = \"smsTemplate\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $phoneAuthenticationAPI-\u003eupdatePhoneNumber($access_token,$phone,$smsTemplate,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"LoginByPhone-post-\"\u003ePhone Login (POST)\u003c/h6\u003e \n\nThis API retrieves a copy of the user data based on the Phone\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-login)\n\n ```php\n\n $payload = '{\n\"password\" : \"\u003cpassword\u003e\",\n\"phone\" : \"\u003cphone\u003e\"\n}';  //Required \n$fields = null; //Optional \n$loginUrl = \"loginUrl\"; //Optional \n$smsTemplate = \"smsTemplate\"; //Optional\n \n$result = $phoneAuthenticationAPI-\u003eloginByPhone($payload,$fields,$loginUrl,$smsTemplate);\n ```\n\n \n\u003ch6 id=\"ForgotPasswordByPhoneOTP-post-\"\u003ePhone Forgot Password by OTP (POST)\u003c/h6\u003e \n\nThis API is used to send the OTP to reset the account password.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-forgot-password-by-otp)\n\n ```php\n \n$phone = \"phone\"; //Required \n$smsTemplate = \"smsTemplate\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $phoneAuthenticationAPI-\u003eforgotPasswordByPhoneOTP($phone,$smsTemplate,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"PhoneResendVerificationOTP-post-\"\u003ePhone Resend Verification OTP (POST)\u003c/h6\u003e \n\nThis API is used to resend a verification OTP to verify a user's Phone Number. The user will receive a verification code that they will need to input\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-resend-otp)\n\n ```php\n \n$phone = \"phone\"; //Required \n$smsTemplate = \"smsTemplate\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $phoneAuthenticationAPI-\u003ephoneResendVerificationOTP($phone,$smsTemplate,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"PhoneResendVerificationOTPByToken-post-\"\u003ePhone Resend Verification OTP By Token (POST)\u003c/h6\u003e \n\nThis API is used to resend a verification OTP to verify a user's Phone Number in cases in which an active token already exists\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-resend-otp-by-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$phone = \"phone\"; //Required \n$smsTemplate = \"smsTemplate\"; //Optional\n \n$result = $phoneAuthenticationAPI-\u003ephoneResendVerificationOTPByToken($access_token,$phone,$smsTemplate);\n ```\n\n \n\u003ch6 id=\"UserRegistrationByPhone-post-\"\u003ePhone User Registration by SMS (POST)\u003c/h6\u003e \n\nThis API registers the new users into your Cloud Storage and triggers the phone verification process.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-user-registration-by-sms)\n\n ```php\n\n $payload = '{\n\"email\" : [   { \n \"type\" : \"\u003ctype\u003e\"  ,\n \"value\" : \"\u003cvalue\u003e\"   \n}] ,\n\"firstName\" : \"\u003cfirstName\u003e\",\n\"lastName\" : \"\u003clastName\u003e\",\n\"password\" : \"\u003cpassword\u003e\",\n\"phoneId\" : \"\u003cphoneId\u003e\"\n}';  //Required \n$sott = \"sott\"; //Required \n$fields = null; //Optional \n$options = \"options\"; //Optional \n$smsTemplate = \"smsTemplate\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional \n$welcomeEmailTemplate = \"welcomeEmailTemplate\"; //Optional\n$emailTemplate = \"emailTemplate\"; //Optional\n$isVoiceOtp = false; //Optional\n \n$result = $phoneAuthenticationAPI-\u003euserRegistrationByPhone($payload,$sott,$fields,$options,$smsTemplate,$verificationUrl,$welcomeEmailTemplate,$emailTemplate,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"CheckPhoneNumberAvailability-get-\"\u003ePhone Number Availability (GET)\u003c/h6\u003e \n\nThis API is used to check the Phone Number exists or not on your site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/phone-number-availability)\n\n ```php\n \n$phone = \"phone\"; //Required\n \n$result = $phoneAuthenticationAPI-\u003echeckPhoneNumberAvailability($phone);\n ```\n\n \n\u003ch6 id=\"RemovePhoneIDByAccessToken-delete-\"\u003eRemove Phone ID by Access Token (DELETE)\u003c/h6\u003e \n\nThis API is used to delete the Phone ID on a user's account via the access token\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/phone-authentication/remove-phone-id-by-access-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $phoneAuthenticationAPI-\u003eremovePhoneIDByAccessToken($access_token);\n ```\n\n \n\n\n\n### MultiFactorAuthentication API\n\nList of APIs in this Section:\u003cbr\u003e\n[PUT : Update MFA Setting](#MFAUpdateSetting-put-)\u003cbr\u003e\n[PUT : MFA Update Phone Number by Token](#MFAUpdatePhoneNumberByToken-put-)\u003cbr\u003e\n[PUT : Verify MFA Email OTP by Access Token](#MFAValidateEmailOtpByAccessToken-put-)\u003cbr\u003e\n[PUT : Update MFA Security Question by Access Token](#MFASecurityQuestionAnswerByAccessToken-put-)\u003cbr\u003e\n[PUT : MFA Validate OTP](#MFAValidateOTPByPhone-put-)\u003cbr\u003e\n[PUT : MFA Validate Backup code](#MFAValidateBackupCode-put-)\u003cbr\u003e\n[PUT : MFA Update Phone Number](#MFAUpdatePhoneNumber-put-)\u003cbr\u003e\n[PUT : Verify MFA Email OTP by MFA Token](#MFAValidateEmailOtp-put-)\u003cbr\u003e\n[PUT : Update MFA Security Question by MFA Token](#MFASecurityQuestionAnswer-put-)\u003cbr\u003e\n[PUT : MFA Validate Authenticator Code](#MFAValidateAuthenticatorCode-put-)\u003cbr\u003e\n[PUT : MFA Verify Authenticator Code](#MFAVerifyAuthenticatorCode-put-)\u003cbr\u003e\n[POST : MFA Email Login](#MFALoginByEmail-post-)\u003cbr\u003e\n[POST : MFA UserName Login](#MFALoginByUserName-post-)\u003cbr\u003e\n[POST : MFA Phone Login](#MFALoginByPhone-post-)\u003cbr\u003e\n[POST : Send MFA Email OTP by MFA Token](#MFAEmailOTP-post-)\u003cbr\u003e\n[POST : Verify MFA Security Question by MFA Token](#MFASecurityQuestionAnswerVerification-post-)\u003cbr\u003e\n[GET : MFA Validate Access Token](#MFAConfigureByAccessToken-get-)\u003cbr\u003e\n[GET : MFA Backup Code by Access Token](#MFABackupCodeByAccessToken-get-)\u003cbr\u003e\n[GET : Reset Backup Code by Access Token](#MFAResetBackupCodeByAccessToken-get-)\u003cbr\u003e\n[GET : Send MFA Email OTP by Access Token](#MFAEmailOtpByAccessToken-get-)\u003cbr\u003e\n[GET : MFA Resend Otp](#MFAResendOTP-get-)\u003cbr\u003e\n[GET : MFA Backup Code by UID](#MFABackupCodeByUid-get-)\u003cbr\u003e\n[GET : MFA Reset Backup Code by UID](#MFAResetBackupCodeByUid-get-)\u003cbr\u003e\n[DELETE : MFA Reset Authenticator by Token](#MFAResetAuthenticatorByToken-delete-)\u003cbr\u003e\n[DELETE : MFA Reset SMS Authenticator by Token](#MFAResetSMSAuthByToken-delete-)\u003cbr\u003e\n[DELETE : Reset MFA Email OTP Authenticator By Access Token](#MFAResetEmailOtpAuthenticatorByAccessToken-delete-)\u003cbr\u003e\n[DELETE : MFA Reset Security Question Authenticator By Access Token](#MFAResetSecurityQuestionAuthenticatorByAccessToken-delete-)\u003cbr\u003e\n[DELETE : MFA Reset SMS Authenticator By UID](#MFAResetSMSAuthenticatorByUid-delete-)\u003cbr\u003e\n[DELETE : MFA Reset Authenticator By UID](#MFAResetAuthenticatorByUid-delete-)\u003cbr\u003e\n[DELETE : Reset MFA Email OTP Authenticator Settings by Uid](#MFAResetEmailOtpAuthenticatorByUid-delete-)\u003cbr\u003e\n[DELETE : Reset MFA Security Question Authenticator Settings by Uid](#MFAResetSecurityQuestionAuthenticatorByUid-delete-)\u003cbr\u003e\n\nIf you have not already initialized the MultiFactorAuthentication object do so now\n```php\n$multiFactorAuthenticationAPI = new MultiFactorAuthenticationAPI(); \n```\n\n\n\u003ch6 id=\"MFAUpdateSetting-put-\"\u003eUpdate MFA Setting (PUT)\u003c/h6\u003e \n\nThis API is used to trigger the Multi-factor authentication settings after login for secure actions\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/update-mfa-setting/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n $payload = '{\n\"otp\" : \"\u003cotp\u003e\"\n}';  //Required \n$fields = null; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaUpdateSetting($access_token,$payload,$fields);\n ```\n\n \n\u003ch6 id=\"MFAUpdatePhoneNumberByToken-put-\"\u003eMFA Update Phone Number by Token (PUT)\u003c/h6\u003e \n\nThis API is used to update the Multi-factor authentication phone number by sending the verification OTP to the provided phone number\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-update-phone-number-by-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$phoneNo2FA = \"phoneNo2FA\"; //Required \n$smsTemplate2FA = \"smsTemplate2FA\"; //Optional \n$isVoiceOtp = false; //Optional\n$options = \"options\"; //Optional \n\n$result = $multiFactorAuthenticationAPI-\u003emfaUpdatePhoneNumberByToken($access_token,$phoneNo2FA,$smsTemplate2FA,$isVoiceOtp,$options);\n ```\n\n \n\u003ch6 id=\"MFAValidateEmailOtpByAccessToken-put-\"\u003eVerify MFA Email OTP by Access Token (PUT)\u003c/h6\u003e \n\nThis API is used to set up MFA Email OTP authenticator on profile after login.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/verify-mfa-otp-by-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n $payload = '{ \n   \"EmailId\":\"\",\n   \"Otp\":\"otp\"\n  }';  //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaValidateEmailOtpByAccessToken($access_token,$payload);\n ```\n\n \n\u003ch6 id=\"MFASecurityQuestionAnswerByAccessToken-put-\"\u003eUpdate MFA Security Question by Access Token (PUT)\u003c/h6\u003e \n\nThis API is used to set up MFA Security Question authenticator on profile after login.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-security-question-by-access-token)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n $payload = '{\n    \"securityquestionanswer\": [\n        {\n            \"QuestionId\": \"db7****8a73e4******bd9****8c20\",\n            \"Answer\": \"\u003canswer\u003e\"\n        }\n    ],\n     \"ReplaceSecurityQuestionAnswer\":false // required\n  }';  //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaSecurityQuestionAnswerByAccessToken($access_token,$payload);\n ```\n\n \n\u003ch6 id=\"MFAValidateOTPByPhone-put-\"\u003eMFA Validate OTP (PUT)\u003c/h6\u003e \n\nThis API is used to login via Multi-factor authentication by passing the One Time Password received via SMS\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-validate-otp/)\n\n ```php\n\n $payload = '{\n\"otp\" : \"\u003cotp\u003e\"\n}';  //Required \n$secondFactorAuthenticationToken = \"secondFactorAuthenticationToken\"; //Required \n$fields = null; //Optional \n$smsTemplate2FA = \"smsTemplate2FA\"; //Optional\n$rbaBrowserEmailTemplate = \"rbaBrowserEmailTemplate\"; //Optional \n$rbaCityEmailTemplate = \"rbaCityEmailTemplate\"; //Optional \n$rbaCountryEmailTemplate = \"rbaCountryEmailTemplate\"; //Optional \n$rbaIpEmailTemplate = \"rbaIpEmailTemplate\"; //Optional \n \n$result = $multiFactorAuthenticationAPI-\u003emfaValidateOTPByPhone($payload,$secondFactorAuthenticationToken,$fields,$smsTemplate2FA,$rbaBrowserEmailTemplate,$rbaCityEmailTemplate,$rbaCountryEmailTemplate,$rbaIpEmailTemplate);\n ```\n\n\n \n\u003ch6 id=\"MFAValidateBackupCode-put-\"\u003eMFA Validate Backup code (PUT)\u003c/h6\u003e \n\nThis API is used to validate the backup code provided by the user and if valid, we return an access token allowing the user to login incases where Multi-factor authentication (MFA) is enabled and the secondary factor is unavailable. When a user initially downloads the Backup codes, We generate 10 codes, each code can only be consumed once. if any user attempts to go over the number of invalid login attempts configured in the Dashboard then the account gets blocked automatically\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-validate-backup-code/)\n\n ```php\n\n $payload = '{\n\"backupCode\" : \"\u003cbackupCode\u003e\"\n}';  //Required \n$secondFactorAuthenticationToken = \"secondFactorAuthenticationToken\"; //Required \n$fields = null; //Optional \n$rbaBrowserEmailTemplate = \"rbaBrowserEmailTemplate\"; //Optional \n$rbaCityEmailTemplate = \"rbaCityEmailTemplate\"; //Optional \n$rbaCountryEmailTemplate = \"rbaCountryEmailTemplate\"; //Optional \n$rbaIpEmailTemplate = \"rbaIpEmailTemplate\"; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaValidateBackupCode($payload,$secondFactorAuthenticationToken,$fields,$rbaBrowserEmailTemplate,$rbaCityEmailTemplate,$rbaCountryEmailTemplate,$rbaIpEmailTemplate);\n ```\n\n \n\u003ch6 id=\"MFAUpdatePhoneNumber-put-\"\u003eMFA Update Phone Number (PUT)\u003c/h6\u003e \n\nThis API is used to update (if configured) the phone number used for Multi-factor authentication by sending the verification OTP to the provided phone number\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-update-phone-number/)\n\n ```php\n \n$phoneNo2FA = \"phoneNo2FA\"; //Required \n$secondFactorAuthenticationToken = \"secondFactorAuthenticationToken\"; //Required \n$smsTemplate2FA = \"smsTemplate2FA\"; //Optional \n$isVoiceOtp = false; //Optional\n$options = \"options\"; //Optional \n\n \n$result = $multiFactorAuthenticationAPI-\u003emfaUpdatePhoneNumber($phoneNo2FA,$secondFactorAuthenticationToken,$smsTemplate2FA,$isVoiceOtp,$options);\n ```\n\n \n\u003ch6 id=\"MFAValidateEmailOtp-put-\"\u003eVerify MFA Email OTP by MFA Token (PUT)\u003c/h6\u003e \n\nThis API is used to Verify MFA Email OTP by MFA Token\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/verify-mfa-email-otp-by-mfa-token/)\n\n ```php\n\n $payload = '\n    {\n        \"EmailId\":\"email\",\n        \"Otp\":\"otp\"\n    }';  //Required \n$secondFactorAuthenticationToken = \"secondFactorAuthenticationToken\"; //Required \n$rbaBrowserEmailTemplate = \"rbaBrowserEmailTemplate\"; //Optional \n$rbaCityEmailTemplate = \"rbaCityEmailTemplate\"; //Optional \n$rbaCountryEmailTemplate = \"rbaCountryEmailTemplate\"; //Optional \n$rbaIpEmailTemplate = \"rbaIpEmailTemplate\"; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaValidateEmailOtp($payload,$secondFactorAuthenticationToken,$rbaBrowserEmailTemplate,$rbaCityEmailTemplate,$rbaCountryEmailTemplate,$rbaIpEmailTemplate);\n ```\n\n \n\u003ch6 id=\"MFASecurityQuestionAnswer-put-\"\u003eUpdate MFA Security Question by MFA Token (PUT)\u003c/h6\u003e \n\nThis API is used to set the security questions on the profile with the MFA token when MFA flow is required.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/update-mfa-security-question-by-mfa-token/)\n\n ```php\n\n $payload = '{\n    \"securityquestionanswer\": [\n        {\n            \"QuestionId\": \"db7****8a73e4******bd9****8c20\",\n            \"Answer\": \"\u003canswer\u003e\"\n        }\n    ]\n}';  //Required \n$secondFactorAuthenticationToken = \"secondFactorAuthenticationToken\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaSecurityQuestionAnswer($payload,$secondFactorAuthenticationToken);\n ```\n\n\u003ch6 id=\"MFAValidateAuthenticatorCode-put-\"\u003eMFA Validate Authenticator Code (PUT)\u003c/h6\u003e\n\n\n This API is used to login to a user's account during the second MFA step with an Authenticator Code. [More info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/authenticator/mfa-validate-authenticator-code/)\n\n\n ```php\n\n$payload = '{ \n\"authenticatorCode\" : \"\u003cauthenticatorCode\u003e\"\n}';  //Required \n$secondfactorauthenticationtoken = \"secondfactorauthenticationtoken\"; //Required \n$fields = null; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaValidateAuthenticatorCode($payload,$secondfactorauthenticationtoken,$fields);\n ```\n\n\u003ch6 id=\"MFAVerifyAuthenticatorCode-put-\"\u003eMFA Verify Authenticator Code (PUT)\u003c/h6\u003e\n\n This API is used to validate an Authenticator Code as part of the MFA process. [More info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/authenticator/mfa-verify-authenticator-code/)\n\n\n ```php\n \n$access_token = \"access_token\"; //Required\n $payload = '{\n\"authenticatorCode\" : \"\u003cauthenticatorCode\u003e\"\n}';  //Required \n$fields = null; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaVerifyAuthenticatorCode($access_token,$payload,$fields);\n ```\n \n\u003ch6 id=\"MFALoginByEmail-post-\"\u003eMFA Email Login (POST)\u003c/h6\u003e \n\nThis API can be used to login by emailid on a Multi-factor authentication enabled LoginRadius site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/mfa-email-login)\n\n ```php\n \n$email = \"email\"; //Required \n$password = \"password\"; //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$fields = null; //Optional \n$loginUrl = \"loginUrl\"; //Optional \n$smsTemplate = \"smsTemplate\"; //Optional \n$smsTemplate2FA = \"smsTemplate2FA\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional \n$emailTemplate2FA = \"emailTemplate2FA\"; //Optional \n$isVoiceOtp = false; //Optional\n$options = \"options\"; //Optional \n\n$result = $multiFactorAuthenticationAPI-\u003emfaLoginByEmail($email,$password,$emailTemplate,$fields,$loginUrl,$smsTemplate,$smsTemplate2FA,$verificationUrl,$emailTemplate2FA,$isVoiceOtp,$options);\n ```\n\n \n\u003ch6 id=\"MFALoginByUserName-post-\"\u003eMFA UserName Login (POST)\u003c/h6\u003e \n\nThis API can be used to login by username on a Multi-factor authentication enabled LoginRadius site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/mfa-user-name-login)\n\n ```php\n \n$password = \"password\"; //Required \n$username = \"username\"; //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$fields = null; //Optional \n$loginUrl = \"loginUrl\"; //Optional \n$smsTemplate = \"smsTemplate\"; //Optional \n$smsTemplate2FA = \"smsTemplate2FA\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional \n$emailTemplate2FA = \"emailTemplate2FA\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaLoginByUserName($password,$username,$emailTemplate,$fields,$loginUrl,$smsTemplate,$smsTemplate2FA,$verificationUrl,$emailTemplate2FA,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"MFALoginByPhone-post-\"\u003eMFA Phone Login (POST)\u003c/h6\u003e \n\nThis API can be used to login by Phone on a Multi-factor authentication enabled LoginRadius site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/mfa-phone-login)\n\n ```php\n \n$password = \"password\"; //Required \n$phone = \"phone\"; //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$fields = null; //Optional \n$loginUrl = \"loginUrl\"; //Optional \n$smsTemplate = \"smsTemplate\"; //Optional \n$smsTemplate2FA = \"smsTemplate2FA\"; //Optional \n$verificationUrl = \"verificationUrl\"; //Optional \n$emailTemplate2FA = \"emailTemplate2FA\"; //Optional \n$isVoiceOtp = false; //Optional\n$options = \"options\"; //Optional \n\n$result = $multiFactorAuthenticationAPI-\u003emfaLoginByPhone($password,$phone,$emailTemplate,$fields,$loginUrl,$smsTemplate,$smsTemplate2FA,$verificationUrl,$emailTemplate2FA,$isVoiceOtp,$options);\n ```\n\n \n\u003ch6 id=\"MFAEmailOTP-post-\"\u003eSend MFA Email OTP by MFA Token (POST)\u003c/h6\u003e \n\nAn API designed to send the MFA Email OTP to the email.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/send-mfa-email-otp-by-mfa-token/)\n\n ```php\n\n $payload = '{ \n    \"EmailId\":\"email\"\n  }';  //Required \n$secondFactorAuthenticationToken = \"secondFactorAuthenticationToken\"; //Required \n$emailTemplate2FA = \"emailTemplate2FA\"; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaEmailOTP($payload,$secondFactorAuthenticationToken,$emailTemplate2FA);\n ```\n\n \n\u003ch6 id=\"MFASecurityQuestionAnswerVerification-post-\"\u003eVerify MFA Security Question by MFA Token (POST)\u003c/h6\u003e \n\nThis API is used to resending the verification OTP to the provided phone number\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/verify-mfa-security-question-by-mfa-token/)\n\n ```php\n\n $payload = '{\n    \"securityquestionanswer\": [\n        {\n            \"QuestionId\": \"db7****8a73e4******bd9****8c20\",\n            \"Answer\": \"\u003canswer\u003e\"\n        }\n    ]\n}';  //Required \n$secondFactorAuthenticationToken = \"secondFactorAuthenticationToken\"; //Required \n$rbaBrowserEmailTemplate = \"rbaBrowserEmailTemplate\"; //Optional \n$rbaCityEmailTemplate = \"rbaCityEmailTemplate\"; //Optional \n$rbaCountryEmailTemplate = \"rbaCountryEmailTemplate\"; //Optional \n$rbaIpEmailTemplate = \"rbaIpEmailTemplate\"; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaSecurityQuestionAnswerVerification($payload,$secondFactorAuthenticationToken,$rbaBrowserEmailTemplate,$rbaCityEmailTemplate,$rbaCountryEmailTemplate,$rbaIpEmailTemplate);\n ```\n\n \n\u003ch6 id=\"MFAConfigureByAccessToken-get-\"\u003eMFA Validate Access Token (GET)\u003c/h6\u003e \n\nThis API is used to configure the Multi-factor authentication after login by using the access token when MFA is set as optional on the LoginRadius site.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/mfa-validate-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$isVoiceOtp = false; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaConfigureByAccessToken($access_token,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"MFABackupCodeByAccessToken-get-\"\u003eMFA Backup Code by Access Token (GET)\u003c/h6\u003e \n\nThis API is used to get a set of backup codes via access token to allow the user login on a site that has Multi-factor Authentication enabled in the event that the user does not have a secondary factor available. We generate 10 codes, each code can only be consumed once. If any user attempts to go over the number of invalid login attempts configured in the Dashboard then the account gets blocked automatically\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-backup-code-by-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaBackupCodeByAccessToken($access_token);\n ```\n\n \n\u003ch6 id=\"MFAResetBackupCodeByAccessToken-get-\"\u003eReset Backup Code by Access Token (GET)\u003c/h6\u003e \n\nAPI is used to reset the backup codes on a given account via the access token. This API call will generate 10 new codes, each code can only be consumed once\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-reset-backup-code-by-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResetBackupCodeByAccessToken($access_token);\n ```\n\n \n\u003ch6 id=\"MFAEmailOtpByAccessToken-get-\"\u003eSend MFA Email OTP by Access Token (GET)\u003c/h6\u003e \n\nThis API is created to send the OTP to the email if email OTP authenticator is enabled in app's MFA configuration.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/send-mfa-email-otp-by-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$emailId = \"emailId\"; //Required \n$emailTemplate2FA = \"emailTemplate2FA\"; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaEmailOtpByAccessToken($access_token,$emailId,$emailTemplate2FA);\n ```\n\n \n\u003ch6 id=\"MFAResendOTP-get-\"\u003eMFA Resend Otp (GET)\u003c/h6\u003e \n\nThis API is used to resending the verification OTP to the provided phone number\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/resend-twofactorauthentication-otp/)\n\n ```php\n \n$secondFactorAuthenticationToken = \"secondFactorAuthenticationToken\"; //Required \n$smsTemplate2FA = \"smsTemplate2FA\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResendOTP($secondFactorAuthenticationToken,$smsTemplate2FA,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"MFABackupCodeByUid-get-\"\u003eMFA Backup Code by UID (GET)\u003c/h6\u003e \n\nThis API is used to reset the backup codes on a given account via the UID. This API call will generate 10 new codes, each code can only be consumed once.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-backup-code-by-uid/)\n\n ```php\n \n$uid = \"uid\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaBackupCodeByUid($uid);\n ```\n\n \n\u003ch6 id=\"MFAResetBackupCodeByUid-get-\"\u003eMFA Reset Backup Code by UID (GET)\u003c/h6\u003e \n\nThis API is used to reset the backup codes on a given account via the UID. This API call will generate 10 new codes, each code can only be consumed once.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/mfa-reset-backup-code-by-uid/)\n\n ```php\n \n$uid = \"uid\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResetBackupCodeByUid($uid);\n ```\n\n\u003ch6 id=\"MFAResetAuthenticatorByToken-delete-\"\u003eMFA Reset Authenticator by Token (DELETE)\u003c/h6\u003e\n\n This API Resets the Authenticator configurations on a given account via the access_token. [More info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/authenticator/mfa-reset-authenticator-by-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$authenticator = true; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResetAuthenticatorByToken($access_token,$authenticator);\n ```\n\n \n\u003ch6 id=\"MFAResetSMSAuthByToken-delete-\"\u003eMFA Reset SMS Authenticator by Token (DELETE)\u003c/h6\u003e \n\nThis API resets the SMS Authenticator configurations on a given account via the access token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-reset-sms-authenticator-by-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required \n$otpauthenticator = true; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResetSMSAuthByToken($access_token,$otpauthenticator);\n ```\n\n \n\u003ch6 id=\"MFAResetEmailOtpAuthenticatorByAccessToken-delete-\"\u003eReset MFA Email OTP Authenticator By Access Token (DELETE)\u003c/h6\u003e \n\nThis API is used to reset the Email OTP Authenticator settings for an MFA-enabled user\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/reset-mfa-email-otp-authenticator-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResetEmailOtpAuthenticatorByAccessToken($access_token);\n ```\n\n \n\u003ch6 id=\"MFAResetSecurityQuestionAuthenticatorByAccessToken-delete-\"\u003eMFA Reset Security Question Authenticator By Access Token (DELETE)\u003c/h6\u003e \n\nThis API is used to Reset MFA Security Question Authenticator By Access Token\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/reset-mfa-security-question-by-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResetSecurityQuestionAuthenticatorByAccessToken($access_token);\n ```\n\n \n\u003ch6 id=\"MFAResetSMSAuthenticatorByUid-delete-\"\u003eMFA Reset SMS Authenticator By UID (DELETE)\u003c/h6\u003e \n\nThis API resets the SMS Authenticator configurations on a given account via the UID.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/sms-authenticator/mfa-reset-sms-authenticator-by-uid/)\n\n ```php\n \n$otpauthenticator = true; //Required \n$uid = \"uid\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResetSMSAuthenticatorByUid($otpauthenticator,$uid);\n ```\n\n\n \u003ch6 id=\"MFAResetAuthenticatorByUid-delete-\"\u003eMFA Reset Authenticator By UID (DELETE)\u003c/h6\u003e\n\n This API resets the Authenticator configurations on a given account via the UID. [More info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/authenticator/mfa-reset-authenticator-by-uid/)\n\n ```php\n \n$authenticator = true; //Required \n$uid = \"uid\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResetAuthenticatorByUid($authenticator,$uid);\n ```\n\n\n \n\u003ch6 id=\"MFAResetEmailOtpAuthenticatorByUid-delete-\"\u003eReset MFA Email OTP Authenticator Settings by Uid (DELETE)\u003c/h6\u003e \n\nThis API is used to reset the Email OTP Authenticator settings for an MFA-enabled user.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/reset-mfa-email-otp-authenticator-settings-by-uid/)\n\n ```php\n \n$uid = \"uid\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResetEmailOtpAuthenticatorByUid($uid);\n ```\n\n \n\u003ch6 id=\"MFAResetSecurityQuestionAuthenticatorByUid-delete-\"\u003eReset MFA Security Question Authenticator Settings by Uid (DELETE)\u003c/h6\u003e \n\nThis API is used to reset the Security Question Authenticator settings for an MFA-enabled user.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/backup-codes/reset-mfa-security-question-authenticator-settings-by-uid/)\n\n ```php\n \n$uid = \"uid\"; //Required\n \n$result = $multiFactorAuthenticationAPI-\u003emfaResetSecurityQuestionAuthenticatorByUid($uid);\n ```\n\n### PINAuthentication API\n\nList of APIs in this Section:\u003cbr\u003e\n[PUT : Reset PIN By ResetToken](#ResetPINByResetToken-put-)\u003cbr\u003e\n[PUT : Reset PIN By SecurityAnswer And Email](#ResetPINByEmailAndSecurityAnswer-put-)\u003cbr\u003e\n[PUT : Reset PIN By SecurityAnswer And Username](#ResetPINByUsernameAndSecurityAnswer-put-)\u003cbr\u003e\n[PUT : Reset PIN By SecurityAnswer And Phone](#ResetPINByPhoneAndSecurityAnswer-put-)\u003cbr\u003e\n[PUT : Change PIN By Token](#ChangePINByAccessToken-put-)\u003cbr\u003e\n[PUT : Reset PIN by Phone and OTP](#ResetPINByPhoneAndOtp-put-)\u003cbr\u003e\n[PUT : Reset PIN by Email and OTP](#ResetPINByEmailAndOtp-put-)\u003cbr\u003e\n[PUT : Reset PIN by Username and OTP](#ResetPINByUsernameAndOtp-put-)\u003cbr\u003e\n[POST : PIN Login](#PINLogin-post-)\u003cbr\u003e\n[POST : Forgot PIN By Email](#SendForgotPINEmailByEmail-post-)\u003cbr\u003e\n[POST : Forgot PIN By UserName](#SendForgotPINEmailByUsername-post-)\u003cbr\u003e\n[POST : Forgot PIN By Phone](#SendForgotPINSMSByPhone-post-)\u003cbr\u003e\n[POST : Set PIN By PinAuthToken](#SetPINByPinAuthToken-post-)\u003cbr\u003e\n[GET : Invalidate PIN Session Token](#InValidatePinSessionToken-get-)\u003cbr\u003e\n\nIf you have not already initialized the PINAuthentication object do so now\n```php\n$pinAuthenticationAPI = new PINAuthenticationAPI(); \n```\n\n\n\u003ch6 id=\"ResetPINByResetToken-put-\"\u003eReset PIN By ResetToken (PUT)\u003c/h6\u003e \n\nThis API is used to reset pin using reset token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-resettoken/)\n\n ```php\n\n $payload = '{\n\"pin\" : \"\u003cpin\u003e\",\n\"resetToken\" : \"\u003cresetToken\u003e\"\n}';  //Required\n \n$result = $pinAuthenticationAPI-\u003eresetPINByResetToken($payload);\n ```\n\n \n\u003ch6 id=\"ResetPINByEmailAndSecurityAnswer-put-\"\u003eReset PIN By SecurityAnswer And Email (PUT)\u003c/h6\u003e \n\nThis API is used to reset pin using security question answer and email.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-securityanswer-and-email/)\n\n ```php\n\n $payload = '{\n\"email\" : \"\u003cemail\u003e\",\n\"pin\" : \"\u003cpin\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"}\n}';  //Required\n \n$result = $pinAuthenticationAPI-\u003eresetPINByEmailAndSecurityAnswer($payload);\n ```\n\n \n\u003ch6 id=\"ResetPINByUsernameAndSecurityAnswer-put-\"\u003eReset PIN By SecurityAnswer And Username (PUT)\u003c/h6\u003e \n\nThis API is used to reset pin using security question answer and username.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-securityanswer-and-username/)\n\n ```php\n\n $payload = '{\n\"pin\" : \"\u003cpin\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"},\n\"username\" : \"\u003cusername\u003e\"\n}';  //Required\n \n$result = $pinAuthenticationAPI-\u003eresetPINByUsernameAndSecurityAnswer($payload);\n ```\n\n \n\u003ch6 id=\"ResetPINByPhoneAndSecurityAnswer-put-\"\u003eReset PIN By SecurityAnswer And Phone (PUT)\u003c/h6\u003e \n\nThis API is used to reset pin using security question answer and phone.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-securityanswer-and-phone/)\n\n ```php\n\n $payload = '{\n\"phone\" : \"\u003cphone\u003e\",\n\"pin\" : \"\u003cpin\u003e\",\n\"securityAnswer\" : {\"QuestionID\":\"Answer\"}\n}';  //Required\n \n$result = $pinAuthenticationAPI-\u003eresetPINByPhoneAndSecurityAnswer($payload);\n ```\n\n \n\u003ch6 id=\"ChangePINByAccessToken-put-\"\u003eChange PIN By Token (PUT)\u003c/h6\u003e \n\nThis API is used to change a user's PIN using access token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/change-pin-by-access-token/)\n\n ```php\n \n$access_token = \"access_token\"; //Required\n $payload = '{\n\"newPIN\" : \"\u003cnewPIN\u003e\",\n\"oldPIN\" : \"\u003coldPIN\u003e\"\n}';  //Required\n \n$result = $pinAuthenticationAPI-\u003echangePINByAccessToken($access_token,$payload);\n ```\n\n \n\u003ch6 id=\"ResetPINByPhoneAndOtp-put-\"\u003eReset PIN by Phone and OTP (PUT)\u003c/h6\u003e \n\nThis API is used to reset pin using phoneId and OTP.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-phone-and-otp/)\n\n ```php\n\n $payload = '{\n\"otp\" : \"\u003cotp\u003e\",\n\"phone\" : \"\u003cphone\u003e\",\n\"pin\" : \"\u003cpin\u003e\"\n}';  //Required\n \n$result = $pinAuthenticationAPI-\u003eresetPINByPhoneAndOtp($payload);\n ```\n\n \n\u003ch6 id=\"ResetPINByEmailAndOtp-put-\"\u003eReset PIN by Email and OTP (PUT)\u003c/h6\u003e \n\nThis API is used to reset pin using email and OTP.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-email-and-otp/)\n\n ```php\n\n $payload = '{\n\"email\" : \"\u003cemail\u003e\",\n\"otp\" : \"\u003cotp\u003e\",\n\"pin\" : \"\u003cpin\u003e\"\n}';  //Required\n \n$result = $pinAuthenticationAPI-\u003eresetPINByEmailAndOtp($payload);\n ```\n\n \n\u003ch6 id=\"ResetPINByUsernameAndOtp-put-\"\u003eReset PIN by Username and OTP (PUT)\u003c/h6\u003e \n\nThis API is used to reset pin using username and OTP.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/reset-pin-by-username-and-otp/)\n\n ```php\n\n $payload = '{\n\"otp\" : \"\u003cotp\u003e\",\n\"pin\" : \"\u003cpin\u003e\",\n\"username\" : \"\u003cusername\u003e\"\n}';  //Required\n \n$result = $pinAuthenticationAPI-\u003eresetPINByUsernameAndOtp($payload);\n ```\n\n \n\u003ch6 id=\"PINLogin-post-\"\u003ePIN Login (POST)\u003c/h6\u003e \n\nThis API is used to login a user by pin and session token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/login-by-pin/)\n\n ```php\n\n $payload = '{\n\"pin\" : \"\u003cpin\u003e\"\n}';  //Required \n$session_token = \"session_token\"; //Required\n \n$result = $pinAuthenticationAPI-\u003epinLogin($payload,$session_token);\n ```\n\n \n\u003ch6 id=\"SendForgotPINEmailByEmail-post-\"\u003eForgot PIN By Email (POST)\u003c/h6\u003e \n\nThis API sends the reset pin email to specified email address.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/forgot-pin-by-email/)\n\n ```php\n\n $payload = '{\n\"email\" : \"\u003cemail\u003e\"\n}';  //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$resetPINUrl = \"resetPINUrl\"; //Optional\n \n$result = $pinAuthenticationAPI-\u003esendForgotPINEmailByEmail($payload,$emailTemplate,$resetPINUrl);\n ```\n\n \n\u003ch6 id=\"SendForgotPINEmailByUsername-post-\"\u003eForgot PIN By UserName (POST)\u003c/h6\u003e \n\nThis API sends the reset pin email using username.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/forgot-pin-by-username/)\n\n ```php\n\n $payload = '{\n\"userName\" : \"\u003cuserName\u003e\"\n}';  //Required \n$emailTemplate = \"emailTemplate\"; //Optional \n$resetPINUrl = \"resetPINUrl\"; //Optional\n \n$result = $pinAuthenticationAPI-\u003esendForgotPINEmailByUsername($payload,$emailTemplate,$resetPINUrl);\n ```\n\n \n\u003ch6 id=\"SendForgotPINSMSByPhone-post-\"\u003eForgot PIN By Phone (POST)\u003c/h6\u003e \n\nThis API sends the OTP to specified phone number\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/forgot-pin-by-phone/)\n\n ```php\n\n $payload = '{\n\"phone\" : \"\u003cphone\u003e\"\n}';  //Required \n$smsTemplate = \"smsTemplate\"; //Optional \n$isVoiceOtp = false; //Optional\n \n$result = $pinAuthenticationAPI-\u003esendForgotPINSMSByPhone($payload,$smsTemplate,$isVoiceOtp);\n ```\n\n \n\u003ch6 id=\"SetPINByPinAuthToken-post-\"\u003eSet PIN By PinAuthToken (POST)\u003c/h6\u003e \n\nThis API is used to change a user's PIN using Pin Auth token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/set-pin-by-pinauthtoken/)\n\n ```php\n\n $payload = '{\n\"pin\" : \"\u003cpin\u003e\"\n}';  //Required \n$pinAuthToken = \"pinAuthToken\"; //Required\n \n$result = $pinAuthenticationAPI-\u003esetPINByPinAuthToken($payload,$pinAuthToken);\n ```\n\n \n\u003ch6 id=\"InValidatePinSessionToken-get-\"\u003eInvalidate PIN Session Token (GET)\u003c/h6\u003e \n\nThis API is used to invalidate pin session token.\n [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/authentication/pin-authentication/invalidate-pin-session-token/)\n\n ```php\n \n$session_token = \"session_token\"; //Required\n \n$result = $pinAuthenticationAPI-\u003einValidatePinSessionToken($session_token);\n ```\n\n \n\n\n\n### ReAuthentication API\n\nList of APIs in this Section:\u003cbr\u003e\n[PUT : Validate MFA by OTP](#MFAReAuthenticateByOTP-put-)\u003cbr\u003e\n[PUT : Validate MFA by Backup Code](#MFAReAuthenticateByBackupCode-put-)\u003cbr\u003e\n[PUT : Validate MFA by Password](#MFAReAuthenticateByPassword-put-)\u003cbr\u003e\n[PUT : MFA Re-authentication by PIN](#VerifyPINAuthentication-put-)\u003cbr\u003e\n[PUT : MFA Re-authentication by Email OTP](#ReAuthValidateEmailOtp-put-)\u003cbr\u003e\n[PUT : MFA Step-Up Authentication by Authenticator Code](#MFAReAuthenticateByAuthenticatorCode-put-)\u003cbr\u003e\n[POST : Verify Multifactor OTP Authentication](#VerifyMultiFactorOtpReauthentication-post-)\u003cbr\u003e\n[POST : Verify Multifactor Password Authentication](#VerifyMultiFactorPasswo","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floginradius%2Fphp-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floginradius%2Fphp-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floginradius%2Fphp-sdk/lists"}