Skip to content
bucker

API reference

consent

3 operations. Shapes are sketches of the declared schemas, bounded in depth — the authoritative document is linked from the index.

Requires bearerAuth

The consent posture of a project, the last recorded exempt-mode checker run, who last changed the posture and why, and the basis every stored item rests on over the window. Behind the analytics gate.

Parameters

Parameters for GET /orgs/{orgSlug}/projects/{projectSlug}/consent
NameInTypeNotes
orgSlugrequiredpathstringmin length 1
projectSlugrequiredpathstringmin length 1
daysqueryintegerdefault 7, min 1, max 90

Response 200

{
  projectId: string
  posture: {
    posture: "everywhere" | "eu_uk" | "none" | "exempt_audience"
    profile: string | null
    replayConsentScope: "granted" | "any" | "none" | null
    stored: boolean
    checkerVersion: string | null
    checkerDigest: string | null
    setByPrincipalId: string | null
    confirmedByPrincipalId: string | null
    at: string | null
  }
  checker: {
    lastRun: {
      profile: string
      version: string
      digest: string
      passed: boolean
      unmet: string[]
      ranAt: string
    } | null
    fresh: boolean
    matchesStoredPosture: boolean
    limits: string
  }
  lastChange: {
    at: string
    byPrincipalId: string
    direction: string | null
    reason: string | null
  } | null
  basisMix: {
    window: {
      from: string
      to: string
    }
    total: integer
    byBasis: {
      basis: string
      count: integer
      share: number
    }[]
    gpc: {
      count: integer
      share: number
    }
    refused: {
      count: integer
      share: number
    }
  }
  generatedAt: string
}

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Request

curl https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/consent \
  -H "authorization: Bearer $BUCKER_TOKEN"

POST/orgs/{orgSlug}/projects/{projectSlug}/consent/checker/run

Requires bearerAuth

Run one jurisdiction profile of the exempt-mode checker over the live configuration and record the run. It changes no setting; a passing run under 24 hours old is what lets an exempt posture be saved. It reports each condition and never concludes that a notice to visitors can be left out.

Parameters

Parameters for POST /orgs/{orgSlug}/projects/{projectSlug}/consent/checker/run
NameInTypeNotes
orgSlugrequiredpathstringmin length 1
projectSlugrequiredpathstringmin length 1

Request body (required) · application/json

{
  profile: "eu_eprivacy_audience_measurement" | "uk_pecr" | "fr_cnil" | "es_aepd" | "de_ttdsg"
}

Response 200

{
  version: string
  profile: {
    id: string
    label: string
    jurisdiction: string
    basisOfRules: string
  }
  projectId: string
  ranAt: string
  passed: boolean
  conditions: {
    id: "jurisdiction_recognises_exemption" | "no_cross_site_identifier" | "identity_mode" | "ip_not_retained" | "aggregation_grain" | "no_replay_or_individual_capture" | "objection_honoured" | "counter_retention" | … 2 more
    label: string
    status: "pass" | "fail"
    evidence: string
    observed: Record<string, string | number | boolean | null>
  }[]
  unmet: string[]
  digest: string
  limits: string
}

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Request

curl -X POST https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/consent/checker/run \
  -H "authorization: Bearer $BUCKER_TOKEN" \
  -H 'content-type: application/json' \
  -d '{ … }'

Requires bearerAuth

Set the consent posture (CRITICAL, human-only). A person on their own session only. A tightening applies with its step-up; a loosening waits for a second owner and the 24-hour hold (202). An exempt posture needs a passing recorded checker run.

Parameters

Parameters for PUT /orgs/{orgSlug}/projects/{projectSlug}/consent/posture
NameInTypeNotes
orgSlugrequiredpathstringmin length 1
projectSlugrequiredpathstringmin length 1

Request body (required) · application/json

{
  posture: "everywhere" | "eu_uk" | "none" | "exempt_audience"
  profile?: string
  replayConsentScope?: "granted" | "any" | "none" | null
  reason: string
  stepUp?: {
    kind: "webauthn"
    nonce: string
    assertion: {
      credentialId: string
      clientDataJSON: string
      authenticatorData: string
      signature: string
    }
  } | {
    kind: "totp"
    code: string
  }
  channel?: "dashboard" | "api" | "mcp" | "slack" | "push" | "chat" | "email"
}

Response 200

{
  status: "applied" | "unchanged" | "held" | "step_up_required"
  direction: "loosen" | "tighten" | "none"
  posture: {
    posture: "everywhere" | "eu_uk" | "none" | "exempt_audience"
    profile: string | null
    replayConsentScope: "granted" | "any" | "none" | null
    stored: boolean
    checkerVersion: string | null
    checkerDigest: string | null
    setByPrincipalId: string | null
    confirmedByPrincipalId: string | null
    at: string | null
  }
  operationId: string | null
  requestId: string | null
  holdUntil: string | null
  independentVotesNeeded: integer | null
}

Response 202

{
  status: "applied" | "unchanged" | "held" | "step_up_required"
  direction: "loosen" | "tighten" | "none"
  posture: {
    posture: "everywhere" | "eu_uk" | "none" | "exempt_audience"
    profile: string | null
    replayConsentScope: "granted" | "any" | "none" | null
    stored: boolean
    checkerVersion: string | null
    checkerDigest: string | null
    setByPrincipalId: string | null
    confirmedByPrincipalId: string | null
    at: string | null
  }
  operationId: string | null
  requestId: string | null
  holdUntil: string | null
  independentVotesNeeded: integer | null
}

Response 400 · `bad_request` — the path, query or body failed validation. `details` carries the Zod issues, one per offending field.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 401 · `unauthorized` — no credential, or one that is expired, revoked or not valid for this resource. `mfa_required` when the credential is good but a second factor is owed.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 403 · `forbidden` — the credential is valid and its scopes or this principal’s membership do not reach this resource. Scopes are re-intersected with live memberships on every request, so this can appear for a token that worked yesterday.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 404 · `not_found` — no such resource, OR one this principal cannot see. The two are deliberately one answer: a 403 would confirm the existence of something whose identifier is guessable.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 429 · `rate_limited` or `quota_exceeded` — over a ceiling. `Retry-After` says when to come back, and `x-ratelimit-limit` / `-remaining` / `-reset` describe the bucket.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Response 500 · `internal_error` — an unhandled failure on this side. The message is always generic; `requestId` is the part worth quoting.

{
  error: {
    code: "bad_request" | "conflict" | "forbidden" | "internal_error" | "mfa_required" | "not_found" | "payload_too_large" | "quota_exceeded" | … 6 more
    message: string
    details?: unknown
    requestId?: string
  }
}

Request

curl -X PUT https://api.bucker.io/orgs/{orgSlug}/projects/{projectSlug}/consent/posture \
  -H "authorization: Bearer $BUCKER_TOKEN" \
  -H 'content-type: application/json' \
  -d '{ … }'