AuditCakeDevelopersBook a walkthrough

AuditCake API

The AuditCake API integrates premium audits into existing carrier and vendor systems. Audits created via the API run as production work inside AuditCake; the same endpoints read their status and update or cancel them as things change.

The AuditCake API is organized around a small set of REST-style endpoints that accept and return JSON. This guide starts with the first thing every integration needs: creating an audit.

Base URL

All API requests go to:

https://auditcake.com/api/v1

Authentication

Every request is authenticated with an API key, sent in the x-api-key header. The key both authenticates the request and identifies the caller — either a carrier or a vendor servicing a specific carrier — and a request can only ever touch audits inside that scope. See Carriers & vendors for the integration modes the API supports.

curl https://auditcake.com/api/v1/audits \
  -H "x-api-key: ack_live_<api-key>" \
  -H "Content-Type: application/json" \
  -d '{ ... }'
Where do I get a key? Every API key is issued by AuditCake. Carrier admins find their carrier key under Settings → Developer. Vendor keys are issued per relationship — one per (carrier, vendor) pair — and shared with the vendor at relationship setup. Every key is shown once at creation; AuditCake stores only a hash and cannot display it again, so store it somewhere safe. If a key is lost, ask AuditCake to rotate it.

Keep the key server-side

Treat the API key like a password. Use it only from server-side systems — never embed it in a browser, a mobile app, or anything a third party can read. AuditCake rotates keys on request whenever a new one is needed.

Errors

AuditCake uses conventional HTTP status codes. 2xx means success; 4xx means the request was rejected and the JSON body explains why; 5xx means something went wrong on AuditCake's side. Each endpoint page lists its specific codes.

Next: Carriers & vendors →