Email address verification

Sends the email to verify user's email address. The email will contain a link to verify the email address.

post

Path parameters

idstringRequired

The user id to send the email.

Query parameters

returnURLstringRequired

The return URL after the user clicks the link in the email.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/users/{id}/email-address/verify/send HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}

Actives the user email address.

put

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Body

application/jsontext/jsonapplication/*+json

This class represents the request data transfer object for activating an email address.

tokenstring · min: 1Required

The token to active the email address. This is the token that was received from the request to send the OTP.

Responses

200

The request was successful.

application/json

400

The email address is already verified.

application/json

429

The user has exceeded the rate limit.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/users/email-address/active HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "token": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}