Skip to main content

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
/service/application/user/authentication/v1.0/session
# Get Logged in User
GET
/service/application/user/authentication/v1.0/sessions
# Get List OF Active Sessions
GET
/service/application/user/platform/v1.0/config
# Get Platform Configuration
GET
/service/application/user/authentication/v1.0/user-exists
# Chcek User Existence
POST
/service/application/user/authentication/v1.0/delete
# Verify OTP and Delete User
GET
/service/application/user/authentication/v1.0/logout
# 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
/service/application/user/authentication/v1.0/session
Loading...
Response
Example response not available.
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
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/user/authentication/v1.0/sessions
Loading...
Response
Loading...
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
look_and_feel
object (LookAndFeel)
LookAndFeel
updated_at
string
active
boolean
forgot_password
boolean
login
object (Login)
Login
skip_captcha
boolean
name
string
meta
object (MetaSchema)
MetaSchema
_id
string
social
object (Social)
Social
required_fields
object (RequiredFields)
RequiredFields
register_required_fields
object (RegisterRequiredFields)
RegisterRequiredFields
skip_login
boolean
flash_card
object (FlashCard)
FlashCard
subtext
string
social_tokens
object (SocialTokens)
SocialTokens
created_at
string
register
boolean
mobile_image
string
desktop_image
string
delete_account_day
integer
delete_account_reasons
array of object (DeleteAccountReasons)
Array of DeleteAccountReasons
delete_account_consent
object (DeleteAccountConsent)
DeleteAccountConsent
session_config
object (SessionExpiry)
SessionExpiry
__v
integer
Examples
Parameters
name:
"5eda528b97457fe43a733ace"
Was this section helpful?
GET
/service/application/user/platform/v1.0/config
Loading...
Response
Loading...
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
Examples
Parameters
q:
"vinit.mav12@gofynd.com"
Was this section helpful?
GET
/service/application/user/authentication/v1.0/user-exists
Loading...
Response
Example response not available.
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
reason
string
reason_id
string
request_id
string
otp
string
Response
200
400
Success. Returns a success message. Refer `DeleteUserSuccess` for more details.
DeleteUserSuccess
success
boolean
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/delete
Loading...
Response
Loading...
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
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/user/authentication/v1.0/logout
Loading...
Response
Loading...

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
/service/application/user/profile/v1.0/user-attributes
# Get User Attributes
PATCH
/service/application/user/profile/v1.0/user-attributes
# 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
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/user/profile/v1.0/user-attributes
Loading...
Response
Example response not available.
PATCH

Update User Attributes

Update user attributes
Parameters
body
object (UpdateUserAttributesRequest)
Required
list of user attributes to be updated
UpdateUserAttributesRequest
attributes
object
Response
200
400
Returns a list of users attributes
UserAttributes
attributes
object
Examples
Parameters
Parameters are not required.
Was this section helpful?
PATCH
/service/application/user/profile/v1.0/user-attributes
Loading...
Response
Example response not available.

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
/service/application/user/authentication/v1.0/login/password/reset
# Reset Password via Email
POST
/service/application/user/authentication/v1.0/login/password/mobile/reset
# Reset Password via Mobile
POST
/service/application/user/authentication/v1.0/login/password/reset/token
# Validate Password Reset Code
POST
/service/application/user/authentication/v1.0/login/password/reset/forgot
# Reset Password via Code and login
POST
/service/application/user/authentication/v1.0/login/password/forgot
# Reset Password via Code
GET
/service/application/user/authentication/v1.0/has-password
# Check Password Existence
POST
/service/application/user/authentication/v1.0/password
# Update Password
POST

Reset Password via Email

Sends 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
Response
200
400
Success. Check the example shown below or refer `ResetPasswordSuccess` for more details.
ResetPasswordSuccess
status
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/password/reset
Loading...
Response
Loading...
POST

Reset Password via Mobile

