Skip to main content
POST
/
api
/
v1
/
mfa
/
enroll
curl -X POST https://api.gosentrix.io/api/v1/mfa/enroll \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"
{
  "secret": "JBSWY3DPEHPK3PXP",
  "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "backup_codes": [
    "ABCD-1234-EFGH",
    "IJKL-5678-MNOP",
    "QRST-9012-UVWX",
    "YZAB-3456-CDEF",
    "GHIJ-7890-KLMN"
  ]
}
Enroll in multi-factor authentication (MFA) using TOTP (Time-based One-Time Password).
curl -X POST https://api.gosentrix.io/api/v1/mfa/enroll \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"
{
  "secret": "JBSWY3DPEHPK3PXP",
  "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
  "backup_codes": [
    "ABCD-1234-EFGH",
    "IJKL-5678-MNOP",
    "QRST-9012-UVWX",
    "YZAB-3456-CDEF",
    "GHIJ-7890-KLMN"
  ]
}

Headers

Authorization
string
required
Bearer token (access token)

Response

secret
string
TOTP secret key (for manual entry in authenticator apps)
qr_code
string
QR code data URL (for scanning with authenticator apps)
backup_codes
array
One-time backup codes (save securely)

Next Steps

  1. Scan the QR code with an authenticator app (Google Authenticator, Authy, etc.)
  2. Verify MFA setup using MFA Verify
  3. Save backup codes in a secure location

Errors

401
object
Invalid or missing token
409
object
MFA already enrolled