Email Verification

Verify Email

POST

/email/verify

The link received within the verificaiton email will contain all the necessary parameters, and it will look like the following:

https://yourwebsite.com/email/verify/15/ac14cef669aeedce35f801c882f068892918642e?expires=1584995553&signature=7de313979ffd7eb7a003bf16e1d96af1f4cbc3428b53eba22716973125afd11a

If you want to verify the email address from the api, you can get the parameters from the received link and send them to this API endpoint.

Parameters

Parameter	Type	Required	Description
id	Number	Yes	The ID of the user who is verifying the email. Part of the verify email link.
hash	String	Yes	The email hash. Part of the verify email link.
expires	Number	Yes	Timestamp which represents when the email verification link will expire. Available as a query parameter in the email verification link.
signature	String	Yes	Link signature available as a query parameter in the email verification link.

Example Request

curl --location --request POST 'https://yourwebsite.com/api/email/verify' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {api_key}' \
--header 'Authorization: Bearer {api_key}' \
--data-raw '{
  "id": 15,
  "hash": "ac14cef669aeedce35f801c882f068892918642e",
  "expires": 1584995553,
  "signature": "7de313979ffd7eb7a003bf16e1d96af1f4cbc3428b53eba22716973125afd11a"
}'

Example Response

Status: 200 OK

{
    "success": true
}

Resend Email

POST

/email/resend

Example Request

curl --location --request POST 'https://yourwebsite.com/api/email/resend' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {api_key}' \
--header 'Authorization: Bearer {api_key}'

Example Response

Status: 202 Accepted

{
    "success": true
}