Skip to main content
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>",
      "country_code": "1",
      "mobile_number": "<string>",
      "authentication_method": "QR Code"
    }
  ]
}'
[
  {
    "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>",
    "image": "<string>",
    "session_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "last_seen": "2023-11-07T05:31:56Z",
    "onyxplus_id": "<string>",
    "ticket_id": "<string>",
    "status": "pending"
  }
]
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:
  • 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 to use it:
  • 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

ParameterTypeRequiredDescription
event_idstringYesThe unique identifier of the event

​
Query Parameters

ParameterTypeRequiredDescription
onboarding_flow_typestringNoThe level of verification required. Options: “only_auth” (basic facial recognition), “kyc” (full identity verification), “ssn_verification”, “peps_sanctions”, “criminal_check” (advanced security checks)
notifyintegerNoWhether 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"
    }
  ]
}
Authentication methods:
  • 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"
  }
]
Note: After sending invites, you can track their status (pending, sent, accepted, rejected) using the Get Invites endpoint.

Authorizations

​
x-api-key
string
header
required

API key authentication. Add your API key as the value of the 'x-api-key' header.

Path Parameters

​
event_id
string
required

Query Parameters

​
onboarding_flow_type
enum<string>
Available options:
only_auth,
kyc,
ssn_verification,
peps_sanctions,
criminal_check
​
notify
integer | null
default:2

Body

application/json
​
invites
InviteCreate · object[]
required

Response

Successful Response

​
first_name
string
required
​
last_name
string
required
​
email
string
required
​
country_code
enum<string>
required
Available options:
1,
44,
1,
61,
91,
345
​
mobile_number
string
required
​
authentication_method
enum<string>
required
Available options:
QR Code,
Biometric,
Both
​
id
string
required
​
event_id
string
required
​
session_code
string
required
​
session_id
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
image
string | null
​
last_seen
string<date-time> | null
​
onyxplus_id
string | null
​
ticket_id
string | null
​
status
enum<string>
Available options:
pending,
sent,
accepted,
rejected