Skip to main content
POST
/
website
/
{siteId}
/
invite
cURL
curl --request POST \
  --url http://api.everprotec.com/v1/website/{siteId}/invite \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customId": "<string>"
}
'
{
  "inviteId": "<string>",
  "url": "<string>",
  "expires": 123
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
siteId
string<uuid>
required

The ID of the site configuration. This can be found in the url for your website settings

dashboard.everprotec.com/web/settings/your_site_ID_here

Body

application/json

You can add a custom ID to match invites against your internal user or verification session IDs

​
customId
string

Your internal ID for the user or verification session.

Maximum string length: 128

Response

New Invite Response

​
inviteId
string
required

The unique ID for the invite.

​
url
string
required

URL to the verification gateway for this invite.

​
expires
integer<int32>
required

Unix timestamp in seconds for the invite expiration date. This is 24 hours from the creation date.