Verify MFA challenge

POST

/api/mfa/verify

curl --request POST \
  --url http://localhost:3001/api/mfa/verify \
  --header 'Content-Type: application/json' \
  --data '{ "challenge_id": "example", "code": "example", "device_name": "example", "trust_device": true }'

• Local development
• Production

Verify a multi-factor authentication challenge using TOTP code or backup code

Request Body^required

MFA verification request

Media typeapplication/json

object

challenge_id

string

code

string

device_name

string

trust_device

boolean

Example^generated

{
  "challenge_id": "example",
  "code": "example",
  "device_name": "example",
  "trust_device": true
}

Responses

200

OK

Media typeapplication/json

object

code_type

“totp” or “backup_code”

string

device_id

string

message

string

success

boolean

Example^generated

{
  "code_type": "example",
  "device_id": "example",
  "message": "example",
  "success": true
}

400

Bad Request

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

401

Unauthorized

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

403

Forbidden

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

404

Not Found

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

410

Gone

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

429

Too Many Requests

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

500

Internal Server Error

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

503

Service Unavailable

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}