Check if user already set up MFA TimeBased token or not

Check MFA Time-Based Token Setup Status

The GET /api/isTimeBasedSetUp endpoint checks whether the authenticated user has already configured Time-Based Multi-Factor Authentication (MFA). It returns a single boolean value: true if the user has completed Time-Based MFA setup, or false if setup has not yet been performed. This endpoint helps partners determine whether additional MFA onboarding steps are required before the user can proceed with secured operations.

Endpoint

GET /api/isTimeBasedSetUp

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Call this endpoint at login or during account security checks to determine whether the user still needs to complete Time-Based MFA enrollment. If the response is false, redirect the user to the MFA setup flow before granting access to sensitive operations. This is particularly useful when enforcing MFA as a prerequisite for high-value transactions or account management actions.

Response

200 OK

Returns a plain boolean value.

FieldTypeDescription
(body)booleantrue if the user has configured Time-Based MFA; false if setup is incomplete or not started
true

Or when MFA has not been configured:

false

Error Codes

CodeWhen it happens
401Token missing, expired, or invalid
403Insufficient permissions
500Internal server error

Common Mistakes

  • Calling this endpoint without a valid Bearer token will result in a 401 response; ensure the token is obtained and refreshed before invoking.
  • A response of false does not indicate an error — it means the user has not yet set up Time-Based MFA and should be directed to the enrollment flow.
  • Do not cache the response long-term; MFA setup status can change if the user completes enrollment between calls.

Related Endpoints

  • POST /api/auth/v2 — Obtain a Bearer token using username, password, and partnerId
  • POST /api/auth/refresh — Refresh an existing Bearer token before it expires

Example

curl -X GET https://api.banking.netevia.dev/api/isTimeBasedSetUp \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json