Update User Verification Status (deprecated)
PUT {{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyStatus
Update the verification status of the specified user with the PUT {{apiPath}}/environments/{{envID}}/users/{{userID}}/verifyStatus
request.
Deprecation notice: PingOne Verify no longer reads or uses verifyStatus
on the user. This request is deprecated and will be removed February 2025.
The status can be set to: NOT_INITIATED
(the initial value), ENABLED
, or DISABLED
. If the user verification status is DISABLED
, a new verification transaction record cannot be created for that user until the status is changed to ENABLED
.
Prerequisites
- See PingOne Verify and Verify Status for important overview information.
See the Verify status data model data model for full property descriptions.
Property | Type | Required? |
---|---|---|
verifyStatus | String | Required |
Request Body
{"verifyStatus"=>"ENABLED"}
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461/verifyStatus"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461"}},"verifyStatus":"ENABLED"}