Verify one-time token

POST /api/experience/verification/one-time-token/verify

Verify the provided one-time token against the user's email. If successful, the verification record will be marked as verified.

application/json

Body Required

  • identifier object Required

    The unique user identifier.
    Currently, only email is accepted.

    Hide identifier attributes Show identifier attributes object
    • type string("email") Required
    • value string(regex) Required

      Format should match the following pattern: /^\S+@\S+\.\S+$/.

  • token string Required

    The one-time token to be verified.

    Minimum length is 1.

Responses

  • 200 application/json

    The one-time token was successfully verified.

    Hide response attribute Show response attribute object
    • verificationId string Required

      The unique ID of the verification record. Required for user identification via the Identification API or to bind the identifier to the user's account via the Profile API.
  • 400

    The one-time token is invalid or the maximum number of attempts has been exceeded. Check the error message for details.

  • 404

    Verification record not found.

POST /api/experience/verification/one-time-token/verify 
curl \
 --request POST 'https://[tenant_id].logto.app/api/experience/verification/one-time-token/verify' \
 --header "Content-Type: application/json" \
 --data '{"identifier":{"type":"string","value":"string"},"token":"string"}'
Request examples 
{
  "identifier": {
    "type": "string",
    "value": "string"
  },
  "token": "string"
}
Response examples (200) 
{
  "verificationId": "string"
}