Create and send 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

Create a new CodeVerification record and sends the code to the specified identifier. The code verification can be used to verify the given identifier. Once the interaction already carries a subject (the subject pinned by a step-up authentication, or an identified user), the identifier may carry only its type: the code is then sent to that user's primary email or phone with the SignIn template, the subject is read from the interaction storage, and the request never carries a raw identifier. This variant is only accepted with the SignIn interaction event.

application/json

Body

object Required

identifier object Required
One of:
object-1 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+$/.
identifier

The identifier (email address or phone number) to send the verification code to. Once the interaction carries a subject, { "type": "email" } or { "type": "phone" } without a value sends the code to that user's primary email or phone.
interactionEvent Required

The interaction event for which the verification code will be used. Supported values are SignIn, Register, and ForgotPassword. This determines the template for the verification code.

Values are SignIn, Register, or ForgotPassword.

identifier object Required

The identifier (email address or phone number) to send the verification code to. Once the interaction carries a subject, { "type": "email" } or { "type": "phone" } without a value sends the code to that user's primary email or phone.
Hide identifier attribute Show identifier attribute object
- type string Required
  
  Values are email or phone.
interactionEvent Required

The interaction event for which the verification code will be used. Supported values are SignIn, Register, and ForgotPassword. This determines the template for the verification code.

Responses

200 application/json

The verification code has been successfully sent.
Hide response attribute Show response attribute object
- verificationId string Required
  
  The unique ID of the verification record. Required to verify the code.
400

An invalid identifier was provided.
403

Forbidden
404

The identifier carried only its type but the interaction carries no subject, or the subject has no primary identifier of that type (session.identifier_not_found).
422

Unprocessable Content
429

Too Many Requests
501

The connector for sending the verification code is not configured.

POST /api/experience/verification/verification-code

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

Request examples

{
  "identifier": {
    "type": "string",
    "value": "string"
  },
  "interactionEvent": "SignIn"
}

{
  "identifier": {
    "type": "email"
  }
}

Response examples (200)

{
  "verificationId": "string"
}