Registration by Email/Phone/Username via SOTT
Registers a new User using Email, Phone, or Username via a Secure One Time Token (SOTT).
Registers a new User using Email, Phone, or Username via a Secure One Time Token (SOTT).
apikey<token>
Tenant API Key for authentication
In: query
Query Parameters
emailtemplate?string
Name of the Email template to use for this notification.
sott?string
SOTT should be generated from the server side and passed here or in the X-LoginRadius-Sott header.
welcomeemailtemplate?string
Welcome Email Template
verificationurl?string
Verification URL for the User which will be included in the Email template..
smstemplate?string
SMS Template
prevent_webhook?boolean
When true, suppresses webhook events for this operation.
fields?string
Comma-separated list of profile fields to include in the response.
options?string
Options value will be passed when don't want to send the Email to the User for the verification, i.e. preventverificationemail
invitation_token?string
Invitation token of an organization
isvoiceotp?boolean
Boolean flag to enforce sending SMS content via Voice.
Header Parameters
X-PreventWebhook?boolean
When true, suppresses webhook events for this operation.
X-LoginRadius-Sott?string
SOTT should be generated from the server side and passed here or in sott query parameter.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.loginradius.com/identity/v2/auth/register?emailtemplate=Email-Template&sott=UIsmfxExgK9McHpzD%2BrGVaV7UtZkZiptaz5WVYqY9W9nzW1JJ2J%2FvYbeQZJPNMzOs1o1gLfd%2BAys87hyphDWsqFBzJv3wBNfNLVZJdAK%2FHE%3D*b8ca7b7afcca0254b8cfdce843dc6253&welcomeemailtemplate=Welcome-Email-Template&verificationurl=https%3A%2F%2Fexample.com%2Fverify%3Ftoken%3D123456&smstemplate=SMS-Template&prevent_webhook=true&fields=Email%2Cusername&options=preventverificationemail&invitation_token=f7e7e0c9-cd54-426f-97a7-5ebd846ddcc5&isvoiceotp=true" \ -H "X-PreventWebhook: true" \ -H "X-LoginRadius-Sott: UIsmfxExgK9McHpzD+rGVaV7UtZkZiptaz5WVYqY9W9nzW1JJ2J/vYbeQZJPNMzOs1o1gLfd+Ays87hyphDWsqFBzJv3wBNfNLVZJdAK/HE=*b8ca7b7afcca0254b8cfdce843dc6253" \ -H "Content-Type: application/json" \ -d '{}'{
"IsPosted": true,
"Data": {
"Profile": {
"IsPasswordBreached": false,
"IsActive": true,
"IsDeleted": false,
"EmailVerified": true,
"IsLoginLocked": false,
"IsRequiredFieldsFilledOnce": true,
"FirstLogin": false,
"IsProtected": false,
"Hireable": true,
"IsSecurePassword": true,
"IsCustomUid": false,
"PhoneIdVerified": true,
"IsEmailSubscribed": true,
"NoOfLogins": 42,
"FollowersCount": 150,
"FriendsCount": 89,
"TotalStatusesCount": 234,
"NumRecommenders": 12,
"TotalPrivateRepository": 5,
"PublicGists": 8,
"PrivateGists": 3,
"PinsCount": 25,
"BoardsCount": 6,
"LikesCount": 342,
"SessionLimit": 5,
"ID": "usr_12345",
"Password": "********",
"LoginLockedType": "None",
"Provider": "email",
"LastPasswordChangeToken": "tkn_abc123xyz",
"FullName": "John Michael Doe",
"FirstName": "John",
"LastName": "Doe",
"Uid": "u123456789",
"RegistrationProvider": "google",
"RegistrationSource": "web",
"LastLoginLocation": "New York, USA",
"ExternalUserLoginId": "ext_789xyz",
"PhoneId": "+1234567890",
"UserName": "johndoe",
"Prefix": "Mr",
"MiddleName": "Michael",
"Suffix": "Jr",
"NickName": "Johnny",
"ProfileName": "John.Doe",
"BirthDate": "1980-01-01",
"Gender": "male",
"Website": "https://johndoe.com",
"ThumbnailImageUrl": "https://example.com/thumb/profile.jpg",
"ImageUrl": "https://example.com/profile.jpg",
"Favicon": "https://example.com/favicon.ico",
"ProfileUrl": "https://example.com/johndoe",
"HomeTown": "Boston",
"State": "Massachusetts",
"City": "Boston",
"Industry": "Technology",
"About": "Software developer passionate about creating great User experiences",
"TimeZone": "America/New_York",
"LocalLanguage": "en-US",
"CoverPhoto": "https://example.com/cover.jpg",
"TagLine": "Building the future of tech",
"Language": "English",
"Verified": "true",
"UpdatedTime": "2024-03-20T15:30:00Z",
"IsGeoEnabled": "true",
"Associations": "IEEE, ACM",
"Honors": "Best Developer Award 2023",
"HttpsImageUrl": "https://example.com/secure/profile.jpg",
"MainAddress": "123 Tech Street",
"Created": "2023-01-01T10:00:00Z",
"LocalCity": "Boston",
"ProfileCity": "Boston",
"LocalCountry": "United States",
"ProfileCountry": "United States",
"RelationshipStatus": "Single",
"Quota": "1000",
"Quote": "Code is poetry",
"Religion": "Prefer not to say",
"Political": "Independent",
"PublicRepository": "15",
"RepositoryUrl": "https://github.com/johndoe",
"Age": "35",
"ProfessionalHeadline": "Senior Software Engineer",
"LRUserID": "lr_123456",
"Currency": "USD",
"StarredUrl": "https://github.com/johndoe?tab=stars",
"GistsUrl": "https://gist.github.com/johndoe",
"Company": "Tech Corp Inc.",
"GravatarImageUrl": "https://gravatar.com/avatar/123",
"LastPasswordChangeDate": "2024-02-15T14:30:00Z",
"PasswordExpirationDate": "2024-05-15T14:30:00Z",
"CreatedDate": "2023-01-01T10:00:00Z",
"ModifiedDate": "2024-03-20T15:30:00Z",
"ProfileModifiedDate": "2024-03-15T12:30:00Z",
"LastLoginDate": "2024-03-20T09:30:00Z",
"SignupDate": "2023-01-01T10:00:00Z",
"PrivacyPolicy": {
"Version": "2.0",
"AcceptSource": "web",
"AcceptDateTime": "2023-01-01T10:00:00Z"
},
"Country": {
"Name": "United States",
"Code": "US"
},
"AgeRange": {
"Min": 25,
"Max": 34
},
"KloutScore": {
"KloutId": "klout_123",
"Score": 63
},
"Suggestions": {
"CompaniesToFollow": [
{
"Id": "comp_123",
"Name": "Tech Corp"
}
],
"IndustriesToFollow": [
{
"Id": "ind_123",
"Name": "Software Development"
}
],
"NewssourceToFollow": [
{
"Id": "news_123",
"Name": "Tech Daily"
}
],
"PeopleToFollow": [
{
"Id": "usr_789",
"Name": "Jane Smith"
}
]
},
"Subscription": {
"Name": "Pro Plan",
"Space": "50GB",
"PrivateRepos": "10",
"Collaborators": "5"
},
"PIN": {
"Skipped": false,
"LastPINChangeToken": "pin_token_123",
"LastPINChangeDate": "2024-02-01T12:00:00Z",
"SkippedDate": "2024-01-01T10:00:00Z",
"PINHashingConfig": "sha256",
"PIN": "****",
"IsPINSet": true
},
"ConsentProfile": {
"Consents": [
{
"ConsentOptionId": "123e4567e89b12d3a456426614174000",
"AcceptedOn": "2024-03-20T15:30:00Z"
}
],
"AcceptedConsentVersions": [
{
"IsCustom": false,
"Event": "signup",
"Version": "1.0"
}
]
},
"RegistrationData": {
"Data": [
{
"DataSource": "web_form",
"Value": {
"Id": "reg_123"
}
}
]
},
"ProviderAccessCredential": {
"AccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"TokenSecret": "secret_token_xyz"
},
"CustomFields": {
"property1": "custom_value",
"property2": "custom_value"
},
"ProfileImageUrls": {
"property1": "https://example.com/images/profile_small.jpg",
"property2": "https://example.com/images/profile_small.jpg"
},
"WebProfiles": {
"property1": "https://linkedin.com/in/johndoe",
"property2": "https://linkedin.com/in/johndoe"
},
"Roles": [
"admin",
"user"
],
"PreviousUids": [
"old_UID_123",
"old_UID_456"
],
"InterestedIn": [
"technology",
"sports"
],
"ExternalIds": [
{
"Operation": "link",
"Source": "github",
"SourceId": "gh_123456"
}
],
"UnverifiedEmail": [
{
"Type": "work",
"Value": "john.doe@company.com"
}
],
"Positions": [
{
"Position": "Senior Software Engineer",
"Summary": "Leading backend development team",
"StartDate": "2022-01-01T00:00:00Z",
"EndDate": "2024-03-20T00:00:00Z",
"IsCurrent": true,
"Company": {
"Name": "Tech Corp Inc.",
"Type": "Public Company",
"Industry": "Information Technology"
}
}
],
"Educations": [
{
"School": "MIT",
"Year": "2020",
"Type": "University",
"Notes": "Dean's List",
"Activities": "Robotics Club, Coding Competition",
"Degree": "Master of Science",
"FieldOfStudy": "Computer Science",
"StartDate": "2018-09-01T00:00:00Z",
"EndDate": "2020-05-30T00:00:00Z"
}
],
"PhoneNumbers": [
{
"PhoneType": "mobile",
"PhoneNumber": "+1-555-123-4567",
"op": "add"
}
],
"IMAccounts": [
{
"AccountType": "skype",
"AccountName": "john.doe.123"
}
],
"Addresses": [
{
"Type": "home",
"AddressType": "primary",
"Address1": "123 Tech Street",
"Address2": "Apt 4B",
"City": "San Francisco",
"State": "CA",
"PostalCode": "94105",
"Region": "Bay Area",
"Op": "add",
"Country": "United States"
}
],
"Interests": [
{
"InterestType": "professional",
"InterestName": "Artificial Intelligence"
}
],
"Sports": [
{
"Id": "sport_123",
"Name": "Basketball"
}
],
"InspirationalPeople": [
{
"Name": "Ada Lovelace",
"Id": "insp_123"
}
],
"Awards": [
{
"Id": "award_123",
"Name": "Innovation Award",
"Issuer": "Tech Association"
}
],
"Skills": [
{
"Id": "skill_123",
"Name": "Python Programming"
}
],
"CurrentStatus": [
{
"Id": "status_123",
"Text": "Working on exciting AI project",
"Source": "linkedin",
"CreatedDate": "2024-03-20T15:30:00Z"
}
],
"Certifications": [
{
"Id": "cert_123",
"Name": "AWS Certified Solutions Architect",
"Authority": "Amazon Web Services",
"Number": "CERT-123-45678",
"StartDate": "2023-01-01T00:00:00Z",
"EndDate": "2026-01-01T00:00:00Z"
}
],
"Courses": [
{
"Id": "course_123",
"Name": "Advanced Machine Learning",
"Number": "CS-401"
}
],
"Volunteer": [
{
"Organization": "Code for Good",
"Role": "Technical Mentor",
"Cause": "Education",
"Id": "vol_123"
}
],
"RecommendationsReceived": [
{
"Id": "rec_123",
"Recommender": "Jane Smith",
"RecommendationText": "Excellent team player and technical leader",
"RecommendationType": "professional"
}
],
"Languages": [
{
"Id": "lang_123",
"Name": "Spanish",
"Proficiency": "fluent",
"op": "add"
}
],
"Projects": [
{
"Id": "proj_123",
"Name": "AI-Powered Analytics Platform",
"Summary": "Led development of machine learning pipeline",
"StartDate": "2023-06-01T00:00:00Z",
"EndDate": "2024-02-28T00:00:00Z",
"IsCurrent": "false",
"With": [
{
"Id": "user_789",
"Name": "Sarah Johnson"
}
]
}
],
"Games": [
{
"Id": "game_123",
"Category": "Strategy",
"Name": "Chess",
"CreatedDate": "2024-01-15T10:30:00Z"
}
],
"Family": [
{
"Id": "fam_123",
"Name": "Jane Doe",
"Relationship": "Spouse"
}
],
"TelevisionShow": [
{
"Id": "show_123",
"Category": "Science Fiction",
"Name": "Black Mirror",
"CreatedDate": "2024-02-01T12:00:00Z"
}
],
"MutualFriends": [
{
"Id": "friend_123",
"Name": "Alice Smith",
"FirstName": "Alice",
"LastName": "Smith",
"Birthday": "1985-03-15T00:00:00Z",
"Hometown": "Chicago",
"Link": "https://example.com/alice.smith",
"Gender": "female"
}
],
"Movies": [
{
"MovieName": "The Matrix",
"Genre": "Science Fiction"
}
],
"Books": [
{
"Id": "book_123",
"Category": "Non-fiction",
"Name": "Clean Code",
"CreatedDate": "2024-01-01"
}
],
"Patents": [
{
"Id": "pat_123",
"Title": "AI-Based Data Processing System",
"Date": "2023-06-15"
}
],
"FavoriteThings": [
{
"Id": "fav_123",
"Name": "Photography",
"Type": "Hobby"
}
],
"RelatedProfileViews": [
{
"FirstName": "Robert",
"LastName": "Johnson",
"Id": "view_123"
}
],
"PlacesLived": [
{
"Name": "Seattle, WA",
"Operation": "add",
"IsPrimary": true
}
],
"Publications": [
{
"Title": "Modern Software Architecture",
"Publisher": "Tech Publishing House",
"Date": "2023-08-15T00:00:00Z",
"Id": "pub_123",
"Url": "https://example.com/publication/123",
"Summary": "A comprehensive guide to modern software architecture patterns",
"Authors": [
{
"Id": "auth_123",
"Name": "John Doe"
}
]
}
],
"JobBookmarks": [
{
"IsApplied": true,
"IsSaved": true,
"ApplyTimestamp": "2024-02-15T14:30:00Z",
"SavedTimestamp": "2024-02-10T09:15:00Z",
"Job": {
"Active": true,
"Id": "job_123",
"DescriptionSnippet": "Senior Software Engineer position",
"PostingTimestamp": "2024-02-01T00:00:00Z",
"Compony": {
"Id": "comp_123",
"Name": "Tech Corp Inc."
},
"Position": {
"Title": "Senior Software Engineer"
}
}
}
],
"Badges": [
{
"BadgeId": "badge_123",
"BageId": "badge_123",
"Name": "Top Contributor",
"BadgeMessage": "Awarded for exceptional contributions",
"BageMessage": "Awarded for exceptional contributions",
"Description": "Recognition for outstanding community support",
"ImageUrl": "https://example.com/badges/top-contributor.png"
}
],
"MemberUrlResources": [
{
"UrlName": "Portfolio",
"Url": "https://johndoe.com"
}
],
"Organizations": [
{
"Id": "org_123",
"Name": "Acme Corp",
"LogoURL": "https://cdn.example.com/orgs/acme/logo.png"
}
],
"Email": [
{
"Type": "work",
"Value": "john.doe@company.com"
}
],
"PasskeyLogin": {
"ProgressiveFlag": true,
"LocalEnrollmentFlag": false,
"ProgressiveEnrollmentDate": "2024-03-01T12:00:00Z"
}
},
"access_token": "684920ba-917b-4168-b59b-eae70b430209",
"refresh_token": "684920ba-917b-4168-b59b-eae70b430209",
"expires_in": "3600"
}
}{
"ErrorCode": 908,
"Message": "A parameter is not formatted correctly",
"Description": "The apikey is a required parameter."
}{
"ErrorCode": 901,
"Message": "The API key is unauthorized",
"Description": "The provided LoginRadius API key is invalid or is not authorized, please use a valid or authorized LoginRadius API key or check the API key for your LoginRadius account."
}{
"ErrorCode": 8169,
"Message": "Invitation not found",
"Description": "Invitation not found, Please provide valid invitation id."
}{
"Message": "Operation failed due to an internal error.",
"Description": "An unknown internal error occurred, please try again in a few minutes or contact your system administrator.",
"ErrorCode": 7909
}Authorization
Authorization guidance for Authentication API flows, including API key, client ID, bearer-token use, and mixed public versus authenticated endpoint patterns.
Registration by Email/Phone/Username via Captcha POST
Registers a new User using Email, Phone, or Username with Captcha verification.