Choose a 2FA method

Use this method to specify which 2FA method (the Google Authenticator app or SMS codes) should be used for authentication in the Trader's Room if both 2FA methods are enabled for a client.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

uuid*uuid

The universally unique identifier (UUID) assigned to a client authentication session.

This identifier is obtained after initializing the Sign In wizard.

Formatuuid

type*string

The 2FA method to be used for authentication. Possible values:

google — a code from the Google Authenticator app
sms — a code sent to a client phone number via SMS

Response Body

`application/json`

curl -X POST "https://example.com/api/v2/my/signin/2fa" \  -H "Content-Type: application/json" \  -d '{    "uuid": "36f59381-5b54-48bd-a0c7-3b908c476732",    "type": "sms"  }'

{  "code": 200,  "data": null,  "done": false,  "uuid": "36f59381-5b54-48bd-a0c7-3b908c476732",  "workflow": "2fa_sms_auth"}

{  "error": {    "message": "Bad Request",    "details": [      {        "issue": "The selected value is invalid.",        "field": "parameter"      }    ]  }}

{  "error": {    "message": "Too Many Requests"  }}

{  "error": {    "message": "Service Unavailable"  }}

Choose a 2FA method

Authorization

Request Body

Response Body

200application/json

400application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`