Aware Public API
Build on Aware.
The Aware Public API is the supported, versioned surface for integrators who want to build on top of the Aware platform - dedicated infrastructure, Bearer JWT auth, stable IDs.
Looking for the APIs for other Rapid products? This site covers the Aware Public API only. For Induct, Contractor, Audit, Incident, and classic Access, get in touch with Rapid Global.
What you can do today
Section titled “What you can do today”The first release covers checkin-related data:
Get a checkin by ID
Look up a single checkin and the breaks recorded on it.
ReadSearch checkins
Filter checkins by site, person, and time range.
WriteCreate a checkin
Check a person in to a site, idempotency-key supported.
WriteEnd a checkin
Cleanly check a person out - completes any open breaks.
WriteStart a break
Start a break on an active checkin.
WriteEnd a break
End the currently active break on a checkin.
The full surface is documented in the API Reference.
Designed for integrators
Section titled “Designed for integrators”IDs and timestamps
One ID space and one ISO-8601 timestamp format used in every URL, request, and response.
One error envelopePredictable error shapes
Every error response shares the same JSON shape with a small fixed set of type
values.
Bearer authentication
Authorization: Bearer … on every protected request, verified against your Aware
integration’s JWKS.
Rate limits
RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset,
Retry-After.
Idempotency-Key on writes
Send the same key twice and we deduplicate. Records expire after 24h.
StableVersioned at /v1
Breaking changes require a new versioned path and a deprecation window. Track everything in the changelog.