Skip to content

Login

POST
/auth/login
object
email
required
string format: email
password
required
string
accountType

E.g. internal, vendor, auto; vendor may return 501

string
""

Access and refresh tokens

object
success
required
boolean
data
required
data
object
accessToken
required
string
refreshToken
required
string
expiresIn
required

Access token lifetime in seconds

integer format: int64
tokenType
required
string
Example
Bearer

Validation error

object
success
required
boolean
error
required
object
code
required
string
Example
validation_error
message
required
string

Missing/invalid token or credentials

object
success
required
boolean
error
required
object
code
required
string
Example
validation_error
message
required
string

Pending_approval, registration_rejected, or account_inactive

object
success
required
boolean
error
required
object
code
required
string
Example
validation_error
message
required
string

Resource not found

object
success
required
boolean
error
required
object
code
required
string
Example
validation_error
message
required
string

Rate limited (login)

object
success
required
boolean
error
required
object
code
required
string
Example
validation_error
message
required
string

Not implemented (e.g. vendor login)

object
success
required
boolean
error
required
object
code
required
string
Example
validation_error
message
required
string