MFA Challenge (OTP) - Servebolt API (v1)

If you have MFA enabled on your account, the Login endpoint will ask you to complete the authentication with an OTP challenge. You can use this endpoint to complete the MFA challenge and get a usable access token.

Request

Header Params

string

required

Example:

application/json

Content-Type

string

required

Example:

application/json

Body Params application/x-www-form-urlencoded

mfa_token

string

required

The token you have received in the mfa_required error in the Login endpoint.

otp

string

required

A valid OTP code

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

object

required

access_token

string

required

The access token needed to make API calls.

refresh_token

string

required

id_token

string

required

scope

string

required

expires_in

integer

required

The number of seconds the token is valid for.

token_type

string

required

Example:

Bearer

accountId

integer

required

accountEmail

string

required

accountName

string

required

accountPicture

string

required

intercomUserHash

string

required

Example

{
    "data": {
        "access_token": "string",
        "refresh_token": "string",
        "id_token": "string",
        "scope": "string",
        "expires_in": 0,
        "token_type": "Bearer",
        "accountId": 0,
        "accountEmail": "string",
        "accountName": "string",
        "accountPicture": "string",
        "intercomUserHash": "string"
    }
}

🟠401Unauthorized