v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

MFA API

Verify MFA Passcode

Use this endpoint to verify the MFA passcode entered by the user during setup. Must be called after initiating setup and before enabling MFA.

post/v1/users/{id}/mfa/verify

idstring required

The unique identifier of the user you want to retrieve.

passcodestring required

The OTP passcode to verify.

secretstring

The TOTP secret (required for app-based MFA).

mfaType'app' | 'email' | 'sms' required

The type of MFA being verified.

countryCodestring

ISO 3166-1 alpha-2 country code (e.g. "BR", "US"). Used to resolve the phone number for SMS MFA. Not a dial prefix (+55).

MFA passcode verified successfully.

verifiedboolean