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 API endpoints

A creator token (Authorization: Bearer cgo_live_…, see OAuth) acts for exactly one creator, through one app, with the scopes she approved. Paths are under https://api.creator-guard.com/v1. Every field, status and error is in the reference. An account API key on these endpoints gets 403 wrong_account_type.

Endpoint Scope What it does
GET /creator/me creator.profile:read Her name, stage, next steps and — once an agency paid for her — that agency
GET /creator/profile, PATCH /creator/profile creator.profile:read / creator.profile:write Her contact fields and the listing fields she edits in the creator portal; never fees, deal terms or the OnlyFans verification flag
POST /creator/submit-for-review creator.profile:write Same rules as for partners: open blockers → 422 not_ready_for_review (fee_missing: her referral partner still has to set the fee)
GET /creator/photos, POST /creator/photos, DELETE /creator/photos/{photo} creator.photos:write Her photos, re-encoded and stripped of metadata on our side; frozen once her listing is live (409 photos_locked)
GET /creator/consent-text creator.profile:read The current text (kind = consent, age_confirmation, creator_terms) to show before she decides
GET /creator/consent creator.profile:read Consent and 18+ state with her ledger entries
POST /creator/consent/grant, POST /creator/consent/revoke creator.consent:write Records her consent (current text version; also her 18+ confirmation, which the consent text includes; 409 invalid_state while her 18+ check is declined or under review) or its withdrawal (never refused)
POST /creator/age-confirmation creator.consent:write Records that she confirms she is 18 or over
GET /creator/agreements, POST /creator/agreements/{type}/accept (type = creator_terms) creator.consent:write Creator terms: current version and her acceptance
GET /creator/support-tickets, POST /creator/support-tickets, GET /creator/support-tickets/{id}/messages, POST /creator/support-tickets/{id}/messages, POST /creator/support-tickets/{id}/close creator.support Her conversations with our team
POST /creator/data-export, GET /creator/data-export/{id} creator.privacy A copy of her data (asynchronous)
POST /creator/deletion-request creator.privacy Asks us to delete her data
GET /creator/connected-apps, DELETE /creator/connected-apps/{app} creator.profile:read / creator.profile:write Your own app's connection only; disconnect your app (any other app id is 404). Her full list of connected apps is shown only to her, in the creator portal
GET /jobs/{id} creator.privacy (for a data export) The status of an asynchronous job

Scopes

What she reads on the consent screen for each scope:

Scope Shown to her
creator.profile:read See your profile, where you stand and which agency you are matched with
creator.profile:write Change your profile and send it to Creator Guard for review
creator.photos:write Upload and delete your photos
creator.consent:write Record your consent decisions: your consent or its withdrawal, your 18+ confirmation and your acceptance of the creator terms — an app of the partner who introduced you can only see and withdraw your consent, never give it
creator.support Read and write your support messages with the Creator Guard team
creator.privacy Send this app a copy of your data, including your support messages, or ask for your data to be deleted

Edit windows

Her contact fields (lead: handle, other contact, platforms, followers, niche) can change while her lead is submitted (409 lead_locked afterwards); listing fields and photos until the listing is live (409 listing_locked, 409 photos_locked). GET /creator/profile tells you with can_edit_lead and can_edit_listing and sends an ETag — send it back as If-Match so you do not overwrite a change she made in the portal (412 precondition_failed).

Not through the referrer's app. If your account submitted her lead (you are her referring partner), POST /creator/consent/grant, POST /creator/age-confirmation and POST /creator/agreements/{type}/accept answer 403 referrer_app_not_allowed through any of your account's apps and record nothing — whatever her current state. She gives consent, confirms 18+ and accepts the creator terms only in Creator Guard's own screens: the consent link (which you can still send) or her creator portal. GET /creator/consent keeps working, and POST /creator/consent/revoke works through any connected app, yours included. Claim links work as before.

Show her the text from GET /creator/consent-text in full and unchanged, then send its version as text_version with her decision. A grant, the 18+ confirmation or the creator terms with an older version are refused with 409 consent_text_outdated and nothing is recorded. Her withdrawal is never refused because of the text version: send the version she saw if you have it, otherwise none. Every decision becomes an entry of her consent ledger with the channel oauth_app:app_…. Ledger entries returned to your app never contain an IP address or browser.

Data export (async)

POST /creator/data-export answers 202 with a job (job_…, Location: /v1/jobs/job_…); GET /v1/jobs/{id} shows its progress. When it succeeded, the job's result.data_request names the export, your account receives the events data_export.ready and job.completed, and GET /creator/data-export/{id} returns a signed download_url (a JSON file). Each call signs a new link that works for 1 hour at most (download_url_expires_at); the file itself is kept until expires_at, 7 days after it was ready — download it right away and ask again for a new link later. The export is bound to your app: only the app that asked for it can read it (and its job); another of her connected apps gets 404 not_found for that id and asks for its own export. Record ids in the file are public ids (lead_…, photo_…, cev_…, tkt_…, dreq_…); apps appear by name. One export per app per 24 hours: asking again returns your app's open or recent job. The file holds what we keep about her that she may see, including her support conversations with us — no fees, deal terms, partner notes, IP addresses or browsers. The consent screen tells her that your app receives this copy. It is not a complete statement of everything we hold about her (Article 15 GDPR); for that she can write to info@creator-guard.com, and we answer her directly.

Deletion

POST /creator/deletion-request creates a task for our team (or returns the open one). When we have carried it out — her personal data, photos, login and grants are deleted, the IP addresses and browsers in her consent records erased — your account receives deletion_request.completed. From then on every token for her stops working; delete her data in your systems too.

Events for your account

The three events above go to the account that owns the app, as webhooks and in GET /v1/events, read with the key scope oauth_apps:manage. They carry only a reference ({"id": "dreq_…", "object": "data_request"} or {"id": "job_…", "object": "job"}), never her data: fetch the details with her token. See Events.

Only on our hosted pages

Her password, email address and sign-in change only on our hosted pages (claim page, creator portal, password reset), never through the API.