Create Authorization

Create an authorization with a POST request to the endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

If the account has two-factor authentication (2FA) enabled or the "twoFactor" parameter is explicitly set to true, the initial request will return a 400 status code.

{
  "error": {
    "errorId": "authorization.twoFactor",
    "errorMessage": "A valid two factor authentication code is required."
  }
}

When a 400 response is returned, it triggers the delivery of a 2FA code to the user's registered mobile number. Once the code is received, the request can be retried with the "code" included.

If 2FA is disabled, and "twoFactor" is either omitted or set to false, the request will succeed on the first attempt.

📘

A single account can generate and use multiple authorization tokens simultaneously.

Body Params
date

An optional (but recommended) expiry date for the authorization token, in ISO 8601 format without milliseconds. If omitted, the token never expires.

string

Required if the account has 2FA enabled or twoFactor is true. The code that was sent to the user.
Example:124568

boolean

If true, a 2FA code will be required to generate the authorization token, regardless of whether the user has 2FA enabled.
Example: True

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json