Access Token Request
Request an access token using your user credentials and API Key.
See the Authentication section for more details.
Acquiring an Access Token
Using an Access Token
Expiration and Renewal
Access tokens expire after 80 minutes. Each token response includes an expirationTime field with the exact expiry time. Renew by calling renewAccessToken with your current token before it expires.
Other Important Notes
Calling the accessTokenRequest endpoint successfully will start a new session on our servers. This session is tracked, and you are limited to two concurrent sessions. Once a third (or additional) session is created, the oldest sessions are closed. This can be problematic in the following situations:
Request
This endpoint expects an object.
name
password
hibpCheck
appId
appVersion
deviceId
cid
sec
Response
AccessTokenResponse
errorText
Non-empty if the request failed
hibpHint
EmailAndPasswordCompromised, PasswordCompromised
Allowed values:
accessToken
expirationTime
passwordExpirationTime
userStatus
Active, Closed, Initiated, TemporaryLocked, UnconfirmedEmail
Allowed values:
userId
name
hasLive
hasSimPlus
showKIDs