Verify New User

GET /users/verify_email

Verify new user profile.

Roles

Users with the following roles may access this endoint:

Public

Breaking Changes

No breaking changes.

Request

Sample Request

GET /users/verify_email/token=eyJzdWIiOiAidGVzdF9uZXdfdXNlckBjcm9zb2Z0d2FyZS5uZXQiLCAiZXhwIjogIjIwMjItMDgtMjBUMDI6NDY6MzIuMTU0Njk5IiwgInNpZyI6ICI3ZDdhNWZlYjRmYjI2YWZhMDdkZmY3Y2UyYjEzMTY2MjE5NTI0MDg5In0%3D
Content-Type: application/json
x-tenant-id: {your-tenant-id}

Sample Response

Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: GET
Access-Control-Allow-Origin: *
Allow: GET
Content-Length: 16
Content-Type: text/plain
Date: Sat, 20 Aug 2022 01:46:32 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: 0919bc41-ed3c-4086-8ddb-32ca946041ce

Account verified

Path Parameters

note

No path parameters.

Query Parameters

token String, Required

Email verification token.

• Matches ^\s[a-zA-Z0-9\/+=]{11,270}\s$
• Base64 encoded string.

Request Headers

Refer to StandardPublicRequestHeadersModel for more details.

x-api-version String, Optional

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

Request Body

note

No request body

Response

Response Headers

Refer to StandardResponseHeadersModel for more details.

x-api-version String

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

x-request-id String

Request identifier.

• Valid UUID.

Response Body

Refer to email.verify.response_msg for more details.

Code Samples

cURL

curl --request GET --include \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
127.0.0.1:8003/users/verify_email?token=eyJzdWIiOiAidGVzdF9uZXdfdXNlckBjcm9zb2Z0d2FyZS5uZXQiLCAiZXhwIjogIjIwMjItMDgtMjBUMDI6NDY6MzIuMTU0Njk5IiwgInNpZyI6ICI3ZDdhNWZlYjRmYjI2YWZhMDdkZmY3Y2UyYjEzMTY2MjE5NTI0MDg5In0%3D

Python

import requests, json

response = requests.get(
  'http://localhost:8003/users/verify_email',
  headers={
    'Content-Type': 'application/json',
    'x-tenant-id': '{your-tenant-id}'
  },
  parameters={
    'token': 'eyJzdWIiOiAidGVzdF9uZXdfdXNlckBjcm9zb2Z0d2FyZS5uZXQiLCAiZXhwIjogIjIwMjItMDgtMjBUMDI6NDY6MzIuMTU0Njk5IiwgInNpZyI6ICI3ZDdhNWZlYjRmYjI2YWZhMDdkZmY3Y2UyYjEzMTY2MjE5NTI0MDg5In0='
  }
)
results = json.loads(response.text)
print(results)

CSharp 2.0

using System;
using System.Net;
using System.Collections.Specialized;

namespace CROSoftware
{
public class DemoClient
{
    static public void Main ()
    {
        WebClient client = new WebClient();

        // URL    
        String url = "/users/verify_email?token=eyJzdWIiOiAidGVzdF9uZXdfdXNlckBjcm9zb2Z0d2FyZS5uZXQiLCAiZXhwIjogIjIwMjItMDgtMjBUMDI6NDY6MzIuMTU0Njk5IiwgInNpZyI6ICI3ZDdhNWZlYjRmYjI2YWZhMDdkZmY3Y2UyYjEzMTY2MjE5NTI0MDg5In0%3D";

        // Headers
        client.Headers.Add("Content-Type", "application/json");
        client.Headers.Add("x-tenant-id", "{your-tenant-id}");

        string json = client.DownloadString(url);
        Console.WriteLine(json);
    }
}
}