User
Manage user-related functionalities, including social login, password management, account actions, authentication, OTP handling, profile updates, customer management, session management, platform configuration, user group management, and user attribute definition.
Customer Account
Provides functionalities related to customer accounts, including customer deletion through OTP verification sent to email or mobile, allowing users to provide reasons for deletion as configured within the platform, logout from user active session, retrieval of logged-in users, and active session management.
Operations
GET
# Get Logged in User
GET
# Get List OF Active Sessions
GET
# Get Platform Configuration
GET
# Chcek User Existence
POST
# Verify OTP and Delete User
GET
# Logout Current User
GET
Get Logged in User
Retrieve information about the currently logged-in user.
Parameters
No Parameters
Response
200
401
Success. Returns a JSON object with user details. Refer `UserObjectSchema` for more details.
UserObjectSchema
user
object (UserSchema)
UserSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get Logged in User
getLoggedInUser
GET
Get List OF Active Sessions
Retrieve all active sessions of a user.
Parameters
No Parameters
Response
200
401
Success. Returns a JSON object containing an array of sessions. Refer `SessionListSuccess` for more details.
SessionListSuccess
sessions
array of string
An array of active session identifiers.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get List OF Active Sessions
getListOfActiveSessions
GET
Get Platform Configuration
Retrieve platform sales channel authentication configuration.
Parameters
name
string
Name of the application, e.g. Fynd.
Response
200
Success. Returns a JSON object containing the all the platform configurations. Refer `PlatformSchema` for more details.
PlatformSchema
display
string
The display name of the platform.
look_and_feel
object (LookAndFeel)
LookAndFeel
updated_at
string
The date and time when the configuration was last updated.
active
boolean
Is the application config active or not .
forgot_password
boolean
Forgot password option to be given or not to application user.
login
object (Login)
Login
skip_captcha
boolean
Skip the captcha or not .
name
string
Name of the application.
meta
object (MetaSchema)
MetaSchema
_id
string
Unique document id of the platform config.
social
object (Social)
Social
required_fields
object (RequiredFields)
RequiredFields
register_required_fields
object (RegisterRequiredFields)
RegisterRequiredFields
skip_login
boolean
Whether to skip the login or not .
flash_card
object (FlashCard)
FlashCard
subtext
string
Text to be shown at the top of the flash card like login to fynd, login to tira.
social_tokens
object (SocialTokens)
SocialTokens
created_at
string
When was the application platform config document was created.
register
boolean
Whether to show the registration page on landing page or not.
mobile_image
string
Image to be shown on registration page for mobile devices.
desktop_image
string
Image to be shown on registration page for desktop devices.
delete_account_day
integer
Number of days after which the user account will be deleted.
delete_account_reasons
array of object (DeleteAccountReasons)
List of reasons you can set to ask user when account is being deleted from application.
Array of DeleteAccountReasons
delete_account_consent
object (DeleteAccountConsent)
DeleteAccountConsent
session_config
object (SessionExpiry)
SessionExpiry
__v
integer
Version of the document.
Examples
Parameters
name:
"5eda528b97457fe43a733ace"
Was this section helpful?
GET
Loading...
Response
Loading...
Get Platform Configuration
getPlatformConfig
GET
Chcek User Existence
Check whether user is already registered or not to the sales channel.
Parameters
q
string
Required
Email id or phone number of user.
Response
200
400
Returns true or false based on user is registered or not.
UserExistsResponse
user_exists
boolean
Boolean which specifies if user is registered or not.
Examples
Parameters
q:
Was this section helpful?
GET
Loading...
Response
Example response not available.
Chcek User Existence
userExists
POST
Verify OTP and Delete User
Verify OTP sent to mobile/email and delete the user's account.
Parameters
body
object (DeleteApplicationUserRequestSchema)
Required
Request body must contain user_id. Refer `DeleteApplicationUserRequestSchema` for more details.
DeleteApplicationUserRequestSchema
user_id
string
User id for the application user.
reason
string
Reason to delete the application user.
reason_id
string
Reason id of request to delete the application user .
request_id
string
ID of request to delete the application user .
otp
string
OTP to verify the delete application user request.
Response
200
400
Success. Returns a success message. Refer `DeleteUserSuccess` for more details.
DeleteUserSuccess
success
boolean
Whether the user deletion operation was successful.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Verify OTP and Delete User
deleteUser
GET
Logout Current User
Logout currently logged-in user.
Parameters
No Parameters
Response
200
401
Success. Returns a success message as shown below. Refer `LogoutSuccess` for more details.
LogoutSuccess
logout
boolean
Whether the logout operation was successful.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Logout Current User
logout
Customer Attributes
Customer attributes enable the tagging of custom values against any customer. This allows the tagging of customer behavior with unique values, which can later be used to categorize customers into specific groups. Before adding any values to customers, definitions for customer attributes must be present. Attributes support multiple data types for defining new attributes for customers.
Operations
GET
# Get User Attributes
PATCH
# Update User Attributes
GET
Get User Attributes
Get the list of user attributes.
Parameters
slug
string
Filter by attribute slug.
Response
200
400
Returns a list of users attributes
UserAttributes
attributes
object
Describes the structure of user attribute.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Example response not available.
Get User Attributes
getUserAttributes
PATCH
Update User Attributes
Update user attributes.
Parameters
body
object (UpdateUserAttributesRequest)
Required
list of user attributes to be updated
UpdateUserAttributesRequest
attributes
object
Describes the request structure to update the user attribute.
Response
200
400
Returns a list of users attributes
UserAttributes
attributes
object
Describes the structure of user attribute.
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
Loading...
Response
Example response not available.
Update User Attributes
updateUserAttributes
Customer Password
Manages customer passwords and provides functionality for resetting forgotten passwords, while also verifying password existence. Customers can conveniently reset their passwords by receiving one-time passwords (OTPs) via both email and phone numbers. sellers can adjust password configurations within the platform, including options such as increasing password length and adding special characters, numbers, and uppercase letters. Additionally, they can configure password history settings to prevent reuse of previous passwords.
Operations
POST
# Reset Password via Email
POST
# Reset Password via Mobile
POST
# Validate Password Reset Code
POST
# Reset Password via Code and login
POST
# Reset Password via Code
GET
# Check Password Existence
POST
# Update Password
POST
Reset Password via Email
Send a password reset link to the user's email.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (SendResetPasswordEmailRequestSchema)
Required
Request body must contain Email ID and the Captcha. Refer `SendResetPasswordEmailRequestSchema` for more details.
SendResetPasswordEmailRequestSchema
email
string
Email id of user.
Response
200
400
Success. Check the example shown below or refer `ResetPasswordSuccess` for more details.
ResetPasswordSuccess
status
string
Status of the password reset operation.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Reset Password via Email
sendResetPasswordEmail
POST
Reset Password via Mobile
Send a password reset link to the user's mobile.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (SendResetPasswordMobileRequestSchema)
Required
Request body must contain mobile, country_code and the Captcha. Refer `SendResetPasswordMobileRequestSchema` for more details.
SendResetPasswordMobileRequestSchema
country_code
string
Country code for the phone number.
mobile
string
Phone number of user.
Response
400
Bad request. See the error object in the response body for specific reason
APIError
code
string
The error code representing the type of error.
message
string
A descriptive message providing more details about the error.
info
string
A link to the error code description.
request_id
string
A random uuid string used to track the api request.
error
string
The error message or stack trace.
meta
object
Additional metadata associated with the error.
authenticated
boolean
Whether the user is authenticated.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Reset Password via Mobile
sendResetPasswordMobile
POST
Validate Password Reset Code
Validate password reset link code.
Parameters
body
object (CodeRequestBodySchema)
Required
Request body must contain the code sent on Email/SMS. Refer `CodeRequestBodySchema` for more details.
CodeRequestBodySchema
code
string
Unique code to verify request.
Response
200
400
Success. Check the example shown below or refer `ResetPasswordSuccess` for more details.
ResetPasswordSuccess
status
string
Status of the password reset operation.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Validate Password Reset Code
sendResetToken
POST
Reset Password via Code and login
Reset a password using the code sent on email or sms the login.
Parameters
body
object (ForgotPasswordRequestSchema)
Required
Request body must contain Captcha and the code sent on Email/SMS. Refer `ForgotPasswordRequestSchema` for more details.
ForgotPasswordRequestSchema
code
string
Unique code to verify request.
password
string
Password of user.
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
A random uuid string used to track the send OTP response.
register_token
string
A token used for registration purposes.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Reset Password via Code and login
forgotPassword
POST
Reset Password via Code
Reset a password using the code sent on email or sms.
Parameters
body
object (ForgotPasswordRequestSchema)
Required
ForgotPasswordRequestSchema
code
string
Unique code to verify request.
password
string
Password of user.
Response
200
400
Success. Check the example shown below or refer `ResetForgotPasswordSuccess` for more details.
ResetForgotPasswordSuccess
success
boolean
Whether the password reset operation was successful.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Reset Password via Code
resetForgotPassword
GET
Check Password Existence
Check if user has set an account password.
Parameters
No Parameters
Response
200
401
Success. Returns a boolean value. Check the example shown below or refer `HasPasswordSuccess` for more details.
HasPasswordSuccess
result
integer
An integer value indicating whether the user has set a password (1 for true, 0 for false).
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Check Password Existence
hasPassword
POST
Update Password
Allow user to change their password.
Parameters
body
object (UpdatePasswordRequestSchema)
Required
Request body must contain old and new password. Refer `UpdatePasswordRequestSchema` for more details.
UpdatePasswordRequestSchema
old_password
string
Old password.
new_password
string
New password.
Response
200
400
Success. Returns a success message. Refer `VerifyEmailSuccess` for more details.
VerifyEmailSuccess
message
string
Result of the email verification process.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update Password
updatePassword
Customer Profile
Enable customers to manage their profile efficiently by providing actions such as updating personal details such as first name, last name, gender, and date of birth. Enable users to add and verify mobile/email contacts with OTP verification, as well as delete secondary contacts. Additionally, provide the functionality to designate a primary contacts.
Operations
POST
# Verify Email with Code
POST
# Verify Mobile with Code
POST
# Edit User Profile Details
PUT
# Add Mobile Number to Profile
DEL
# Delete Mobile Number From Profile
POST
# Set Mobile as Primary
POST
# Send Verification Link to Mobile
PUT
# Add Email to Profile
DEL
# Delete Email From Profile
POST
# Set Email as Primary
POST
# Send Verification Link to Email
POST
Verify Email with Code
Verify user email with a code sent within a link sent to their email.
Parameters
body
object (CodeRequestBodySchema)
Required
Request body must contain the code sent on Email. Refer `CodeRequestBodySchema` for more details.
CodeRequestBodySchema
code
string
Unique code to verify request.
Response
200
400
Success. Check the example shown below or refer `VerifyEmailSuccess` for more details.
VerifyEmailSuccess
message
string
Result of the email verification process.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Verify Email with Code
verifyEmail
POST
Verify Mobile with Code
Verify user mobile with a code sent within a link sent to their mobile.
Parameters
body
object (CodeRequestBodySchema)
Required
Request body must contain the code sent on Email. Refer `CodeRequestBodySchema` for more details.
CodeRequestBodySchema
code
string
Unique code to verify request.
Response
200
400
Success. Check the example shown below or refer `VerifyEmailSuccess` for more details.
VerifyEmailSuccess
message
string
Result of the email verification process.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Verify Mobile with Code
verifyMobile
POST
Edit User Profile Details
Allow users to modify and update their profile details.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (EditProfileRequestSchema)
Required
Request body must contain user details such as name, last name, contact details and password. Check the example of a request body shown below or refer `EditProfileRequestSchema` for more details.
EditProfileRequestSchema
encrypt_otp
boolean
Set to true if you want to encrypt the OTP.
first_name
string
First name of the application user.
last_name
string
Last name of the application user.
mobile
object (EditProfileMobileSchema)
EditProfileMobileSchema
country_code
string
Country code for the phone number.
email
string
Email id of user.
gender
string
Gender of user.
dob
string
Date of birth of user.
profile_pic_url
string
Profile picture of user.
android_hash
string
Unique hash value.
sender
string
Identity of the sender.
register_token
string
Unique temporary registration of the user.
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
ProfileEditSuccess
user
object (UserSchema)
UserSchema
register_token
string
Unique registration token for user.
resend_email_token
string
Unique token to identify the request for OTP verification in case of unverified email.
user_exists
boolean
If user is registered or not.
verify_email_link
boolean
Whether to send a link to verify the registered email id of the user.
verify_email_otp
boolean
Whether to send a OTP to verify the registered email id of the user.
verify_mobile_otp
boolean
Whether to send a OTP to verify the registered phone of the user.
email
string
Email id of user.
request_id
string
A random uuid string used to track the request.
country_code
string
The country specific prefix for the phone number.
mobile
string
The user's mobile number without the country code.
success
boolean
Whether the operation was successful.
message
string
Information about the operation's result.
resend_timer
integer
Time in seconds before an request can be resent.
resend_token
string
A token used to authorize the resending of request.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Edit User Profile Details
updateProfile
PUT
Add Mobile Number to Profile
Add a new mobile number to the user's profile.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (EditMobileRequestSchema)
Required
Request body must contain mobile no and country code. Refer `EditMobileRequestSchema` for more details.
EditMobileRequestSchema
country_code
string
Country code for the phone number.
phone
string
Phone number of user.
Response
200
400
Success. Check the example shown below or refer `VerifyMobileOTPSuccess` for more details.
VerifyMobileOTPSuccess
user
object (UserSchema)
UserSchema
verify_mobile_link
boolean
Whether the mobile number verification link was successful.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Add Mobile Number to Profile
addMobileNumber
DEL
Delete Mobile Number From Profile
Delete mobile number from profile.
Parameters
platform
string
ID of the application.
Default Value : Fynd
active
boolean
Required
This is a boolean value to check if mobile number is active 1.True - number is active 2. False - number is inactive.
primary
boolean
Required
This is a boolean value to check if mobile number is primary number (main number) 1. True - number is primary 2. False - number is not primary.
verified
boolean
Required
This is a boolean value to check if mobile number is verified 1. True - number is verified 2.False - number is not verified yet.
countryCode
string
Required
Country code of the phone number, e.g. 91.
phone
string
Required
Phone number.
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
A random uuid string used to track the send OTP response.
register_token
string
A token used for registration purposes.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
active:
true
primary:
true
verified:
true
countryCode:
"91"
phone:
"9987568530"
Was this section helpful?
DEL
Loading...
Response
Example response not available.
Delete Mobile Number From Profile
deleteMobileNumber
POST
Set Mobile as Primary
Set a mobile number as the primary contact for the user.
Parameters
body
object (SendVerificationLinkMobileRequestSchema)
Required
Check the example shown below or refer `SendVerificationLinkMobileRequestSchema` for more details.
SendVerificationLinkMobileRequestSchema
verified
boolean
Boolean to specify if the phone number is verified or not.
active
boolean
Boolean to specify if the phone number is active or not.
country_code
string
Country code for the phone number.
phone
string
Phone number.
primary
boolean
Boolean to specify if the phone number is primary or not.
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
A random uuid string used to track the send OTP response.
register_token
string
A token used for registration purposes.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Set Mobile as Primary
setMobileNumberAsPrimary
POST
Send Verification Link to Mobile
Send a verification link to a newly added mobile number.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (SendVerificationLinkMobileRequestSchema)
Required
Check the example shown below or refer `SendVerificationLinkMobileRequestSchema` for more details.
SendVerificationLinkMobileRequestSchema
verified
boolean
Boolean to specify if the phone number is verified or not.
active
boolean
Boolean to specify if the phone number is active or not.
country_code
string
Country code for the phone number.
phone
string
Phone number.
primary
boolean
Boolean to specify if the phone number is primary or not.
Response
200
400
Success. Check the example shown below or refer `SendMobileVerifyLinkSuccess` for more details.
SendMobileVerifyLinkSuccess
verify_mobile_link
boolean
Whether the mobile verification link was successfully sent.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Send Verification Link to Mobile
sendVerificationLinkToMobile
PUT
Add Email to Profile
Add a new email address to the user's profile.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (EditEmailRequestSchema)
Required
Check the example shown below or refer `EditEmailRequestSchema` for more details.
EditEmailRequestSchema
email
string
Email of the user.
Response
200
400
Success. Returns a JSON object with user details. Refer `VerifyEmailOTPSuccess` for more details.
VerifyEmailOTPSuccess
user
object (UserSchema)
UserSchema
verify_email_link
boolean
Whether the email verification link was successful.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
PUT
Loading...
Response
Example response not available.
Add Email to Profile
addEmail
DEL
Delete Email From Profile
Delete email from profile.
Parameters
platform
string
ID of the application.
Default Value : Fynd
active
boolean
Required
Boolean value to check if email id is active 1. True - email id is active 2.False - email id is inactive.
primary
boolean
Required
Boolean value to check if email id is primary (main email id) 1. True - email id is primary 2.False - email id is not primary.
verified
boolean
Required
Boolean value to check if email id is verified 1. True - email id is verified 2.False - email id is not verified yet.
email
string
Required
The email id to delete.
Response
200
400
Success. Returns a JSON object with user details. Refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
A random uuid string used to track the send OTP response.
register_token
string
A token used for registration purposes.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
active:
true
primary:
true
verified:
true
email:
Was this section helpful?
DEL
Loading...
Response
Example response not available.
Delete Email From Profile
deleteEmail
POST
Set Email as Primary
Set an email address as the primary contact for the user.
Parameters
body
object (EditEmailRequestSchema)
Required
Request body must contain an email ID. Refer `EditEmailRequestSchema` for more details.
EditEmailRequestSchema
email
string
Email of the user.
Response
200
400
Success. Returns a JSON object with user details. Refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
A random uuid string used to track the send OTP response.
register_token
string
A token used for registration purposes.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Set Email as Primary
setEmailAsPrimary
POST
Send Verification Link to Email
Send a verification link to a newly added email address.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (EditEmailRequestSchema)
Required
Request body must contain an email ID. Refer `EditEmailRequestSchema` for more details.
EditEmailRequestSchema
email
string
Email of the user.
Response
200
400
Request body must contain an email ID. Refer `EditEmailRequestSchema` for more details.
SendEmailVerifyLinkSuccess
verify_email_link
boolean
Whether the email verification link was successfully sent.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Send Verification Link to Email
sendVerificationLinkToEmail
Login and Registration
Enable seamless customer authentication and registration through a registration form. Users can choose from various authentication methods including login with OTP for enhanced security, login with tokens, and login with email and password.
Operations
POST
# Login with Mobile OTP
POST
# Email and Password Login
POST
# Login with Token
POST
# Register User with Form
POST
Login with Mobile OTP
Allow users to log in using a one-time password sent to their mobile.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (SendOtpRequestSchema)
Required
Check the example of an OTP request body shown below or refer `SendOtpRequestSchema` for more details.
SendOtpRequestSchema
encrypt_otp
boolean
Eet to true if you want to encrypt the OTP.
country_code
string
Country code for the phone number.
mobile
string
Phone number.
android_hash
string
Unique hash value.
Response
200
400
Success. Check the example shown below or refer `SendOtpResponse` for more details.
SendOtpResponse
resend_timer
integer
Time after which opt can be resent.
resend_token
string
Unique token to identify the OTP send request and resend the token.
success
boolean
Specify if the OTP is successfully sent.
request_id
string
Unique request id for the OTP.
message
string
Message to specify the OTP send status. Eg. OTP sent, failed to send OTP etc.
mobile
string
Phone number of user.
country_code
string
Country code for the phone number.
email
string
Email id of user.
resend_email_token
string
Unique token to identify the OTP send request and resend the token on email.
register_token
string
Unique registration token for user.
verify_email_otp
boolean
If email OTP verification is mandatory for registration.
verify_mobile_otp
boolean
If mobile OTP verification is mandatory for registration.
user_exists
boolean
If user is registered or not.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Login with Mobile OTP
loginWithOTP
POST
Email and Password Login
Allow login using an email and password combination.
Parameters
body
object (PasswordLoginRequestSchema)
Required
Request body must contain Email ID, Password and the Captcha. Refer `PasswordLoginRequestSchema` for more details.
PasswordLoginRequestSchema
password
string
Password of user.
username
string
Username of user.
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
A random uuid string used to track the send OTP response.
register_token
string
A token used for registration purposes.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Email and Password Login
loginWithEmailAndPassword
POST
Login with Token
Login user using a token for authentication.
Parameters
body
object (TokenRequestBodySchema)
Required
Request body must contain authentication token. Refer `TokenRequestBodySchema` for more details.
TokenRequestBodySchema
token
string
Unique token.
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
A random uuid string used to track the send OTP response.
register_token
string
A token used for registration purposes.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Login with Token
loginWithToken
POST
Register User with Form
Enable new users to register using a form.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (FormRegisterRequestSchema)
Required
Request body must contain user details such as name, last name, contact details and password. Check the example of a Form Registration request body shown below or refer `FormRegisterRequestSchema` for more details.
FormRegisterRequestSchema
first_name
string
First name of the application user.
last_name
string
Last name of the application user.
gender
string
Gender of user.
email
string
Email of user.
password
string
Password of user.
phone
object (FormRegisterRequestSchemaPhone)
FormRegisterRequestSchemaPhone
register_token
string
Unique registration token of user.
Response
200
400
Success. Check the example shown below or refer `RegisterFormSuccess` for more details.
RegisterFormSuccess
email
string
The email address provided during registration.
resend_timer
integer
The time in seconds before an OTP can be resent.
resend_token
string
A token used to authorize the resending of an OTP.
resend_email_token
string
A token used to authorize the resending of an OTP via email.
register_token
string
A token used for completing the registration process.
success
boolean
A boolean value indicating whether the registration operation was successful.
request_id
string
A random uuid string used to track the registration response.
message
string
A string containing additional information about the operation's result.
mobile
string
The user's phone mobile without the country code.
country_code
string
The country specific prefix for the phone number.
verify_email_otp
boolean
Whether email OTP verification is required.
verify_mobile_otp
boolean
Whether mobile OTP verification is required.
user_exists
boolean
Whether the user already exists.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Register User with Form
registerWithForm
OTP Authentication
Takes care of sending and verifying OTPs on mobile/email for login, registration, and resetting forgotten passwords. The length of the OTP, its duration until expiry, and the number of OTPs generated per user are configured within the platform.
Operations
POST
# Send OTP on Mobile
POST
# Send mobile OTP for forgot-password
POST
# Verify Mobile OTP
POST
# Verify Mobile OTP for Forgot Password
POST
# Send OTP on Email
POST
# Send Email OTP for Forgot Password
POST
# Verify Email OTP
POST
# Verify Email OTP for Forgot Password
POST
Send OTP on Mobile
Send a one-time password to the user's mobile for verification.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (SendMobileOtpRequestSchema)
Required
Request body must contain mobile no, country code and captcha code. Refer `SendMobileOtpRequestSchema` for more details.
SendMobileOtpRequestSchema
encrypt_otp
boolean
Set to true if you want to encrypt the OTP.
mobile
string
Mobile number of user.
country_code
string
Country code for the phone number.
action
string
Action to specify if to send or resent the OTP.
Enum
token
string
Token to validate the request.
android_hash
string
Unique hash value.
force
string
Force verify the OTP.
Response
200
400
Success. Returns a JSON object as shown below. Refer `OtpSuccess` for more details.
OtpSuccess
resend_timer
integer
The time in seconds before an OTP can be resent.
resend_token
string
A token used to authorize the resending of an OTP.
register_token
string
A token used for completing the registration process.
success
boolean
Whether the OTP send operation was successful.
request_id
string
A random uuid string used to track the OTP send response.
message
string
Additional information about the operation's result.
mobile
string
The user's mobile number without the country code.
country_code
string
The country specific prefix for the phone number.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Send OTP on Mobile
sendOTPOnMobile
POST
Send mobile OTP for forgot-password
Send a one-time password to the user's mobile for verification when resetting a forgotten password.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (SendMobileForgotOtpRequestSchema)
Required
Request body must contain mobile no, country code. Refer `SendMobileForgotOtpRequestSchema` for more details.
SendMobileForgotOtpRequestSchema
mobile
string
Phone number of user.
country_code
string
Country code for the phone number.
action
string
Action to specify if to send or resent the OTP.
Enum
token
string
Token to validate the request.
android_hash
string
Unique hash value.
Response
200
400
Success. Returns a JSON object as shown below. Refer `OtpSuccess` for more details.
OtpSuccess
resend_timer
integer
The time in seconds before an OTP can be resent.
resend_token
string
A token used to authorize the resending of an OTP.
register_token
string
A token used for completing the registration process.
success
boolean
Whether the OTP send operation was successful.
request_id
string
A random uuid string used to track the OTP send response.
message
string
Additional information about the operation's result.
mobile
string
The user's mobile number without the country code.
country_code
string
The country specific prefix for the phone number.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Send mobile OTP for forgot-password
sendForgotOTPOnMobile
POST
Verify Mobile OTP
Verify one-time password sent to user's mobile.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (VerifyOtpRequestSchema)
Required
Check the example shown below or refer `VerifyOtpRequestSchema` for more details.
VerifyOtpRequestSchema
request_id
string
Unique request id for the OTP sent to mobile number.
register_token
string
Unique temporary registration of the user.
otp
string
OTP for verification.
Response
200
400
Success. Returns a JSON object as shown below. Refer `VerifyOtpSuccess` for more details.
VerifyOtpSuccess
user
object (UserSchema)
UserSchema
user_exists
boolean
Whether the user already exists.
register_token
string
A token used for registration purposes.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Verify Mobile OTP
verifyMobileOTP
POST
Verify Mobile OTP for Forgot Password
Verify one-time password sent to user's mobile for resetting a forgotten password.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (VerifyMobileForgotOtpRequestSchema)
Required
VerifyMobileForgotOtpRequestSchema
request_id
string
Unique request id for the OTP.
otp
string
OTP for verification.
Response
200
400
Success. Returns a JSON object as shown below. Refer `VerifyForgotOtpSuccess` for more details.
VerifyForgotOtpSuccess
success
boolean
Whether the OTP verification was successful.
forgot_token
string
A token used for resetting the forgotten password.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
Was this section helpful?
POST
Loading...
Response
Example response not available.
Verify Mobile OTP for Forgot Password
verifyMobileForgotOTP
POST
Send OTP on Email
Send a one-time password to the user's email for verification.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (SendEmailOtpRequestSchema)
Required
SendEmailOtpRequestSchema
email
string
Email of a user to send email OTP.
action
string
Action to specify if to send or resent the OTP.
Enum
token
string
Token to validate the request.
register_token
string
Unique temporary registration of the user.
Response
200
400
Success. Returns a JSON object as shown below. Refer `EmailOtpSuccess` for more details.
EmailOtpSuccess
success
boolean
Whether the OTP send operation was successful.
resend_email_token
string
A token used to authorize the resending of an OTP via email.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Send OTP on Email
sendOTPOnEmail
POST
Send Email OTP for Forgot Password
Send a one-time password to the user's email for verification when resetting a forgotten password.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (SendEmailForgotOtpRequestSchema)
Required
SendEmailForgotOtpRequestSchema
email
string
Email of a user to send email OTP.
action
string
Action to specify if to send or resent the OTP.
Enum
token
string
Token to validate the request.
Response
200
400
Success. Returns a JSON object as shown below. Refer `EmailOtpSuccess` for more details.
EmailOtpSuccess
success
boolean
Whether the OTP send operation was successful.
resend_email_token
string
A token used to authorize the resending of an OTP via email.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Send Email OTP for Forgot Password
sendForgotOTPOnEmail
POST
Verify Email OTP
Verify one-time password sent to user's email.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (VerifyEmailOtpRequestSchema)
Required
Check the example shown below or refer `VerifyEmailOtpRequestSchema` for more details.
VerifyEmailOtpRequestSchema
email
string
Email of a user to verify OTP.
action
string
Action to verify the send or resent OTP.
register_token
string
Unique temporary registration of the user.
otp
string
OTP for verification.
Response
200
400
Success. Returns a JSON object as shown below. Refer `VerifyOtpSuccess` for more details.
VerifyOtpSuccess
user
object (UserSchema)
UserSchema
user_exists
boolean
Whether the user already exists.
register_token
string
A token used for registration purposes.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Verify Email OTP
verifyEmailOTP
POST
Verify Email OTP for Forgot Password
Verify one-time password sent to user's email for resetting a forgotten password.
Parameters
platform
string
ID of the application.
Default Value : Fynd
body
object (VerifyEmailForgotOtpRequestSchema)
Required
VerifyEmailForgotOtpRequestSchema
email
string
Email id of user.
otp
string
OTP for verification.
Response
200
400
Success. Returns a JSON object as shown below. Refer `VerifyForgotOtpSuccess` for more details.
VerifyForgotOtpSuccess
success
boolean
Whether the OTP verification was successful.
forgot_token
string
A token used for resetting the forgotten password.
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Loading...
Response
Example response not available.
Social Login
Enables customer to log in via social platforms such as Apple, Google, and Facebook, enhancing accessibility and user experience. Configure the integration from social developer consoles to get the necessary credentials for enabling social login on platform.
Login with Facebook
Login with Facebook
loginWithFacebook
Login with Google
Login with Google
loginWithGoogle
Android Login with Google
Android Login with Google
loginWithGoogleAndroid
iOS Login with Google
iOS Login with Google
loginWithGoogleIOS
iOS Login with Apple
iOS Login with Apple
loginWithAppleIOS