v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

MFA API

Verify MFA Challenge

Use this endpoint to complete the MFA verification step during login. After receiving an mfaToken from the access token endpoint, submit the verification code along with the token to receive your access credentials.

You must provide either a passcode (from your authenticator app, email, or SMS) or a recoveryCode — not both.

post/v1/login/mfa/verify

Request body

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).

Response

MFA verification succeeded. Returns the access credentials for the authenticated session.

accessTokenstring required

A temporary token that grants the user secure access the APIs.

expiresIninteger required

The time (in seconds) until the token expires.

idTokenstring

The identity details about the authenticated user in OpenID Connect standards. It can be used to verify user authentication.

refreshTokenstring required

A long-lived token that allows users to obtain a new access_token without requiring them to log in again.

scopestring

The level of access granted to the issued tokens

tokenTypestring required

The type of token issued.