Verify verification code

POST /api/experience/verification/verification-code/verify

Verify the provided verification code against the user's identifier. If successful, the verification record will be marked as verified.

application/json

Body Required

identifier object Required

The identifier (email address or phone number) to verify the code against. Must match the identifier used to send the verification code.
Hide identifier attributes Show identifier attributes object
- type string Required
  
  Values are email or phone.
- value string Required
verificationId string Required

The verification ID of the CodeVerification record.
code string Required

The verification code to be verified.

Responses

200 application/json

The verification code 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 verification code is invalid or the maximum number of attempts has been exceeded. Check the error message for details.
404

Verification record not found.
501

The connector for sending the verification code is not configured.

POST /api/experience/verification/verification-code/verify

curl \
 --request POST 'https://[tenant_id].logto.app/api/experience/verification/verification-code/verify' \
 --header "Content-Type: application/json" \
 --data '{"identifier":{"type":"email","value":"string"},"verificationId":"string","code":"string"}'

Request examples

{
  "identifier": {
    "type": "email",
    "value": "string"
  },
  "verificationId": "string",
  "code": "string"
}

Response examples (200)

{
  "verificationId": "string"
}