CRcryptlex
Authentication

Log into the account

Changed on

Returns an access token and the refresh token.

post/v3/accounts/login

Request

  • Base URL
    https://api.cryptlex.com
  • URL
    https://api.cryptlex.com/v3/accounts/login
  • Auth
    none required

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.

Response

OK

accessTokenstring required
refreshTokenstring required

Changes

  • a25b6aaa706cRevision changes
    • info

      added the new optional request property

  • ec1259c12475Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • warning

      removed subschema #2 from the request body allOf list

    • info

      api operation id LoginAuthentication removed and replaced with LoginUserAuthentication

    • info

      added the new optional header request parameter user-Agent

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status