API Reference
Accounts

Authenticate via email

1min
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
Header Parameters
X-TokenId
X-SessionId
X-Version
*
Origin
Body Parameters
loginDetails
*
Description
Login details
email
password
Responses
200
OK
Description
Account
accountReference
status
verified
email
clientUserId
*
salutation
firstName
lastName
phoneNumber
mobileNumber
dateOfBirth
gender
addresses
customParameters
sessionToken
marketingAllowed
400
Unable to authenticate using the provided session
401
Not Authorized
404
Not Found
500
Internal Server Error
Curl
JS
Ruby
Python
Responses
200
400
401
404
500