Skip to content

Request2FACode

Walter Lara edited this page Feb 16, 2024 · 3 revisions

Request Two-Factor Authentication (2FA) Code

Allows to request a 2FA code (aka verification code) to be send via email.

Request

URL: /v1/auth/code

Method: GET

Path Parameters: None

Query Parameters:

Parameter Type Description Requirement Type
email string Valid email address to send the 2FA auth-code. Required
mustExists boolean Indicates if an existing account associated with the email must exists to process the request. In other words, it indicates if the request should be ignored when no account is found. If missing, defaults to false. Optional

Headers:

g-recaptcha-platform: {Web|Android|iOS}

g-recaptcha-token: {reCAPTCHA Token for "auth_code" action}

✅ Success Response

Code: 204 NO CONTENT

Headers: None

❌ Error Response

Code: 400 BAD REQUEST

Condition: If missing email.

Headers:

Content-Type: application/json

Content example:

{
    "code": 400,
    "description": "Bad Request",
    "cause": "Missing query param: email"
}

See Also

Login using Email/Password

Login using OAuth

Refresh JWT Access Token

Decode JWT Access Token

Clone this wiki locally