Skip to main content

​
Step 1: Get Your API Key

First, you need an API key. Contact your administrator or use the API key generation endpoint.

Generate API Key

Learn how to generate your API key

​
Step 2: Make Your First Request

Let’s start with a simple health check: 
curl https://api.checkpoint.b-digital.uk/health
You should see: 
{
  "success": true,
  "message": "PostgreSQL API is running",
  "database": "connected"
}

​
Step 3: List Participants

Now let’s get some data: 
curl -X GET https://api.checkpoint.b-digital.uk/api/v1/participants \
  -H "X-API-Key: YOUR_API_KEY"

​
Step 4: Create a Participant

Create your first participant: 
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": "TEST_001",
    "instance_id": "YOUR_INSTANCE_ID",
    "first_name": "John",
    "surname": "Doe",
    "status": "active"
  }'

​
Next Steps

API Reference

Explore all available endpoints

Validation Rules

Learn about validation and relationships