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

returnURLstring · uriRequired

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

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

databooleanOptional

404

The user was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/users/{id}/email-address/verify/send

HTTPcURLJavaScriptPython

POST /api/v1/users/{id}/email-address/verify/send?returnURL=https%3A%2F%2Fexample.com 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

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

databooleanOptional

400

The email address is already verified.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

put

/api/v1/users/email-address/active

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": []
}