Sign in
Authentication

Log into the account

Returns an access token and the refresh token.

post/v3/accounts/login

Headers

originstring
user-Agentstring

Request body

accountIdstring nullable required

Unique identifier of the account.

accountAliasstring nullable

Unique account alias.

emailstring email required

Email address of the user.

passwordstring required

Password of the user.

twoFactorCodestring nullable

Two factor code generated by Authenticator app.

twoFactorRecoveryCodestring nullable

Two factor recovery code.

rememberMeboolean required

Remember me. When true, the refresh token is valid for 7 days instead of 1 day.

environmentIdstring uuid nullable

Environment the user belongs to; null means production. SDK transport (the eid from product.dat), which is how a named-user license authenticates inside a sandbox — not a documented knob. Rejected for browser sessions: the customer portal is production-only.

Response

OK

accessTokenstring required
refreshTokenstring required

Changes