Create Email Verification

v1.0.0

Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the userId and secret arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the userId and secret parameters. Learn more about how to . The verification link sent to the user's email address is valid for 7 days.

Please note that in order to avoid a , the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.

Input

{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API."
    }
  }
}

Output

{
  "type": "object",
  "description": "Token",
  "required": [
    "$id",
    "expire",
    "secret",
    "userId"
  ],
  "properties": {
    "$id": {
      "type": "string",
      "description": "Token ID."
    },
    "expire": {
      "type": "integer",
      "format": "int32",
      "description": "Token expiration date in Unix timestamp."
    },
    "secret": {
      "type": "string",
      "description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload."
    },
    "userId": {
      "type": "string",
      "description": "User ID."
    }
  }
}