Sends 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
mobile
string
Response
400
Bad request. See the error object in the response body for specific reason
APIError
code
string
message
string
info
string
Error code description link
request_id
string
error
string
meta
object
authenticated
boolean
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/password/mobile/reset
Loading...
Response
Loading...
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
Response
200
400
Success. Check the example shown below or refer `ResetPasswordSuccess` for more details.
ResetPasswordSuccess
status
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/password/reset/token
Loading...
Response
Loading...
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
password
string
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
register_token
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/password/reset/forgot
Loading...
Response
Example response not available.
POST

Reset Password via Code

Reset a password using the code sent on email or SMS.
Parameters
body
object (ForgotPasswordRequestSchema)
Required
ForgotPasswordRequestSchema
code
string
password
string
Response
200
400
Success. Check the example shown below or refer `ResetForgotPasswordSuccess` for more details.
ResetForgotPasswordSuccess
success
boolean
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/password/forgot
Loading...
Response
Example response not available.
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
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/application/user/authentication/v1.0/has-password
Loading...
Response
Loading...
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
new_password
string
Response
200
400
Success. Returns a success message. Refer `VerifyEmailSuccess` for more details.
VerifyEmailSuccess
message
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/password
Loading...
Response
Loading...

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
/service/application/user/authentication/v1.0/verify/email
# Verify Email with Code
POST
/service/application/user/authentication/v1.0/verify/mobile
# Verify Mobile with Code
POST
/service/application/user/profile/v1.0/detail
# Edit User Profile Details
PUT
/service/application/user/profile/v1.0/mobile
# Add Mobile Number to Profile
DEL
/service/application/user/profile/v1.0/mobile
# Delete Mobile Number From Profile
POST
/service/application/user/profile/v1.0/mobile/primary
# Set Mobile as Primary
POST
/service/application/user/profile/v1.0/mobile/link/send
# Send Verification Link to Mobile
PUT
/service/application/user/profile/v1.0/email
# Add Email to Profile
DEL
/service/application/user/profile/v1.0/email
# Delete Email From Profile
POST
/service/application/user/profile/v1.0/email/primary
# Set Email as Primary
POST
/service/application/user/profile/v1.0/email/link/send
# Send Verification Link to Email
POST

Verify Email with Code

Verifies 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
Response
200
400
Success. Check the example shown below or refer `VerifyEmailSuccess` for more details.
VerifyEmailSuccess
message
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/verify/email
Loading...
Response
Loading...
POST

Verify Mobile with Code

Verifies 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
Response
200
400
Success. Check the example shown below or refer `VerifyEmailSuccess` for more details.
VerifyEmailSuccess
message
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/verify/mobile
Loading...
Response
Loading...
POST

Edit User Profile Details

Allows 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
last_name
string
mobile
object (EditProfileMobileSchema)
EditProfileMobileSchema
country_code
string
email
string
gender
string
dob
string
profile_pic_url
string
android_hash
string
sender
string
register_token
string
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
ProfileEditSuccess
user
object (UserSchema)
UserSchema
register_token
string
resend_email_token
string
user_exists
boolean
verify_email_link
boolean
verify_email_otp
boolean
verify_mobile_otp
boolean
email
string
request_id
string
country_code
string
mobile
string
success
boolean
message
string
resend_timer
integer
resend_token
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/profile/v1.0/detail
Loading...
Response
Example response not available.
PUT

Add Mobile Number to Profile

Adds 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
phone
string
Response
200
400
Success. Check the example shown below or refer `VerifyMobileOTPSuccess` for more details.
VerifyMobileOTPSuccess
user
object (UserSchema)
UserSchema
verify_mobile_link
boolean
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
PUT
/service/application/user/profile/v1.0/mobile
Loading...
Response
Example response not available.
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
register_token
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
active:
true
primary:
true
verified:
true
countryCode:
"91"
phone:
"9987568530"
Was this section helpful?
DEL
/service/application/user/profile/v1.0/mobile
Loading...
Response
Example response not available.
POST

