Developer Platform // API v1

Build on Arkvos.

The Arkvos API lets safety software, staffing systems, contractor portals, consultants and internal engineering teams connect verified safety briefing records to the systems they already use.

Production API
Organization-scoped

Every API key belongs to exactly one Arkvos customer. There is no cross-tenant access path.

Stable v1 contract

Versioned endpoints, request IDs, standardized errors, cursor pagination and an OpenAPI specification.

Privacy-conscious

Worker selfie blobs, QR secrets, Stripe IDs and other internal credentials are not exposed.

Why Arkvos has an API

Arkvos verifies that a safety briefing happened. The API makes that verification useful outside the Arkvos dashboard. A contractor can push attendance into a data warehouse. A staffing agency can reconcile placed workers against jobsite briefings. A safety consultant can connect multiple client workflows. A software vendor can publish a mandatory briefing from its own system and later retrieve the resulting verification records.

The API is not meant to replace Arkvos. It makes Arkvos the verification layer underneath other systems.

Authentication

Organization Owners and Admins create API keys in Arkvos Settings. Send the key as a Bearer token or with X-API-Key. The plaintext key is shown only once and Arkvos stores its hash.

Keep live API keys on a server. Never place one in public browser JavaScript, a mobile app bundle or a public repository.
Authorization: Bearer ark_live_••••••••••••••••

Quickstart

Verify the connection

curl https://arkvos.com/api/v1/me \ -H "Authorization: Bearer $ARKVOS_API_KEY"

Retrieve verified check-ins

curl "https://arkvos.com/api/v1/checkins?verification_method=verified&limit=50" \ -H "Authorization: Bearer $ARKVOS_API_KEY"

Publish a briefing from another system

curl -X POST https://arkvos.com/api/v1/briefings \ -H "Authorization: Bearer $ARKVOS_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: morning-briefing-2026-08-25" \ -d '{"title":"Morning toolbox talk","content":"Review today’s hazards and controls.","mandatory":true,"publish":true}'

API v1 endpoints

GET/api/v1/me

Authenticated organization and API-key identity.

GET/api/v1/stats

Sites, workers, active briefings, today’s check-ins and acknowledgments.

GET/api/v1/sites

List job sites and geofence configuration. QR tokens are excluded.

GET/api/v1/workers

List workers with employee IDs, status and assigned site.

GET/api/v1/briefings

List safety briefings and their lifecycle.

POST/api/v1/briefings

Create or publish a briefing. Supports idempotency keys.

GET/api/v1/briefing-acknowledgments

Retrieve acknowledgment records for a briefing.

GET/api/v1/checkins

Retrieve verified/manual check-ins with site, time, geofence and subcontractor context.

Pagination, rate limits and errors

List endpoints use cursor pagination with a default of 50 and maximum of 100 records per page. Responses include next_cursor and has_more. API keys receive a production limit of 600 requests per minute, with standard rate-limit headers. Errors use a consistent object containing type, code, message and a request ID for support/debugging.

What can be built with it?

Safety briefing API

Programmatically publish briefings and retrieve verified attendance records.

Toolbox talk API

Connect toolbox-talk evidence to construction, field-service and reporting workflows.

Workforce safety API

Connect workers, sites and verified check-ins to staffing, HR and operations software.

Partner & reseller integrations

Use Arkvos as the verification layer inside a consultant or reseller technology stack.

OpenAPI specification

Machine-readable documentation is available at arkvos.com/api/v1/openapi.json. It can be imported into Postman, Insomnia, API clients, code generators and AI coding tools.