GET /health and GET /version requires an x-api-key header. Requests and responses use JSON throughout, with the single exception of POST /export, which returns a CSV file.
Base URL
Authentication
Pass your API key in thex-api-key request header on every call that requires authentication.
API version
The current API version is 3.6.0. The version is also available at runtime fromGET /version, which returns the engine version and available endpoints without requiring authentication.
Rate limits
Rate limits are enforced per API key.
When you exceed the limit, the API returns
429 Too Many Requests. See Error codes for the full error schema.
Request format
SetContent-Type: application/json on all requests that include a body. The API rejects requests with a malformed or missing content type.
Endpoints that do not require authentication
The following endpoints are open and do not require anx-api-key header:
Explore the API
Transactions
Process cash transactions with jurisdiction-aware rounding, query transaction history, and manage voids and refunds.
Jurisdiction
Resolve rounding rules by ZIP code, state, county, or city using the 33,000+ ZIP code Census database.
Tipping
Record and pool tips with FLSA-compliant rounding, process payouts, and detect wage theft patterns.
Compliance & Audit
Query immutable audit logs, verify hash chain integrity, and run void and override analytics.