Set Mobile as Primary

Sets 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
active
boolean
country_code
string
phone
string
primary
boolean
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
register_token
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/profile/v1.0/mobile/primary
Loading...
Response
Example response not available.
POST

Send Verification Link to Mobile

Sends 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
active
boolean
country_code
string
phone
string
primary
boolean
Response
200
400
Success. Check the example shown below or refer `SendMobileVerifyLinkSuccess` for more details.
SendMobileVerifyLinkSuccess
verify_mobile_link
boolean
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/profile/v1.0/mobile/link/send
Loading...
Response
Example response not available.
PUT

Add Email to Profile

Adds 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
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
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
PUT
/service/application/user/profile/v1.0/email
Loading...
Response
Example response not available.
DEL

Delete Email From Profile

Delete Email From Profile
Parameters
platform
string
ID of the application
Default Value : Fynd
active
boolean
Required
This is a boolean value to check if email ID is active 1. True - Email ID is active 2.False - Email ID is inactive
primary
boolean
Required
This is a 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
This is a 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
register_token
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
active:
true
primary:
true
verified:
true
email:
"vinit.mav12345@gofynd.com"
Was this section helpful?
DEL
/service/application/user/profile/v1.0/email
Loading...
Response
Example response not available.
POST

Set Email as Primary

Sets 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
Response
200
400
Success. Returns a JSON object with user details. Refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
register_token
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/profile/v1.0/email/primary
Loading...
Response
Example response not available.
POST

Send Verification Link to Email

Sends 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
Response
200
400
Request body must contain an email ID. Refer `EditEmailRequestSchema` for more details.
SendEmailVerifyLinkSuccess
verify_email_link
boolean
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/profile/v1.0/email/link/send
Loading...
Response
Loading...

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
/service/application/user/authentication/v1.0/login/otp
# Login with Mobile OTP
POST
/service/application/user/authentication/v1.0/login/password
# Email and Password Login
POST
/service/application/user/authentication/v1.0/login/token
# Login with Token
POST
/service/application/user/authentication/v1.0/register/form
# Register User with Form
POST

Login with Mobile OTP

Allows 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
set to true if you want to encrypt the OTP.
country_code
string
mobile
string
android_hash
string
Response
200
400
Success. Check the example shown below or refer `SendOtpResponse` for more details.
SendOtpResponse
resend_timer
integer
resend_token
string
success
boolean
request_id
string
message
string
mobile
string
country_code
string
email
string
resend_email_token
string
register_token
string
verify_email_otp
boolean
verify_mobile_otp
boolean
user_exists
boolean
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/otp
Loading...
Response
Example response not available.
POST

Email and Password Login

Allows 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
username
string
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
register_token
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/password
Loading...
Response
Example response not available.
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
Response
200
400
Success. Check the example shown below or refer `LoginSuccess` for more details.
LoginSuccess
user
object (UserSchema)
UserSchema
request_id
string
register_token
string
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/token
Loading...
Response
Example response not available.
POST

Register User with Form

Enables 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
last_name
string
gender
string
email
string
password
string
phone
object (FormRegisterRequestSchemaPhone)
FormRegisterRequestSchemaPhone
register_token
string
Response
200
400
Success. Check the example shown below or refer `RegisterFormSuccess` for more details.
RegisterFormSuccess
email
string
resend_timer
integer
resend_token
string
resend_email_token
string
register_token
string
success
boolean
request_id
string
message
string
mobile
string
country_code
string
verify_email_otp
boolean
verify_mobile_otp
boolean
user_exists
boolean
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/register/form
Loading...
Response
Loading...

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
/service/application/user/authentication/v1.0/otp/mobile/send
# Send OTP on Mobile
POST
/service/application/user/authentication/v1.0/otp/forgot/mobile/send
# Send mobile OTP for forgot-password
POST
/service/application/user/authentication/v1.0/otp/mobile/verify
# Verify Mobile OTP
POST
/service/application/user/authentication/v1.0/otp/forgot/mobile/verify
# Verify Mobile OTP for Forgot Password
POST
/service/application/user/authentication/v1.0/otp/email/send
# Send OTP on Email
POST
/service/application/user/authentication/v1.0/otp/forgot/email/send
# Send Email OTP for Forgot Password
POST
/service/application/user/authentication/v1.0/otp/email/verify
# Verify Email OTP
POST
/service/application/user/authentication/v1.0/otp/forgot/email/verify
# Verify Email OTP for Forgot Password
POST

