Create an access scan
Credentials module
POST/access-scansaccessScans.create
A credential scan at an access point, validated against the Access Grid. Creates an access scan. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability credentials.scan.write.
- OAuth scopes: credentials.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: AccessScanCreate
| Field | Type | Required | Description |
|---|---|---|---|
| zone_id | string (uuid) | Yes | Identifier of the zone. |
| credential_id | string (uuid) | Yes | Identifier of the credential. |
| device_scanned_at | string (date-time) | null | No | When the device scanned, for a scan made offline. |
| offline_result | "Granted" | "Denied" | null | No | What the device decided offline. |
{
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"credential_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"device_scanned_at": "2026-10-08T14:30:00Z",
"offline_result": "Granted"
}Response 201: AccessScan
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the access scan. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| zone_id | string (uuid) | Yes | Identifier of the zone. |
| credential_id | string (uuid) | Yes | Identifier of the credential. |
| scanned_at | string (date-time) | Yes | When the scan happened. |
| result | "Granted" | "Denied" | Yes | The database's decision for the scan. |
| project_id | string (uuid) | Yes | Identifier of the project of the credential, copied from it. |
| device_scanned_at | string (date-time) | null | Yes | When the device scanned, for a scan made offline. |
| offline_result | "Granted" | "Denied" | null | Yes | What the device decided offline. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"credential_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"scanned_at": "2026-10-08T14:30:00Z",
"result": "Granted",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"device_scanned_at": "2026-10-08T14:30:00Z",
"offline_result": "Granted"
}Code samples
curl -X POST "$XOS_BASE_URL/access-scans" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","credential_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","device_scanned_at":"2026-10-08T14:30:00Z","offline_result":"Granted"}'const { data } = await xos.accessScans.create({
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"credential_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"device_scanned_at": "2026-10-08T14:30:00Z",
"offline_result": "Granted"
});response = xos.access_scans.create({"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "credential_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "device_scanned_at": "2026-10-08T14:30:00Z", "offline_result": "Granted"})xos access-scans create --data '{"zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","credential_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","device_scanned_at":"2026-10-08T14:30:00Z","offline_result":"Granted"}'