Authenticate via email

2min

POST
This endpoint provides the ability to authenticate an account using email address and password.
            Upon successful authentication, the account profile will be returned alongside a valid session token.
AUTHENTICATION
Authorization
string
Bearer
HEADER PARAMETERS
X-TokenId
string
The eSuite Token Id
X-SessionId
string
The eSuite Session Id
X-Version
string
*
The eSuite Version
Origin
string
The eSuite Origin
BODY PARAMETERS
loginDetails
FictiveGlobal.Api.Rest.Dtos.v1.LoginDetails
*
Login details
email
string
Account email
password
string
Account password
RESPONSES
200
OK
FictiveGlobal.Api.Rest.Dtos.v3.AccountResult
Account
accountReference
string
Account reference
status
string<None | Active | Suspended | Closed | MWalletInactive>
Status of account
verified
boolean
Flag that marks if the account has been verified
email
string
Email of account
clientUserId
string
Client Id of the user
salutation
string
firstName
string
Account first name
lastName
string
Account last name
phoneNumber
string
Account phone number
mobileNumber
string
Account mobile number
dateOfBirth
string<date-time>
Date of birth of the Account
gender
string<NotKnown | Female | Male>
Gender
addresses
FictiveGlobal.Api.Rest.Dtos.v1.Address[]
Addresses of Account
customParameters
object
Custom parameters
sessionToken
string
The session token
marketingAllowed
boolean
Marketing Allowed
400
Unable to authenticate using the provided session
401
Not Authorized
404
Not Found
500
Internal Server Error
﻿
﻿

Updated 31 Jan 2023

Did this page help you?

Yes

Update password via email token

Authenticate via ClientUserId (Third Party)

Docs powered by archbee