Send OTP on Mobile

Sends 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
country_code
string
action
string
Enum
token
string
android_hash
string
force
string
Response
200
400
Success. Returns a JSON object as shown below. Refer `OtpSuccess` for more details.
OtpSuccess
resend_timer
integer
resend_token
string
register_token
string
success
boolean
request_id
string
message
string
mobile
string
country_code
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/otp/mobile/send
Loading...
Response
Loading...
POST

Send mobile OTP for forgot-password

Sends 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
country_code
string
action
string
Enum
token
string
android_hash
string
Response
200
400
Success. Returns a JSON object as shown below. Refer `OtpSuccess` for more details.
OtpSuccess
resend_timer
integer
resend_token
string
register_token
string
success
boolean
request_id
string
message
string
mobile
string
country_code
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/otp/forgot/mobile/send
Loading...
Response
Loading...
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
register_token
string
otp
string
Response
200
400
Success. Returns a JSON object as shown below. Refer `VerifyOtpSuccess` for more details.
VerifyOtpSuccess
user
object (UserSchema)
UserSchema
user_exists
boolean
register_token
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/otp/mobile/verify
Loading...
Response
Example response not available.
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
otp
string
Response
200
400
Success. Returns a JSON object as shown below. Refer `VerifyForgotOtpSuccess` for more details.
VerifyForgotOtpSuccess
success
boolean
forgot_token
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
Was this section helpful?
POST
/service/application/user/authentication/v1.0/otp/forgot/mobile/verify
Loading...
Response
Example response not available.
POST

Send OTP on Email

Sends 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
action
string
Enum
token
string
register_token
string
Response
200
400
Success. Returns a JSON object as shown below. Refer `EmailOtpSuccess` for more details.
EmailOtpSuccess
success
boolean
resend_email_token
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/otp/email/send
Loading...
Response
Loading...
POST

Send Email OTP for Forgot Password

Sends 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
action
string
Enum
token
string
Response
200
400
Success. Returns a JSON object as shown below. Refer `EmailOtpSuccess` for more details.
EmailOtpSuccess
success
boolean
resend_email_token
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/otp/forgot/email/send
Loading...
Response
Loading...
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
action
string
register_token
string
otp
string
Response
200
400
Success. Returns a JSON object as shown below. Refer `VerifyOtpSuccess` for more details.
VerifyOtpSuccess
user
object (UserSchema)
UserSchema
user_exists
boolean
register_token
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/otp/email/verify
Loading...
Response
Example response not available.
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
otp
string
Response
200
400
Success. Returns a JSON object as shown below. Refer `VerifyForgotOtpSuccess` for more details.
VerifyForgotOtpSuccess
success
boolean
forgot_token
string
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/otp/forgot/email/verify
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.

Operations
POST
/service/application/user/authentication/v1.0/login/facebook-token
# Login with Facebook
POST
/service/application/user/authentication/v1.0/login/google-token
# Login with Google
POST
/service/application/user/authentication/v1.0/login/google-android
# Android Login with Google
POST
/service/application/user/authentication/v1.0/login/google-ios
# iOS Login with Google
POST
/service/application/user/authentication/v1.0/login/apple-ios
# iOS Login with Apple
POST

Login with Facebook

