Skip to main content
POST
/
api
/
v1
/
participants

​
Create Participant

Create a new participant in the system.
​
user_id
string
required
Unique identifier for the participant
​
instance_id
string
required
Instance ID the participant belongs to
​
first_name
string
required
Participant first name
​
surname
string
required
Participant surname
​
full_name
string
Full name (auto-generated if not provided)
​
gender
string
Gender: Male, Female, Other
​
date_of_birth
string
Date of birth (YYYY-MM-DD)
​
school_year
string
School year
​
rank
string
Participant rank
​
status
string
Status (default: active)
​
unit_name
string
Unit name
​
school_institute
string
School/institute name
​
arrival_date
string
Arrival date (YYYY-MM-DD)
​
departure_date
string
Departure date (YYYY-MM-DD)
​
super_group_id
string
ID of supergroup
​
sub_group_id
string
ID of subgroup (must belong to supergroup if provided)
​
block_id
string
ID of block
​
room_id
string
ID of room (must belong to block if provided)
​
room_number
string
Room number
​
photo_link
string
Link to participant photo

​
Validation Rules

  • user_id must be unique within the instance
  • If sub_group_id is provided with super_group_id, the subgroup must belong to that supergroup
  • If room_id is provided with block_id, the room must belong to that block
  • All group/block/room IDs must belong to the same instance

​
Example Request

curl -X POST https://api.checkpoint.b-digital.uk/api/v1/participants \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "API_TEST_001",
    "instance_id": "se8SajpJDWUwrEmhElLF",
    "first_name": "API",
    "surname": "TEST",
    "status": "active"
  }'

​
Example Response

{
  "success": true,
  "data": {
    "id": "API_TEST_001",
    "user_id": "API_TEST_001",
    "first_name": "API",
    "surname": "TEST",
    "full_name": "API TEST",
    "status": "active",
    "created_at": "2025-11-03T21:51:25.515Z"
  }
}