verifyEmail (v1)

Verify time-based one-time password email challenge

Query POST tag:Challenge

Overview

Verifies the time-based one-time password sent to the user’s mail address.

The unauthorised operations will be allowed to proceed once the TOTP verified successfully.

POST (/internal/v1/mfa/totp-email/{challengeId}:verify)

Parameters

  • challengeId (path) (required): The ID is challenge id received during operation initiation which required challenge.

Request Body

Responses

400 Bad Request

410

500 Internal Server Error

Architecture

1 property
totp string
required

The Time-Based One-Time Password (TOTP) sent to the mail for verification

7 properties
code string
Allowed values: urn:plmr:mfa-totp:api:INTERNAL_SERVER_ERROR urn:plmr:mfa-totp:api:BAD_REQUEST urn:plmr:mfa-totp:api:RESOURCE_UNKNOWN urn:plmr:mfa-totp:api:UNAUTHORIZED urn:plmr:mfa-totp:api:FORBIDDEN urn:plmr:mfa-totp:api:USER_NOT_FOUND urn:plmr:mfa-totp:api:CHALLENGE_NOT_FOUND urn:plmr:mfa-totp:api:INVALID_OTP urn:plmr:mfa-totp:api:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa-totp:api:STEP_UP_REQUEST_CONTEXT_NOT_FOUND
message string
requestId string
fieldErrors array [object]
7 properties
code string
Allowed values: urn:plmr:mfa-totp:api:INTERNAL_SERVER_ERROR urn:plmr:mfa-totp:api:BAD_REQUEST urn:plmr:mfa-totp:api:RESOURCE_UNKNOWN urn:plmr:mfa-totp:api:UNAUTHORIZED urn:plmr:mfa-totp:api:FORBIDDEN urn:plmr:mfa-totp:api:USER_NOT_FOUND urn:plmr:mfa-totp:api:CHALLENGE_NOT_FOUND urn:plmr:mfa-totp:api:INVALID_OTP urn:plmr:mfa-totp:api:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa-totp:api:STEP_UP_REQUEST_CONTEXT_NOT_FOUND
message string
requestId string
fieldErrors array [object]
7 properties
code string
Allowed values: urn:plmr:mfa-totp:api:INTERNAL_SERVER_ERROR urn:plmr:mfa-totp:api:BAD_REQUEST urn:plmr:mfa-totp:api:RESOURCE_UNKNOWN urn:plmr:mfa-totp:api:UNAUTHORIZED urn:plmr:mfa-totp:api:FORBIDDEN urn:plmr:mfa-totp:api:USER_NOT_FOUND urn:plmr:mfa-totp:api:CHALLENGE_NOT_FOUND urn:plmr:mfa-totp:api:INVALID_OTP urn:plmr:mfa-totp:api:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa-totp:api:STEP_UP_REQUEST_CONTEXT_NOT_FOUND
message string
requestId string
fieldErrors array [object]