Experience

Create and send verification code

Changed on

Create a new CodeVerification record and sends the code to the specified identifier. The code verification can be used to verify the given identifier.

post/api/experience/verification/verification-code

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/experience/verification/verification-code
  • Auth: none required

Request body

interactionEvent'SignIn' | 'Register' | 'ForgotPassword' 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.

Response

The verification code has been successfully sent.

verificationIdstring required

The unique ID of the verification record. Required to verify the code.

Changes