PingOne Platform APIs

User Email Verification

The user email verification endpoint supports operations to verify a user’s email through a verification code.

User email verification data model

Property Type Required Mutable Description

environment.id

String

N/A

Read-only

The environment associated with the user.

user.id

String

N/A

Read-only

The user ID.

notificationType

String

Required

Mutable

Indicates whether the notification is sent to an admin or user.

verificationCode

String

Required

Read-only

The code sent to verify the user’s email. The email verification code is 8 alphanumeric characters with a timeout of 24 hours. These attributes are not configurable.

For more user property descriptions, refer to the Users data model.

User email verification errors

In addition to the general error codes, user email verification operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

REQUEST_FAILED

CONSTRAINT_VIOLATION

Message: The request could not be completed. There was an issue processing the request.

When and details

When: A POST Send Email Verification Code or Verify Email Code request targets a user without an email address, or a Verify Email Code request runs when the verification data is expired or the user’s email changed after the code was sent

Details: The user does not have an email address or User’s email could not be verified

400

REQUEST_FAILED or INVALID_DATA

CONSTRAINT_VIOLATION or INVALID_VALUE

Message: The request could not be completed. There was an issue processing the request.

When and details

When: A POST Send Email Verification Code or Verify Email Code request targets a user whose lifecycle.status is INVITED, or a Send/Resend User Verification Code request targets a user whose lifecycle.status is not valid for the operation

Details: Operation not allowed for users with lifecycle.status INVITED or Invalid lifecycle status: <status>

400

INVALID_DATA

REQUIRED_VALUE

Message: The request is missing a required value.

When and details

When: A POST Send Email Verification Code request includes neither verificationCode nor a magic link

Details: The request must have a verification code and/or a magic link

400

INVALID_DATA

INVALID_VALUE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A POST Verify Email Code request omits verificationCode, or the supplied verification code does not match the code sent to the user’s email or was already used

Details: The provided verification code was invalid with target verificationCode

400

INVALID_REQUEST or INVALID_DATA

INVALID_VALUE or None

Message: The request could not be completed. The request was malformed or invalid. or The request could not be completed. One or more validation errors were in the request.

When and details

When: A request body cannot be deserialized, for example a notificationType value that is not admin or user

Details: For a JSON field conversion error, the detail is Invalid value for attribute. with target = the field path. Otherwise no detail is returned.

403

ACCESS_FAILED

None

Message: The actor attempting to perform the request is not authorized.

When and details

When: The actor lacks the dir:verify:user permission, or the actor is not authorized for the target user’s population or group scope on a Send Email Verification Code request

Details: None.

404

NOT_FOUND

None

Message: The request could not be completed. The requested resource was not found.

When and details

When: The user ID or environment ID in the request URL does not exist

Details: None.

429

REQUEST_LIMITED

None

Message: The request could not be completed. A rate or quota limit was reached. Please try again later.

When and details

When: A Send/Resend User Verification Code request exceeds the verification‑code send rate limit for the user

Details: None.