Skip to main content

Partner API Overview

The Partner API is a small REST surface that lets your backend book, track, cancel, and rate on-demand Guardian jobs on behalf of your end users. It's OpenAPI-described, JWT-authenticated, and paired with signed webhook callbacks so you don't have to poll.

Mental model​

Three actors, two channels:

Two things to notice:

  1. Callbacks do the heavy lifting. Polling /jobs/{id}/status is available for backfill and UI refreshes, but you should drive your UX off the signed webhooks.
  2. Scope. You can only see jobs your partner created. Cross-partner access is not a thing.

What you get​

  • JWT auth. Exchange partner key + secret for a 15-minute access token. Refresh tokens last 7 days.
  • Job CRUD. Create, read, patch, cancel, review.
  • Real-time signed webhooks. HMAC-SHA256 over the raw body, sent via X-Signature. See Callbacks.
  • OpenAPI spec. Browse and test endpoints interactively in the demo Swagger UI (link below).

Try it now​

Next​

  • Workflow — the states a job moves through, and which events trigger each callback.
  • API reference — every endpoint, with copy-pasteable curl examples.
  • Callbacks — payload shapes and HMAC verification recipes in Node and Python.