GuardPulse Scans REST API

v1.0 (Live)

Production HTTP REST endpoints for mobile companions, handheld barcode scanners, patrol robots, and security dispatchers.

Return to Dashboard

POST/api/v1/scans

Content-Type: application/json

Submits a physical checkpoint verification scan. Validates security codes and confirms the guard GPS location against the checkpoint's registered coordinates.

Request JSON Payload:

Live HTTP Response:

Click "Send Live Test Request" to test endpoint live...

POST/api/v1/scans/batch

Offline Recovery Sync

Used by the mobile patrol app when regaining cell reception or Wi-Fi after working in basements, elevators, or remote areas. Ingests multiple offline scans in a single transaction.

// Request Body:
{
  "scans": [
    {
      "tenantId": "tenant_apex_logistics",
      "facilityId": "fac_chicago_04",
      "checkpointId": "cp_02",
      "guardId": "usr_marcus",
      "gps": { "lat": 41.9748, "lng": -87.9070, "accuracy": 2.1 },
      "scannedAt": "2026-09-09T20:12:00Z"
    },
    {
      "tenantId": "tenant_apex_logistics",
      "facilityId": "fac_chicago_04",
      "checkpointId": "cp_04",
      "guardId": "usr_marcus",
      "gps": { "lat": 41.9739, "lng": -87.9065, "accuracy": 2.4 },
      "scannedAt": "2026-09-09T20:14:00Z"
    }
  ]
}

GET/api/v1/scans?limit=50&checkpointId=cp_01

Audit & Log Retrieval

Query recent physical scan records. Supports filtering by tenantId, facilityId, and checkpointId.