verifyMultiFactor

POST

/api/v1/auth/mfa/verify

const url = 'https://example.com/api/v1/auth/mfa/verify';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"challengeToken":"example","code":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/auth/mfa/verify \
  --header 'Content-Type: application/json' \
  --data '{ "challengeToken": "example", "code": "example" }'

Completes a pending sign-in with an authenticator or recovery code.

Request Body^required

application/json

object

challengeToken

required

string

code

required

An authenticator code or a recovery code. The server decides which by shape; six digits are never matched against recovery codes.

string

Example^generated

{
  "challengeToken": "example",
  "code": "example"
}

Responses

200

Signed in

401

Incorrect code or expired challenge

429

Too many incorrect codes

verifyMultiFactor

Request Bodyrequired

Examplegenerated

Responses

200

401

429

Request Body^required

Example^generated