Create Invites
curl --request POST \
--url https://api.securegate.ai/events/{event_id}/invites \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"invites": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"mobile_number": "<string>"
}
]
}
'import requests
url = "https://api.securegate.ai/events/{event_id}/invites"
payload = { "invites": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"mobile_number": "<string>"
}
] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invites: [
{
first_name: '<string>',
last_name: '<string>',
email: '<string>',
mobile_number: '<string>'
}
]
})
};
fetch('https://api.securegate.ai/events/{event_id}/invites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.securegate.ai/events/{event_id}/invites",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'invites' => [
[
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'mobile_number' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.securegate.ai/events/{event_id}/invites"
payload := strings.NewReader("{\n \"invites\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile_number\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.securegate.ai/events/{event_id}/invites")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invites\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile_number\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.securegate.ai/events/{event_id}/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invites\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile_number\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"country_code": "1",
"mobile_number": "<string>",
"authentication_method": "QR Code",
"id": "<string>",
"event_id": "<string>",
"session_code": "<string>",
"session_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"image": "<string>",
"last_seen": "2023-11-07T05:31:56Z",
"onyxplus_id": "<string>",
"ticket_id": "<string>",
"status": "pending"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Invite Management
Create Invites
Create a batch of invites for an event
POST
/
events
/
{event_id}
/
invites
Create Invites
curl --request POST \
--url https://api.securegate.ai/events/{event_id}/invites \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"invites": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"mobile_number": "<string>"
}
]
}
'import requests
url = "https://api.securegate.ai/events/{event_id}/invites"
payload = { "invites": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"mobile_number": "<string>"
}
] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
invites: [
{
first_name: '<string>',
last_name: '<string>',
email: '<string>',
mobile_number: '<string>'
}
]
})
};
fetch('https://api.securegate.ai/events/{event_id}/invites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.securegate.ai/events/{event_id}/invites",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'invites' => [
[
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'mobile_number' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.securegate.ai/events/{event_id}/invites"
payload := strings.NewReader("{\n \"invites\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile_number\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.securegate.ai/events/{event_id}/invites")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"invites\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile_number\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.securegate.ai/events/{event_id}/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invites\": [\n {\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile_number\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"country_code": "1",
"mobile_number": "<string>",
"authentication_method": "QR Code",
"id": "<string>",
"event_id": "<string>",
"session_code": "<string>",
"session_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"image": "<string>",
"last_seen": "2023-11-07T05:31:56Z",
"onyxplus_id": "<string>",
"ticket_id": "<string>",
"status": "pending"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}This endpoint sends invitations to people for your event. Unlike public events, Securegate focuses on controlled access - only invited and verified attendees can enter your event.
What it does:
Authentication methods:
Note: After sending invites, you can track their status (pending, sent, accepted, rejected) using the Get Invites endpoint.
- Sends invitations to multiple people at once
- Generates unique invitation codes for each person
- Sets up the identity verification process for attendees
- Allows you to customize the security level required (simple authentication or full KYC)
- When you’ve created an event and are ready to invite attendees
- To send secure invitations that require identity verification
- When planning events with restricted access requirements
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
event_id | string | Yes | The unique identifier of the event |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
onboarding_flow_type | string | No | The level of verification required. Options: “only_auth” (basic facial recognition), “kyc” (full identity verification), “ssn_verification”, “peps_sanctions”, “criminal_check” (advanced security checks) |
notify | integer | No | Whether to send email notifications automatically. Defaults to 2 |
Request Body
The request body should include an array of invite objects:{
"invites": [
{
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"country_code": "1",
"mobile_number": "5551234567",
"authentication_method": "QR Code"
},
{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"country_code": "1",
"mobile_number": "5559876543",
"authentication_method": "Biometric"
}
]
}
QR Code: Attendees will verify with a QR code (simpler)Biometric: Attendees will verify with facial recognition (more secure)Both: Attendees will need both QR and facial recognition (highest security)
Response
The API returns an array of created invite objects with all their details, including generated invite IDs:[
{
"id": "invite-123",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"country_code": "1",
"mobile_number": "5551234567",
"authentication_method": "QR Code",
"event_id": "event-456",
"session_code": "ABC123",
"session_id": "session-789",
"status": "pending",
"created_at": "2023-02-28T12:00:00Z",
"updated_at": "2023-02-28T12:00:00Z"
},
{
"id": "invite-124",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane.smith@example.com",
"country_code": "1",
"mobile_number": "5559876543",
"authentication_method": "Biometric",
"event_id": "event-456",
"session_code": "DEF456",
"session_id": "session-790",
"status": "pending",
"created_at": "2023-02-28T12:01:00Z",
"updated_at": "2023-02-28T12:01:00Z"
}
]
Authorizations
API key authentication. Add your API key as the value of the 'x-api-key' header.
Path Parameters
Query Parameters
Available options:
only_auth, kyc, ssn_verification, peps_sanctions, criminal_check Body
application/json
Show child attributes
Show child attributes
Response
Successful Response
Available options:
1, 44, 1, 61, 91, 345 Available options:
QR Code, Biometric, Both Available options:
pending, sent, accepted, rejected 