Skip to main content
POST
Start a 2FA reset

Authorizations

Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Query Parameters

customerId
string
required

The unique identifier of the customer resetting a factor.

Body

application/json

Selects which enrolled factor to reset via the liveness-gated recovery flow.

factor
enum<string>
required

The enrolled factor to reset.

Available options:
SMS_OTP,
TOTP,
PASSKEY

Response

Reset initiated; the reset handle and liveness material are returned.

The reset handle plus the opaque liveness handles a caller relays to the end-user device to complete the liveness check. resetId threads the ceremony together (status and complete reference it). livenessAccessToken and verificationLink are omitted when they are not returned.

resetId
string
required

Identifier for this reset; pass it to the status and complete endpoints.

livenessAccessToken
string | null

Access token for the embedded liveness/verification SDK, bound to this reset. Omitted when one is not returned.

Hosted identity-verification page URL for completing liveness. Omitted when one is not returned.

expiresAt
string<date-time> | null

Absolute UTC timestamp at the end of the reset window. Omitted when one is not returned.

Example:

"2025-10-03T12:30:00Z"