API Reference
Accounts

Authenticate via ClientUserId (Third Party)

1min
POST

This endpoint provides the ability to authenticate using an external system value. Upon successful authentication, the account profile will be returned alongside a valid session token.

Authentication
Authorization
Path Parameters
clientUserId
*
Header Parameters
X-TokenId
X-SessionId
X-Version
*
Origin
Body Parameters
accountParamaters
*
Description
Account detail parameter
parameterId
name
value
isClientUserId
Responses
200
OK
Description
Account
accountReference
status
verified
email
clientUserId
*
salutation
firstName
lastName
phoneNumber
mobileNumber
dateOfBirth
gender
addresses
customParameters
sessionToken
marketingAllowed
401
Not Authorized
404
Not Found.
500
Internal Server Error
Curl
JS
Ruby
Python
Responses
200
401
404
500