start Two Factor Login With Id

POST {{baseUrl}}/api/two-factor/start

Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send API (/api/two-factor/send)in order to send a one-time use code to a user. You can also use one-time use code returned to send the code out-of-band. The Two-Factor login is completed by making a request to the Two-Factor Login API (/api/two-factor/login). with the two-factor identifier and the one-time use code. This API is intended to allow you to begin a Two-Factor login outside a normal login that originated from the Login API (/api/login).

Request Body

{"applicationId"=>"<uuid>", "code"=>"<string>", "loginId"=>"<string>", "trustChallenge"=>"<string>", "userId"=>"<uuid>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;methods&quot;:[{&quot;authenticator&quot;:{&quot;algorithm&quot;:&quot;HmacSHA1&quot;,&quot;codeLength&quot;:&quot;\u003cinteger\u003e&quot;,&quot;timeStep&quot;:&quot;\u003cinteger\u003e&quot;},&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastUsed&quot;:&quot;\u003cboolean\u003e&quot;,&quot;method&quot;:&quot;\u003cstring\u003e&quot;,&quot;mobilePhone&quot;:&quot;\u003cstring\u003e&quot;,&quot;secret&quot;:&quot;\u003cstring\u003e&quot;},{&quot;authenticator&quot;:{&quot;algorithm&quot;:&quot;HmacSHA256&quot;,&quot;codeLength&quot;:&quot;\u003cinteger\u003e&quot;,&quot;timeStep&quot;:&quot;\u003cinteger\u003e&quot;},&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastUsed&quot;:&quot;\u003cboolean\u003e&quot;,&quot;method&quot;:&quot;\u003cstring\u003e&quot;,&quot;mobilePhone&quot;:&quot;\u003cstring\u003e&quot;,&quot;secret&quot;:&quot;\u003cstring\u003e&quot;}],&quot;twoFactorId&quot;:&quot;\u003cstring\u003e&quot;}