Enables users to log in to the system using their Facebook accounts.
Parameters
platform
string
ID of the application
Default Value : Fynd
body
object (OAuthRequestSchema)
Required
Check the example of an OAuth request body shown below or refer `OAuthRequestSchema` for more details.
OAuthRequestSchema
is_signed_in
boolean
oauth2
object (OAuthRequestSchemaOauth2)
OAuthRequestSchemaOauth2
profile
object (OAuthRequestSchemaProfile)
OAuthRequestSchemaProfile
Response
200
401
Success. Returns a JSON object with the user details. Check the example shown below or refer `AuthSuccess` for more details.
AuthSuccess
register_token
string
user_exists
boolean
user
object (UserSchema)
UserSchema
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/facebook-token
Loading...
Response
Example response not available.
POST

Login with Google

Enables website users to log in to the system using their Google accounts.
Parameters
platform
string
ID of the application
Default Value : Fynd
body
object (OAuthRequestSchema)
Required
Check the example of an OAuth request body shown below or refer `OAuthRequestSchema` for more details.
OAuthRequestSchema
is_signed_in
boolean
oauth2
object (OAuthRequestSchemaOauth2)
OAuthRequestSchemaOauth2
profile
object (OAuthRequestSchemaProfile)
OAuthRequestSchemaProfile
Response
200
Success. Returns a JSON object with the user details. Check the example shown below or refer `AuthSuccess` for more details.
AuthSuccess
register_token
string
user_exists
boolean
user
object (UserSchema)
UserSchema
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/google-token
Loading...
Response
Example response not available.
POST

Android Login with Google

Enables Android users to log in to the system using their Facebook accounts.
Parameters
platform
string
ID of the application
Default Value : Fynd
body
object (OAuthRequestSchema)
Required
Check the example of an OAuth request body shown below or refer `OAuthRequestSchema` for more details.
OAuthRequestSchema
is_signed_in
boolean
oauth2
object (OAuthRequestSchemaOauth2)
OAuthRequestSchemaOauth2
profile
object (OAuthRequestSchemaProfile)
OAuthRequestSchemaProfile
Response
200
Success. Returns a JSON object with the user details. Check the example shown below or refer `AuthSuccess` for more details.
AuthSuccess
register_token
string
user_exists
boolean
user
object (UserSchema)
UserSchema
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/google-android
Loading...
Response
Example response not available.
POST

iOS Login with Google

Enables iOS users to log in to the system using their Facebook accounts.
Parameters
platform
string
ID of the application
Default Value : Fynd
body
object (OAuthRequestSchema)
Required
Check the example of an OAuth request body shown below or refer `OAuthRequestSchema` for more details.
OAuthRequestSchema
is_signed_in
boolean
oauth2
object (OAuthRequestSchemaOauth2)
OAuthRequestSchemaOauth2
profile
object (OAuthRequestSchemaProfile)
OAuthRequestSchemaProfile
Response
200
Success. Returns a JSON object with the user details. Check the example shown below or refer `AuthSuccess` for more details.
AuthSuccess
register_token
string
user_exists
boolean
user
object (UserSchema)
UserSchema
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/google-ios
Loading...
Response
Example response not available.
POST

iOS Login with Apple

Enables iOS users to log in to the system using their Apple ID.
Parameters
platform
string
ID of the application
Default Value : Fynd
body
object (OAuthRequestAppleSchema)
Required
Check the example of an OAuth request body shown below or refer `OAuthRequestAppleSchema` for more details.
OAuthRequestAppleSchema
user_identifier
string
oauth
object (OAuthRequestAppleSchemaOauth)
OAuthRequestAppleSchemaOauth
profile
object (OAuthRequestAppleSchemaProfile)
OAuthRequestAppleSchemaProfile
Response
200
Success. Returns a JSON object with the user details. Check the example shown below or refer `AuthSuccess` for more details.
AuthSuccess
register_token
string
user_exists
boolean
user
object (UserSchema)
UserSchema
Examples
Parameters
platform:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
/service/application/user/authentication/v1.0/login/apple-ios
Loading...
Response
Example response not available.