Create new password identity verification

POST /api/experience/verification/new-password-identity

Create a NewPasswordIdentity verification record for the new user registration use. The verification record includes a unique user identifier and a password that can be used to create a new user account.

application/json

Body Required

  • identifier object Required

    The unique user identifier.
    Currently, only username is accepted. For email or phone registration, a CodeVerification record must be created and used to verify the user's email or phone number identifier.

    Additional properties are allowed.

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

      Format should match the following pattern: /^[A-Z_a-z]\w*$/.

  • password string Required

    The new user password. (A password digest will be created and stored securely in the verification record.)

Responses

  • 200 application/json

    The NewPasswordIdentity verification record has been successfully created.

    Hide response attribute Show response attribute object
    • verificationId string Required

      The unique verification ID of the newly created NewPasswordIdentity verification record. The verificationId is required when creating a new user account via the Identification API.
  • 400

    Bad Request

  • 422

    Unable to process the request.
    - user.username_already_in_use: The provided username is already in use.
    - password.rejected: The provided password is rejected by the password policy. Detailed password violation information is included in the response.

POST /api/experience/verification/new-password-identity 
curl \
 -X POST https://[tenant_id].logto.app/api/experience/verification/new-password-identity \
 -H "Content-Type: application/json" \
 -d '{"identifier":{"type":"string","value":"string"},"password":"string"}'
Request examples 
{
  "identifier": {
    "type": "string",
    "value": "string"
  },
  "password": "string"
}
Response examples (200) 
{
  "verificationId": "string"
}