Verify verification code

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://openapi.logto.io/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Logto API references MCP server": {
    "url": "https://openapi.logto.io/mcp"
  }
}

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. For a code sent to the subject the interaction carries (an identifier with only its type), the identifier likewise carries only its type: the code is verified against the identifier the record was sent to, and the request never carries a raw identifier.

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. For a code sent to the subject the interaction carries, only the type is given.
One of:
object-1 object object-2 object object-2 object
Hide attributes Show attributes

type string("email") Required

value string(regex) Required

Maximum length is 256. Format should match the following pattern: /^\S+@\S+\.\S+$/.
Hide attributes Show attributes

type string("phone") Required

value string(regex) Required

Format should match the following pattern: /^\d+$/.
Hide attribute Show attribute

type string Required

Values are email or phone.
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.
403

Forbidden
404

Verification record not found, or the identifier carried only its type but the interaction carries no subject or the record was not created for the subject.
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": "string",
    "value": "string"
  },
  "verificationId": "string",
  "code": "string"
}'

Request examples

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

Response examples (200)

{
  "verificationId": "string"
}