The following documentation is applicable to Free, Developer, and Developer Premium plans. For documentation related to the enterprise plan, please click here.

Account API

Refer this document to get API Key and Secret.

Account Create

Creates a new consumer. This will bypass the normal email verification process.

Note: All mandatory fields must be included when creating a new consumer.

Endpoint

POST https://api.loginradius.com/identity/v2/manage/account

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]

Body Attributes

AttributeDescription
Emailuser’s email id with it’s type. Sample - [{“Type”: “Primary”, “Value”: “test@test.com”}]
FirstNameuser’s first name
LastNameuser’s last name
PasswordPassword for the emailModel Class containing Definition of payload for Account Create API [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Forgot Password Token

Generates a Forgot Password token for the specified Email ID. This can optionally send a Forgot Password email to the consumer.

Endpoint

POST https://api.loginradius.com/identity/v2/manage/account/forgot/token

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
EmailTemplatenoneEmail template name [Optional]
ResetPasswordUrlnoneUrl to which user should get re-directed to for resetting the password [Optional]
SendEmailnoneIf set to true, the API will also send a Forgot Password email to the customer, bypassing any Bot Protection challenges that they are faced with. [Optional]

Try Me Out

Enter query parameters and send a request to view the sample response.

Email Verification Token

Generates an Email Verification token for the specified Email ID.

Endpoint

POST https://api.loginradius.com/identity/v2/manage/account/verify/token

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Account Profile by Email

Retrieves consumer profile data corresponding to the specified Email ID.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/account

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
EmailnoneEmail of the user [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]

Try Me Out

Enter query parameters and send a request to view the sample response.

Account Profile by Phone ID

Retrieves consumer profile data corresponding to the specified Phone ID.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/account

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
PhonenoneThe Registered Phone Number [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]

Try Me Out

Enter query parameters and send a request to view the sample response.

Account Profile by UID

Retrieves consumer profile data corresponding to the specified UID.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/account/{uid}

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]

Try Me Out

Enter query parameters and send a request to view the sample response.

Account Password

Retrieves hashed password for the consumer corresponding to the specified UID.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/account/{uid}/password

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Access Token by UID

Gets a LoginRadius access token corresponding to the specified UID.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/account/access_token

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
UidnoneUID, the unified identifier for each user account [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Account Identities by Email

Retrieves all consumer identities corresponding to the specified Email.

Note: This is intended for specific workflows where an email may correspond with multiple UIDs.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/account/identities

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
EmailnoneEmail of the user [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]

Try Me Out

Enter query parameters and send a request to view the sample response.

Account Update

Updates profile information of the consumer profile corresponding to the specified UID.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/account/{uid}

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
NullSupportnoneBoolean, pass true if you wish to update any user profile field with a NULL value, You can get the details [Optional]

Body Attributes

AttributeDescription
FirstNameuser’s first name
LastNameuser’s last nameModel Class containing Definition of payload for Account Update API [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Update Phone ID by UID

Updates Phone ID for the consumer corresponding to the specified UID. You can update the Phone ID for both verified and unverified consumers. This will directly replace their Phone ID, bypassing the OTP verification process.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/account/{uid}/PhoneId

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]

Try Me Out

Enter query parameters and send a request to view the sample response.

Account Set Password

Sets password for the consumer corresponding to the specified UID.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/account/{uid}/password

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Account Invalidate Verification Email

Invalidates Email ID verification status for the consumer corresponding to the specified UID.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/account/{uid}/invalidateEmail

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
EmailTemplatenoneEmail template name [Optional]
VerificationUrlnoneEmail verification url [Optional]

Try Me Out

Enter query parameters and send a request to view the sample response.

Reset Phone ID Verification

Resets Phone ID verification for the consumer corresponding to the specified UID.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/account/{uid}/invalidatePhone

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
SmsTemplatenoneSMS Template name [Optional]

Try Me Out

Enter query parameters and send a request to view the sample response.

Upsert Email

Adds/Upserts emails for the consumer corresponding to the specified UID by email type. If the email type specified already exists, the existing email value will be updated. Otherwise, a new email record will be added into the account’s email array.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/account/{uid}/email

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]

Body Attributes

AttributeDescription
Emailuser’s email id with it’s typeSample - [{“Type”: “Primary”, “Value”: “test@test.com”}] [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Update UID

Updates consumer’s UID.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/account/uid

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Key [Required]
uidnoneUID, the unified identifier for each user account [Required]

Body Attributes

AttributeDescription
NewUidNew UidPayload containing Update UID [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Account Delete

Deletes consumer corresponding to the specified UID from your app. They will be able to re-register for a new account.

Endpoint

DELETE https://api.loginradius.com/identity/v2/manage/account/{uid}

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Account Remove Email

Removes given email from the consumer corresponding to the specified UID.

Endpoint

DELETE https://api.loginradius.com/identity/v2/manage/account/{uid}/email

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]

Try Me Out

Enter query parameters and send a request to view the sample response.

Delete User Profile by Email

Deletes consumer corresponding to the specified Email.

Endpoint

DELETE https://api.loginradius.com/identity/v2/manage/account

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
EmailnoneEmail of the user [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Go Back to Home Page


Was this article helpful?

Have more questions? Submit a request