Getting Started

Head to the registration page and create your free Apertur account.

1. Enter your email address and choose a secure password.
2. Verify your email address by clicking the link we send you.
3. Complete your profile with your name and company (optional).
4. You're in! You'll land on your dashboard.

Projects let you organise upload sessions, API keys, and destinations under one roof. You can create separate projects for different apps or environments.

1. From your dashboard, click New Project.
2. Give your project a descriptive name (e.g. "Insurance Claims App").
3. Optionally add a description to help your team identify it later.
4. Click Create Project to finish.

You can create as many projects as your plan allows. Each project has its own set of API keys and usage quotas.

API keys authenticate your server-side requests to the Apertur API. Each key is scoped to a single project.

1. Open your project and navigate to Settings > API Keys.
2. Select the environment: <codeTest/> for development or <codeLive/> for production.
3. Give the key a label so you can identify it later.
4. Click Generate Key. Your key will be displayed once — copy it now.

Keys follow the format <code/> — the prefix indicates the environment. See the authentication docs for details.

An upload session generates a unique QR code that end-users scan to upload photos directly from their mobile device.

curl -X POST https://api.apertur.ca/v1/sessions \
  -H "Authorization: Bearer aptr_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "delivery_mode": "webhook",
    "webhook_url": "https://your-app.com/webhook",
    "max_images": 5,
    "tags": { "user_id": "usr_123" }
  }'

{
  "id": "sess_01HX...",
  "qr_url": "https://apertur.ca/u/sess_01HX...",
  "status": "pending",
  "max_images": 5,
  "expires_at": "2026-04-03T14:00:00Z"
}

The <code/> in the response is the link your end-users will open. You can embed it in a QR code, send it via SMS, or display it directly in your app.

Now let's make sure everything works end to end.

1. Generate a QR code from the <codeQrUrl/> value (use any QR library, or the <codeQrcode/> npm package).
2. Scan the QR code with your phone's camera.
3. You'll be taken to the Apertur upload page — tap to take or select a photo.
4. Upload the photo. The session status will change to active.
5. Once all photos are uploaded (or the session expires), the status changes to completed and your webhook receives the payload.