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

Verify MFA Passcode

cURL

curl --request POST \
  --url https://identity.sandbox.lerian.net/v1/users/{id}/mfa/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "passcode": "123456",
  "secret": "JBSWY3DPEHPK3PXP",
  "mfaType": "app"
}
'

200

Example

{
  "verified": true
}

Authorizations

Authorization · string · header · required

The authorization token in the 'Bearer ' format.

Path Parameters

id · string · required

The unique identifier of the user you want to retrieve.

Body

application/json

Information required to verify an MFA passcode during setup.

passcode · string · required

The OTP passcode to verify.

Required string length: 6 - 8

mfaType · enum<string> · required

The type of MFA being verified.

Available options: app, email, sms

secret · string

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

countryCode · string

The country code for SMS-based MFA (e.g. +1).

Response

200

application/json

MFA passcode verified successfully.

verified · boolean