HEhexclave
OTP

MFA sign in

Changed on

Complete multi-factor authorization to sign in, with a TOTP and an MFA attempt code

post/auth/mfa/sign-in

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/auth/mfa/sign-in
  • Auth
    none declared

Request body

type'totp' required
totpstring required
codestring required

A 45 character code

Example request

{
  "code": "u3h6gn4w24pqc8ya679inrhjwh1rybth6a7thurqhnpf2"
}

Response

Successful response

refresh_tokenstring required

Long-lived refresh token that can be used to obtain a new access token

access_tokenstring required

Short-lived access token that can be used to authenticate the user

is_new_userboolean required

Whether the user is a new user

user_idstring required

The unique identifier of the user

Example response

{
  "refresh_token": "i8ns3aq2...14y",
  "access_token": "eyJhmMiJB2TO...diI4QT",
  "is_new_user": true,
  "user_id": "3241a285-8329-4d69-8f3d-316e08cf140c"
}

Changes

  • f135fd8ca8b4Revision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new totp enum value to the request property