Verify Email (Code)
POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification
The POST /environment/{{envID}}/users/{{userID}}/emailVerification operation verifies a user's email using a verification code. The request body requires the verificationCode attribute identifying the verification code sent to the user's email address to check the account. This operation uses the application/vnd.pingidentity.user.emailVerification.verify+json custom content type in the request header. After the request completes successfully, the emailVerified property is set to true.
Prerequisites
- See Users for important overview information.
Request Body
{"verificationCode"=>"{{verificationCode}}"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"population":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/c368d0c4-1b61-4774-9cf8-4c73279e532a"},"devices":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/devices"},"roleAssignments":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/roleAssignments"},"password":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/password"},"password.reset":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/password"},"password.set":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/password"},"password.check":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/password"},"password.recover":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/password"},"linkedAccounts":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/linkedAccounts"},"account.sendVerificationCode":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d"},"memberOfGroups":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/memberOfGroups"}},"enabled":true,"identityProvider":{"type":"PING_ONE"},"population":{"id":"c368d0c4-1b61-4774-9cf8-4c73279e532a"},"lifecycle":{"status":"ACCOUNT_OK"},"createdAt":"2022-12-02T19:57:03.987Z","emailVerified":true,"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"verifyStatus":"NOT_INITIATED","emailVerifiedAt":"2022-12-02T19:58:14.277Z","mfaEnabled":false,"id":"3b999aa3-9ce1-44b3-a75a-b9895132920d","account":{"canAuthenticate":true,"status":"OK"},"email":"do-not-reply@pingidentity.com","updatedAt":"2022-12-02T19:58:14.279Z","username":"User"}