Skip to main content
GET
/
website
/
{siteId}
/
invite
/
{inviteId}
cURL
curl --request GET \
  --url http://api.everprotec.com/v1/website/{siteId}/invite/{inviteId} \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "inviteId": "<string>",
    "url": "<string>",
    "status": "pending",
    "customId": "<string>"
  }
]

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

inviteId
string
required

The ID of the verification session invite.

Response

Invite Status Response

inviteId
string
required

The unique ID for the invite.

url
string
required

URL to the verification gateway for this invite.

status
enum<string>
required

The status of the invite.

Available options:
pending,
verified,
expired
customId
string | null

The ID that was provided to us by you when creating an invite.