Public

Confirm email enrollment and complete a forced-2FA login.

Post the enrollment token (from POST /api/v1/tokens), the challenge token (from .../enroll/email/begin), and the emailed code:

{ "enrollment_token": "eyJ...", "challenge_token": "eyJ...", "code": "123456" }

On success email 2FA is enabled and login completes — the response carries the final access token plus the user's one-time recovery codes:

{
  "confirmed": true,
  "recovery_codes": ["abcd-efgh-ijkl", "..."],
  "access_token": "eyJ...",
  "token_type": "Bearer",
  "expires_in": 31536000
}

Show the recovery_codes to the user once — they are not returned again. An incorrect code returns 400 (invalid_grant); an expired challenge returns 410 (challenge_expired). Rate limited to 10 requests per minute (429).

post/api/v1/tokens/two-factor/enroll/email/confirm

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/tokens/two-factor/enroll/email/confirm
Auth: none declared

Query parameters

dataunknown required

Response

Enrollment confirmed; the access token and recovery codes are returned.

confirmedboolean

Always true on a success response; the enrollment is now active.

recovery_codesstring[] nullable

The user's recovery codes, generated as part of first-time enrollment. These are shown once and never returned again — prompt the user to store them somewhere safe. Each code is single-use at POST /api/v1/tokens/two-factor/recovery.

access_tokenstring nullable

The JWT access token. Use it as Authorization: bearer {access_token} for subsequent API calls — login is complete.

token_typestring nullable

Always Bearer.

expires_ininteger

Seconds until the access token expires.

Example response

{
  "confirmed": false,
  "recovery_codes": [
    "string"
  ],
  "access_token": "string",
  "token_type": "string",
  "expires_in": 0
}

Changes

No recorded changes to this operation across all 1 revision of this API.