Attendee registration API

Pricing and how the API is enabled

The API is not open by default: the QRACCESS team switches it on for your account. The integration setup is quoted case by case — ask for a quote telling us which system you want to connect.

Each attendee created through the API consumes attendee credit from your balance, exactly like one added from the dashboard — the price per attendee is the same either way. If the balance runs out, the API returns a clear error and does not create the record. And if you only need a one-off load rather than a live integration, importing attendees from a spreadsheet may be all it takes — no API involved.

Creating an attendee

POST {YOUR_DOMAIN}/api/v1/insert-assistant

curl -X POST "https://control.qraccess.com/api/v1/insert-assistant" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "client_uuid": "order-8842",
        "send_email": true,
        "send_sms": true,
        "data": {
          "Name": "Emily Carter",
          "Email": "emily@example.com",
          "Phone": "+447700900123"
        }
      }'

The same example in PHP

<?php

$apiKey = 'YOUR_API_KEY';
$url    = 'https://control.qraccess.com/api/v1/insert-assistant';

$payload = [
    // Your own identifier for the operation: repeating the call with
    // the same value will not create a duplicate attendee.
    'client_uuid' => 'order-8842',
    'send_email'  => true,
    'send_sms'    => true,
    'data' => [
        'Name'  => 'Emily Carter',
        'Email' => 'emily@example.com',
        'Phone' => '+447700900123',
    ],
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'X-Api-Key: ' . $apiKey,
        'Content-Type: application/json',
        'Accept: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    CURLOPT_TIMEOUT    => 30,
]);

$body   = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$res = json_decode($body, true);

if ($status === 200 && ($res['success'] ?? false)) {
    // Store the qr_code: it is the code validated at the door.
    $qr = $res['data']['qr_code'];
    // Deliveries are reported separately: the attendee is created
    // even if a delivery fails.
    $emailOk = $res['data']['email_sent'] ?? null;
    $smsOk   = $res['data']['sms_sent'] ?? null;
} elseif ($status === 429) {
    // Rate limited: retry later (with the SAME client_uuid).
} else {
    // 401 bad key, 403 IP not allowed, 422 invalid data or no
    // attendee credit left.
    error_log('QRACCESS ' . $status . ': ' . $body);
}

Parameters

Field	Type	Required	Description
data	object	Yes	One value for every active field of the group. The key of each value is the field label exactly as it reads in the dashboard.
client_uuid	string (≤64)	No	Your identifier for the operation. Repeating the call with the same value returns the attendee already created instead of duplicating it. Strongly recommended.
send_email	boolean	No	Emails the badge to the attendee's address.
send_sms	boolean	No	Sends the badge by SMS to the attendee's phone.
attach_pkpass	boolean	No	Attaches the Apple Wallet pass to the email (requires Wallet to be configured).
language	string	No	es, en or fr. Defaults to the group's language.

Important: data must include all the active fields of the group, not just the required ones. Any extra or missing field makes the response a 422. If you add a new field to the group, update your integration as well.

Successful response

{
  "success": true,
  "message": "Attendee created successfully",
  "data": {
    "id": "…",
    "qr_code": "A1B2C3D4E5",
    "group_id": "…",
    "created_at": "2026-08-04T10:15:00.000000Z",
    "email_sent": true,
    "sms_sent": true
  }
}

The qr_code is the code that will be validated at the door. Store it if you want to link the attendee back to your own system.

Integrations

Want to connect your system to QRACCESS?

Tell us what you need to integrate and we will send you a setup quote along with test credentials.