Beta — the platform and this API are in beta. The rules on this page are binding; we may add features and tighten validation without notice.

Creator Guard Platform API

Everything the partner portal does with a creator, from your own system: submit her, complete her listing, send her the consent link, submit her for review and follow her stage and your earnings.

BASEhttps://api.creator-guard.com/v1

What you need

  • A partner account with Creator Guard. Access is by invitation: how to become a partner.
  • Accepted partner terms (in the portal, or with POST /v1/agreements/{type}/accept).
  • An API key (cg_live_…, or cg_test_… for the sandbox), created in the portal under Settings → API. See API keys.
  • A server-side process that sends HTTPS requests. The key must never reach a browser or an app you ship.

How it works

  1. You create a lead with POST /v1/leads; we check whether we already know her and answer with her lead (lead_…) and creator number (CR-1047).
  2. You complete her listing, send her the consent link and submit her for review once next_actions.can_submit_for_review is true.
  3. You follow her stage, timeline and earnings with GET requests, or let webhooks tell you about every change. See Lead lifecycle.

The rules are the portal's rules, enforced by Creator Guard for every caller: the API and the portal can never disagree about what is allowed. Every lead tells you in next_actions what you can do with it right now.

Conventions

  • JSON in and out, UTF-8, at most 1 MB per request body. Times are RFC 3339 in UTC. Money is {"amount_minor": 150000, "currency": "USD"}.
  • Ids are prefixed (lead_…, acct_…, req_…). Treat them as opaque strings.
  • Unknown request fields are rejected with 400 unknown_field, unknown query parameters with 400 unknown_parameter. Ignore response fields you do not know.
  • Every response carries X-Request-Id and X-API-Version. Quote the request id when you contact support.
  • Retries are safe with Idempotency-Key; changes are race-safe with If-Match.

Machine-readable spec

The full contract is published as OpenAPI 3.1 at /openapi.yaml. Import it into Postman, Insomnia or a code generator.