Create password verification record

POST /api/experience/verification/password

Create and verify a new Password verification record. The verification record can only be created if the provided user credentials are correct.

application/json

Body Required

  • identifier object Required

    The unique identifier of the user that will be used to identify the user along with the provided password.

    Additional properties are allowed.

    Hide identifier attributes Show identifier attributes object
    • type string Required

      Values are username, email, or phone.

    • value string Required
  • password string Required

    The user password.

    Minimum length is 1.

Responses

  • 200 application/json

    The Password verification record has been successfully created and verified.

    Hide response attribute Show response attribute object
    • verificationId string Required

      The unique verification ID of the newly created Password verification record. The verificationId is required when verifying the user's identity via the Identification API.
  • 400

    The verification attempts have exceeded the maximum limit.

  • 401

    The user is suspended or banned from the service.

  • 422

    session.invalid_credentials: Either the user is not found or the provided password is incorrect.

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