Skip to main content

Verify OTP Email registration​

Verify the OTP Email registration with the provided code.

Path Parameters
    userId string required

    unique identifier of the user.

    otpEmailId string required

    unique identifier of the OTP Email registration, which was returned in the add OTP Email.

Request Body required
    code string required

    Possible values: non-empty and <= 200 characters

    Set the verification code generated during the add OTP Email request.

Responses

OTP Email authenticator successfully verified

Schema
    details object
    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to
POST /v3alpha/users/:userId/otp_email/:otpEmailId/verify

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN
Bearer Token
userId — path required
otpEmailId — path required
Content-Type
Body required
{

  "code": "SKJd342k"

}
Accept
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/otp_email/:otpEmailId/verify' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "code": "SKJd342k"
}'