Sign in
latestOpenAPI 3.0.0Private2026-08-1081731.5 KB

170261dc1673

OAuth2

Get Login Short Code

Generates a new login short code

post/v2/oauth/getshortcode

Request body

client_idstring required

The API client id generated from your app management dashboard.

scopesstring[] required

The list of scopes to request from the user.

versioninteger

Determines the format of the shortcode returned (defaults to v1)

  • 1 - a 6 digit numeric shortcode
  • 2 - a 6 digit code consisting of numbers and uppercase letters, excluding 1, I, 0, and O

Response

Success

codestring required

The short code that should be displayed to a user to use for login

device_idstring required

The identifier for this device's request that will be needed to check the status of the short code login

expires_atstring date-time required

The date and time at which the short code has expired and is no longer valid

intervalinteger required

How often (in seconds) you may poll to check the short code's status

verification_urlstring required

The URL that the user should visit to enter their short code

Example response

{
  "expires_at": "1970-04-20 07:10:00+00"
}