--- title: Verify User description: The POST {{apiPath}}/v1/environments/{{envID}}/users/{{userID}} operation action verifies the user account. 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.verify+json custom content type in the request header. component: pingone-api page_id: pingone-api:platform:users/users-1/verify-user-1 canonical_url: https://developer.pingidentity.com/pingone-api/platform/users/users-1/verify-user-1.html section_ids: prerequisites: Prerequisites headers: Headers body: Body example-request: Example Request example-response: Example Response --- # Verify User ## ```none POST {{apiPath}}/v1/environments/{{envID}}/users/{{userID}} ``` The `POST {{apiPath}}/v1/environments/{{envID}}/users/{{userID}}` operation action verifies the user account. 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.verify+json` custom content type in the request header. Upon success, the `lifecycle.status` property of the user is set to `ACCOUNT_OK`. Furthermore, if the email address used to request the verification code is the same as the user's email at verification time (and the verification code is valid), then the `emailVerified` property of the user is set to `true`. ### Prerequisites * Refer to [Users](../../users.html) and [User Operations](../users-1.html) for important overview information. * Create a user to get a `userID`. Refer to [Create User](create-user.html). Run [Read User or Users](read-all-users.html) to find an existing user. > **Collapse: Request Model** > > | Property | Type | Required? | > | ------------------ | ------ | --------- | > | `verificationCode` | String | Required | > > Refer to the [User operations](../users-1.html) data model for full property descriptions. ### Headers Authorization      Bearer {{accessToken}} Content-Type      application/vnd.pingidentity.user.verify+json ### Body raw ( application/vnd.pingidentity.user.verify+json ) ```json { "verificationCode": "{{verificationCode}}" } ``` ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}' \ --header 'Content-Type: application/vnd.pingidentity.user.verify+json' \ --header 'Authorization: Bearer {{accessToken}}' \ --data '{ "verificationCode": "{{verificationCode}}" }' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}") { MaxTimeout = -1, }; var client = new RestClient(options); var request = new RestRequest("", Method.Post); request.AddHeader("Content-Type", "application/vnd.pingidentity.user.verify+json"); request.AddHeader("Authorization", "Bearer {{accessToken}}"); var body = @"{" + "\n" + @" ""verificationCode"": ""{{verificationCode}}""" + "\n" + @"}"; request.AddStringBody(body, DataFormat.Json); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}" method := "POST" payload := strings.NewReader(`{ "verificationCode": "{{verificationCode}}" }`) client := &http.Client { } req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("Content-Type", "application/vnd.pingidentity.user.verify+json") req.Header.Add("Authorization", "Bearer {{accessToken}}") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := io.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } ``` ```http POST /v1/environments/{{envID}}/users/{{userID}} HTTP/1.1 Host: {{apiPath}} Content-Type: application/vnd.pingidentity.user.verify+json Authorization: Bearer {{accessToken}} { "verificationCode": "{{verificationCode}}" } ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/vnd.pingidentity.user.verify+json"); RequestBody body = RequestBody.create(mediaType, "{\n \"verificationCode\": \"{{verificationCode}}\"\n}"); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}") .method("POST", body) .addHeader("Content-Type", "application/vnd.pingidentity.user.verify+json") .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/vnd.pingidentity.user.verify+json", "Authorization": "Bearer {{accessToken}}" }, "data": JSON.stringify({ "verificationCode": "{{verificationCode}}" }), }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'POST', 'url': '{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}', 'headers': { 'Content-Type': 'application/vnd.pingidentity.user.verify+json', 'Authorization': 'Bearer {{accessToken}}' }, body: JSON.stringify({ "verificationCode": "{{verificationCode}}" }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests import json url = "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}" payload = json.dumps({ "verificationCode": "{{verificationCode}}" }) headers = { 'Content-Type': 'application/vnd.pingidentity.user.verify+json', 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}'); $request->setMethod(HTTP_Request2::METHOD_POST); $request->setConfig(array( 'follow_redirects' => TRUE )); $request->setHeader(array( 'Content-Type' => 'application/vnd.pingidentity.user.verify+json', 'Authorization' => 'Bearer {{accessToken}}' )); $request->setBody('{\n "verificationCode": "{{verificationCode}}"\n}'); try { $response = $request->send(); if ($response->getStatus() == 200) { echo $response->getBody(); } else { echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . $response->getReasonPhrase(); } } catch(HTTP_Request2_Exception $e) { echo 'Error: ' . $e->getMessage(); } ``` ```ruby require "uri" require "json" require "net/http" url = URI("{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}") http = Net::HTTP.new(url.host, url.port); request = Net::HTTP::Post.new(url) request["Content-Type"] = "application/vnd.pingidentity.user.verify+json" request["Authorization"] = "Bearer {{accessToken}}" request.body = JSON.dump({ "verificationCode": "{{verificationCode}}" }) response = http.request(request) puts response.read_body ``` ```swift let parameters = "{\n \"verificationCode\": \"{{verificationCode}}\"\n}" let postData = parameters.data(using: .utf8) var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}")!,timeoutInterval: Double.infinity) request.addValue("application/vnd.pingidentity.user.verify+json", forHTTPHeaderField: "Content-Type") request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization") request.httpMethod = "POST" request.httpBody = postData let task = URLSession.shared.dataTask(with: request) { data, response, error in guard let data = data else { print(String(describing: error)) return } print(String(data: data, encoding: .utf8)!) } task.resume() ``` ### Example Response 200 OK ```json { "_links": { "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab" }, "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/60971d3b-cc5a-4601-9c44-2be541f91bf1" }, "devices": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices" }, "roleAssignments": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/roleAssignments" }, "password": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/password" }, "password.reset": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/password" }, "password.set": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/password" }, "password.check": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/password" }, "password.recover": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/password" }, "linkedAccounts": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/58177d50-1f2b-4f08-a95c-c618c83c0669/linkedAccounts" }, "account.sendVerificationCode": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab" }, "memberOfGroups": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/memberOfGroups" } }, "id": "8376797d-641c-4e7b-8bc1-2fdf71916cab", "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "account": { "canAuthenticate": true, "status": "OK" }, "createdAt": "2022-10-11T16:54:38.125Z", "email": "user@example.com", "enabled": true, "identityProvider": { "type": "PING_ONE" }, "lastSignOn": { "at": "2022-10-11T17:03:47.696Z", "remoteIp": "54.86.50.139" }, "lifecycle": { "status": "ACCOUNT_OK" }, "mfaEnabled": false, "population": { "id": "60971d3b-cc5a-4601-9c44-2be541f91bf1" }, "updatedAt": "2022-11-16T19:09:24.239Z", "username": "registered-user_1", "verifyStatus": "NOT_INITIATED" } ```