--- title: Replace Website Audit target settings description: Replaces all settings. projectId must match the existing target. Omitting approvedAuditPolicy preserves it; null clears it. The dedicated policy-pages operation treats an empty list as an explicit clear. Requires projects.read and website-audit.write… type: api-reference source: ./openapi/inth-api.json method: put path: /v1/website-audit/targets/{targetId} operationId: updateWebsiteTarget server: https://api.inth.com apiVersion: 1.0.0 tags: - Website Audit canonicalUrl: https://inth.com/docs/rest-api/website-audit/update-website-target lastModified: "2026-10-30T13:05:44.605Z" --- ```http PUT /v1/website-audit/targets/{targetId} ``` Server: `https://api.inth.com` Operation ID: `updateWebsiteTarget` Replaces all settings. projectId must match the existing target. Omitting approvedAuditPolicy preserves it; null clears it. The dedicated policy-pages operation treats an empty list as an explicit clear. Requires projects.read and website-audit.write and an organization admin or owner. New public writes are gated by rollout-agent-access-writes, default false. ## Authentication * bearerAuth ### Schemes * bearerAuth: http / bearer - Use an Inth API key or OAuth access token in the Authorization header. Product operations need a capability. Feedback intake only requires authentication. An OAuth access token carries the capabilities it was granted as scopes; an organization API key carries a fixed set (\`organizations.read\`, \`projects.read\`, \`projects.write\`, \`api-keys.read\`, \`inbox.read\`, \`billing.read\`), so writes that name the person who made them, such as \`inbox.write\` and \`vendors.write\`, need a user token. A credential without the capability an operation needs is answered with \`403 INSUFFICIENT\_SCOPE\`. \`GET /v1/me\` reports the capabilities of the calling credential. OAuth scopes: - \`organizations.read\`: List the organizations you belong to. - \`organizations.write\`: Create organizations you will own. - \`projects.read\`: Read projects, their consent configuration, and the vendors seen on them. - \`projects.write\`: Create, update, and delete projects and their consent configuration. - \`members.read\`: Read member names, email addresses, profile images, roles, and pending invitation email addresses. - \`members.write\`: Invite members, change member roles, remove members, and cancel invitations. - \`api-keys.read\`: List organization API keys. - \`api-keys.write\`: Create, roll, and delete organization API keys. - \`code-audit.read\`: Read Code Audit scans, their findings, and connected repositories. - \`code-audit.write\`: Start Code Audit scans and unlock their reports. - \`inbox.read\`: Read Inbox findings. - \`inbox.write\`: Change Inbox status or assignment and open GitHub issues for findings. - \`vendors.write\`: Approve or ignore vendors detected on your projects, which resolves their Inbox findings. - \`billing.read\`: Read the plan and credit balance of an organization. - \`billing.details.read\`: Read invoices, billing profiles, and payment method summaries for organizations you own. - \`consent.read\`: Read consent records, analytics, configuration, and runtime status. - \`consent.write\`: Update consent settings, translations, IAB configuration, and policies. - \`consent.keys.read\`: Read consent runtime key metadata. Secret values are never returned. - \`website-audit.read\`: Read website audit targets, scans, reports, cookies, and evidence. - \`website-audit.write\`: Manage website audit targets, verify domains, review findings, and start scans. - \`account.read\`: Read your account profile. - \`notifications.read\`: Read your notification preferences and organization routing. - \`organization-retention.read\`: Read organization provider data retention policy. - \`support.read\`: Read support conversations you own or can access through sharing. - \`support.write\`: Create support conversations, send messages, share or close them, and upload support attachments. - \`consent.lifecycle.write\`: Update, upgrade or delete Consent runtimes. - \`consent.keys.write\`: Create, rotate and revoke Consent runtime keys. - \`billing.write\`: Preview and change plans, buy credits, manage billing details and subscriptions, and open hosted payment flows. - \`account.security.read\`: Read your active browser sessions and connected device grants. - \`account.security.write\`: Revoke your browser sessions and connected device grants. - \`integrations.read\`: Read connected integration accounts, repositories, provider properties and project links. - \`integrations.write\`: Connect and sync providers, manage repository settings, project links and paid pull request monitoring. - \`account.write\`: Update your name, avatar and PII masking preference. - \`account.delete\`: Permanently delete your account after ownership checks and confirmation. - \`notifications.write\`: Update your notification preferences. - \`notifications.routing.write\`: Manage organization notification routing. - \`organization-retention.write\`: Change organization provider data retention policy. - \`organizations.settings.write\`: Update organization name, logo and slug. - \`organizations.delete\`: Permanently delete organizations you own after confirmation. - \`agents.read\`: Read your Inth Agent chats and chats shared with your organization. - \`agents.write\`: Start Inth Agent chats, send messages, share your chats with the organization, and delete your chats. Agent replies use organization credits. ## Request ### Path Parameters |Name|Type|Required|Description| |:--|:--|:--|:--| |`targetId`|string|required|| ### Request Body required Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`approvedAuditPolicy`|object \|null|optional|| |`crawlMode`|"mixed" \|"domain" \|"sitemap" \|"explicit\_urls"|required|| |`includeUrls`|string\[]|optional|| |`maxDepth`|integer|required|| |`maxPages`|integer|required|| |`monitoringEnabled`|boolean|required|| |`origin`|string|required|| |`policyUrls`|string\[]|required|| |`projectId`|string|required|| |`regionProfiles`|"uk\_gdpr" \|"eu\_eea\_gdpr" \|"us\_ca\_cpra" \|"us\_tx\_baseline" \|"custom"\[]|optional|| |`scheduleCadence`|"hourly" \|"daily" \|"weekly" \|"biweekly" \|"monthly"|required|| |`enabled`|boolean|required|| JSON Schema: ```json { "type": "object", "properties": { "approvedAuditPolicy": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "revision": { "type": "string", "minLength": 1, "maxLength": 200 }, "origin": { "type": "string", "minLength": 1 }, "approvedAt": { "type": "string", "minLength": 1, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$" }, "approvalReference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "cookies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "ownerHost": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$", "maxLength": 253 }, "partitionKey": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "maxRemainingSeconds": { "type": "number", "minimum": 0 }, "sessionOnly": { "type": "boolean" }, "security": { "type": "object", "properties": { "secure": { "type": "boolean" }, "httpOnly": { "type": "boolean" }, "sameSite": { "type": "string", "enum": [ "Strict", "Lax", "None" ] }, "domain": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$", "maxLength": 253 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/", "maxLength": 1024 }, "hostOnly": { "type": "boolean" }, "partitioned": { "type": "boolean" } }, "additionalProperties": false }, "priorConsent": { "type": "object", "properties": { "purpose": { "type": "string", "enum": [ "advertising", "measurement" ] }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/", "maxLength": 1024 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "requirement": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "required" ] } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "exempt" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "kind", "reference" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "unresolved" ] } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "purpose", "path", "countries", "requirement" ], "additionalProperties": false }, "afterWithdrawal": { "type": "object", "properties": { "removal": { "type": "string", "enum": [ "required" ] }, "purposeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "removal", "purposeId", "reference" ], "additionalProperties": false }, "afterRefusal": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "identifier" ] }, "documentScope": { "type": "string", "enum": [ "root" ] }, "purposeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "channels": { "type": "array", "items": { "type": "string", "enum": [ "cookie_read", "cookie_header" ] }, "minItems": 1, "maxItems": 2 }, "transmission": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "cookie_header" ] }, "origin": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "kind", "origin", "path", "method", "reference" ], "additionalProperties": false }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "role", "documentScope", "purposeId", "channels", "reference" ], "additionalProperties": false }, "embeddedDocument": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "url", "reference" ], "additionalProperties": false }, "refreshApproval": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reference" ], "additionalProperties": false } }, "required": [ "name", "ownerHost", "partitionKey" ], "additionalProperties": false }, "maxItems": 500 }, "collections": { "type": "array", "items": { "type": "object", "properties": { "vendor": { "type": "string", "enum": [ "google-analytics", "posthog", "plausible", "databuddy", "linkedin-insight-tag", "x-pixel", "custom" ] }, "origin": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "initiatorUrl": { "type": "string", "minLength": 1 }, "purpose": { "type": "string", "enum": [ "advertising", "measurement" ] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "requirement": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "required" ] } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "exempt" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "kind", "reference" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "unresolved" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "payloadFields": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "minItems": 1, "maxItems": 100 }, "replayProbe": { "type": "object", "properties": { "eventType": { "type": "string", "pattern": "^inth-audit-[a-z0-9-]{1,80}$" }, "markerField": { "type": "string", "minLength": 1, "maxLength": 200 }, "purposeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "permittedBehaviour": { "type": "string", "enum": [ "discard_denied_events" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "eventType", "markerField", "purposeId", "permittedBehaviour", "reference" ], "additionalProperties": false }, "embeddedDocument": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "script", "parser", "document" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "url", "source", "reference" ], "additionalProperties": false }, "identifyingSignal": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "pixel", "fingerprint" ] }, "source": { "type": "string", "enum": [ "script", "parser", "document" ] }, "fields": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "minItems": 1, "maxItems": 100 }, "reference": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "kind", "source", "fields", "reference" ], "additionalProperties": false }, "afterWithdrawal": { "type": "object", "properties": { "purposeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "purposeId", "reference" ], "additionalProperties": false }, "proxyRouting": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "server_proxy", "cname" ] }, "forwarding": { "type": "string", "enum": [ "unconditional", "conditional" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "revision": { "type": "string", "minLength": 1, "maxLength": 200 }, "digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "observedAt": { "type": "string", "minLength": 1, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$" }, "validUntil": { "type": "string", "minLength": 1, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$" }, "recipient": { "type": "object", "properties": { "origin": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "relationship": { "type": "string", "enum": [ "third_party", "first_party", "unresolved" ] }, "method": { "type": "string", "enum": [ "GET", "POST" ] } }, "required": [ "origin", "path", "relationship", "method" ], "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1, "maxLength": 200 }, "destination": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "source", "destination" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 }, "cnameChain": { "type": "array", "items": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$", "maxLength": 253 }, "minItems": 2, "maxItems": 16 } }, "required": [ "kind", "forwarding", "reference", "revision", "digest", "observedAt", "validUntil", "recipient", "fields" ], "additionalProperties": false } }, "required": [ "vendor", "origin", "path", "method", "initiatorUrl", "purpose", "countries", "requirement", "payloadFields" ], "additionalProperties": false }, "maxItems": 500 }, "storage": { "type": "array", "items": { "type": "object", "properties": { "mechanism": { "type": "string", "enum": [ "local", "session", "indexeddb", "cache" ] }, "accessScope": { "type": "string", "enum": [ "document-native-methods" ] }, "origin": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1, "maxLength": 1024 }, "database": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] }, "store": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] }, "purpose": { "type": "string", "enum": [ "advertising", "measurement" ] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "requirement": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "required" ] } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "exempt" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "kind", "reference" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "unresolved" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "embeddedDocument": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "url", "reference" ], "additionalProperties": false }, "afterRefusal": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "identifier" ] }, "documentScope": { "type": "string", "enum": [ "root" ] }, "purposeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "channels": { "type": "array", "items": { "type": "string", "enum": [ "native_read", "transmission", "property_read", "worker" ] }, "minItems": 1, "maxItems": 4 }, "transmission": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "fetch_get_query" ] }, "origin": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "parameter": { "type": "string", "minLength": 1, "maxLength": 200 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "kind", "origin", "path", "parameter", "reference" ], "additionalProperties": false }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "role", "documentScope", "purposeId", "channels", "reference" ], "additionalProperties": false } }, "required": [ "mechanism", "accessScope", "origin", "key", "database", "store", "purpose", "countries", "requirement" ], "additionalProperties": false }, "maxItems": 500 }, "withdrawal": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "route": { "type": "object", "properties": { "selector": { "type": "string", "minLength": 1, "maxLength": 512 }, "label": { "type": "string", "minLength": 1, "maxLength": 120 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reference" ], "additionalProperties": false } }, "required": [ "reference", "countries" ], "additionalProperties": false }, "googleInitialization": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "transport": { "type": "string", "enum": [ "native_data_layer_push" ] }, "dataLayerName": { "type": "string", "enum": [ "dataLayer" ] }, "requiredDefault": { "type": "boolean", "enum": [ true ] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "consentTypes": { "type": "array", "items": { "type": "string", "enum": [ "ad_storage", "analytics_storage", "ad_user_data", "ad_personalization" ] }, "minItems": 1, "maxItems": 4 }, "defaultStates": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ad_storage", "analytics_storage", "ad_user_data", "ad_personalization", "functionality_storage", "personalization_storage", "security_storage" ] }, "state": { "type": "string", "enum": [ "denied", "granted" ] } }, "required": [ "type", "state" ], "additionalProperties": false }, "minItems": 1, "maxItems": 7 }, "choiceStates": { "type": "array", "items": { "type": "object", "properties": { "choice": { "type": "string", "enum": [ "accept_all", "reject_all", "accept_measurement_only", "accept_functionality_only", "accept_marketing_only" ] }, "updateRequired": { "type": "boolean" }, "states": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ad_storage", "analytics_storage", "ad_user_data", "ad_personalization", "functionality_storage", "personalization_storage", "security_storage" ] }, "state": { "type": "string", "enum": [ "denied", "granted" ] } }, "required": [ "type", "state" ], "additionalProperties": false }, "minItems": 1, "maxItems": 7 } }, "required": [ "choice", "updateRequired", "states" ], "additionalProperties": false }, "minItems": 1, "maxItems": 5 }, "categoryMapping": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "categories": { "type": "array", "items": { "type": "object", "properties": { "categoryId": { "type": "string", "minLength": 1, "maxLength": 200 }, "consentTypes": { "type": "array", "items": { "type": "string", "enum": [ "ad_storage", "analytics_storage", "ad_user_data", "ad_personalization", "functionality_storage", "personalization_storage", "security_storage" ] }, "minItems": 1, "maxItems": 7 } }, "required": [ "categoryId", "consentTypes" ], "additionalProperties": false }, "minItems": 1, "maxItems": 32 } }, "required": [ "reference", "categories" ], "additionalProperties": false }, "adsDataRedaction": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "required": { "type": "boolean", "enum": [ true ] } }, "required": [ "reference", "required" ], "additionalProperties": false }, "implementationMode": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "mode": { "type": "string", "enum": [ "basic", "advanced" ] } }, "required": [ "reference", "mode" ], "additionalProperties": false } }, "required": [ "reference", "transport", "dataLayerName", "requiredDefault", "countries", "consentTypes" ], "additionalProperties": false }, "auditExpectations": { "type": "object", "properties": { "regionalBanner": { "type": "array", "items": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "banner": { "type": "string", "enum": [ "required", "not_expected" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "countries", "banner", "reference" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 }, "noticeAtCollection": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "notice": { "type": "object", "properties": { "selector": { "type": "string", "minLength": 1, "maxLength": 512 }, "label": { "type": "string", "minLength": 1, "maxLength": 120 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reference" ], "additionalProperties": false }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "countries", "notice", "reference" ], "additionalProperties": false }, "consentStorageScope": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "host_only" ] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "scope", "countries", "reference" ], "additionalProperties": false }, "statisticalException": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "purposeIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "minItems": 1, "maxItems": 32 }, "notice": { "type": "object", "properties": { "selector": { "type": "string", "minLength": 1, "maxLength": 512 }, "label": { "type": "string", "minLength": 1, "maxLength": 120 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reference" ], "additionalProperties": false }, "objection": { "type": "object", "properties": { "selector": { "type": "string", "minLength": 1, "maxLength": 512 }, "label": { "type": "string", "minLength": 1, "maxLength": 120 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reference" ], "additionalProperties": false }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "countries", "purposeIds", "notice", "objection", "reference" ], "additionalProperties": false }, "disclosedVendors": { "type": "object", "properties": { "vendors": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{0,99}$" }, "maxItems": 500 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "vendors", "reference" ], "additionalProperties": false }, "cmpMaintenance": { "type": "object", "properties": { "platform": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{0,99}$" }, "minimumVersion": { "type": "string", "pattern": "^\\d{1,4}\\.\\d{1,4}\\.\\d{1,4}$" }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "platform", "minimumVersion", "reference" ], "additionalProperties": false }, "downstreamAssurance": { "type": "object", "properties": { "recipients": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 100 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "recipients", "reference" ], "additionalProperties": false }, "instrumentedEvidence": { "type": "object", "properties": { "rules": { "type": "array", "items": { "type": "string", "enum": [ "N06", "D10", "D13", "X01", "X04", "X06", "X07", "X08" ] }, "minItems": 1, "maxItems": 8 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "rules", "reference" ], "additionalProperties": false } }, "additionalProperties": false }, "selectedActivity": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "categories": { "type": "array", "items": { "type": "object", "properties": { "categoryId": { "type": "string", "minLength": 1, "maxLength": 200 }, "collection": { "type": "boolean", "enum": [ true ] }, "cookies": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 100 } }, "required": [ "categoryId" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 } }, "required": [ "reference", "countries", "categories" ], "additionalProperties": false }, "choiceInterface": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "affirmativeOptIn": { "type": "boolean", "enum": [ true ] }, "privacyNoticeUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "accessibility": { "type": "string", "enum": [ "wcag_2_1_aa" ] }, "acceptAllOffered": { "type": "boolean", "enum": [ true ] } }, "required": [ "reference", "countries" ], "additionalProperties": false }, "refusalPersistence": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "reload", "same_session_return" ] }, "minItems": 1, "maxItems": 2 } }, "required": [ "reference", "countries", "scopes" ], "additionalProperties": false }, "tcf": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "choices": { "type": "object", "properties": { "acceptAll": { "type": "object", "properties": { "purposeConsents": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 24 }, "maxItems": 24, "minItems": 1 }, "vendorConsents": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "maxItems": 65535, "allOf": [ { "maxItems": 5000 } ] }, "specialFeatureOptins": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 12 }, "maxItems": 12 } }, "required": [ "purposeConsents", "vendorConsents", "specialFeatureOptins" ], "additionalProperties": false }, "rejectAll": { "type": "object", "properties": { "allowedPurposeConsents": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 24 }, "maxItems": 24 }, "allowedVendorConsents": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "maxItems": 65535, "allOf": [ { "maxItems": 5000 } ] }, "allowedSpecialFeatureOptins": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 12 }, "maxItems": 12 } }, "required": [ "allowedPurposeConsents", "allowedVendorConsents", "allowedSpecialFeatureOptins" ], "additionalProperties": false } }, "additionalProperties": false }, "publisherRestrictions": { "type": "array", "items": { "type": "object", "properties": { "purposeId": { "type": "integer", "minimum": 1, "maximum": 24 }, "restrictionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "vendorIds": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "maxItems": 65535, "allOf": [ { "maxItems": 5000 } ], "minItems": 1 } }, "required": [ "purposeId", "restrictionType", "vendorIds" ], "additionalProperties": false }, "minItems": 1, "maxItems": 64 }, "consentModeMapping": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "transport": { "type": "string", "enum": [ "native_data_layer_push" ] }, "dataLayerName": { "type": "string", "enum": [ "dataLayer" ] }, "types": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ad_storage", "analytics_storage", "ad_user_data", "ad_personalization", "functionality_storage", "personalization_storage", "security_storage" ] }, "purposeConsents": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 24 }, "maxItems": 24, "minItems": 1 } }, "required": [ "type", "purposeConsents" ], "additionalProperties": false }, "minItems": 1, "maxItems": 4 } }, "required": [ "reference", "transport", "dataLayerName", "types" ], "additionalProperties": false } }, "required": [ "reference", "countries" ], "additionalProperties": false }, "usPrivacy": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "subdivisions": { "type": "array", "items": { "type": "string", "pattern": "^US-[A-Z]{2}$" }, "minItems": 1, "maxItems": 60 }, "optOutChoice": { "type": "string", "enum": [ "saved_rejection" ] }, "gpp": { "type": "object", "properties": { "sections": { "type": "array", "items": { "type": "object", "properties": { "api": { "type": "string", "enum": [ "usnat", "usca", "usva", "usco", "usut", "usct" ] }, "subdivisions": { "type": "array", "items": { "type": "string", "pattern": "^US-[A-Z]{2}$" }, "minItems": 1, "maxItems": 60 } }, "required": [ "api", "subdivisions" ], "additionalProperties": false }, "minItems": 1, "maxItems": 6 }, "optOutFields": { "type": "array", "items": { "type": "string", "enum": [ "SaleOptOut", "SharingOptOut", "TargetedAdvertisingOptOut" ] }, "minItems": 1, "maxItems": 3 } }, "required": [ "sections", "optOutFields" ], "additionalProperties": false }, "usp": { "type": "object", "properties": { "optOutFlag": { "type": "string", "enum": [ "required" ] } }, "required": [ "optOutFlag" ], "additionalProperties": false }, "saleSharing": { "type": "object", "properties": { "transports": { "type": "array", "items": { "type": "object", "properties": { "origin": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "activity": { "type": "string", "enum": [ "sale", "sharing", "targeted_advertising" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "origin", "path", "method", "activity", "reference" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 } }, "required": [ "transports" ], "additionalProperties": false }, "optOutRoute": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "consent_manager" ] }, "label": { "type": "string", "enum": [ "Do Not Sell or Share My Personal Information", "Do Not Sell My Personal Information", "Do Not Share My Personal Information", "Your Privacy Choices", "Your California Privacy Choices" ] }, "pages": { "type": "array", "items": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "minItems": 1, "maxItems": 50 } }, "required": [ "kind", "label" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "page" ] }, "label": { "type": "string", "enum": [ "Do Not Sell or Share My Personal Information", "Do Not Sell My Personal Information", "Do Not Share My Personal Information", "Your Privacy Choices", "Your California Privacy Choices" ] }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "pages": { "type": "array", "items": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "minItems": 1, "maxItems": 50 } }, "required": [ "kind", "label", "path" ], "additionalProperties": false } ] } }, "required": [ "reference", "subdivisions" ], "additionalProperties": false } }, "required": [ "version", "revision", "origin", "approvedAt", "approvalReference", "cookies" ], "additionalProperties": false }, { "type": "null" } ] }, "crawlMode": { "type": "string", "enum": [ "mixed", "domain", "sitemap", "explicit_urls" ] }, "includeUrls": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "maxDepth": { "type": "integer", "minimum": 0 }, "maxPages": { "type": "integer", "exclusiveMinimum": 0 }, "monitoringEnabled": { "type": "boolean" }, "origin": { "type": "string", "minLength": 1 }, "policyUrls": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "projectId": { "type": "string", "minLength": 1 }, "regionProfiles": { "type": "array", "items": { "type": "string", "enum": [ "uk_gdpr", "eu_eea_gdpr", "us_ca_cpra", "us_tx_baseline", "custom" ] } }, "scheduleCadence": { "type": "string", "enum": [ "hourly", "daily", "weekly", "biweekly", "monthly" ] }, "enabled": { "type": "boolean" } }, "required": [ "crawlMode", "maxDepth", "maxPages", "monitoringEnabled", "origin", "policyUrls", "projectId", "scheduleCadence", "enabled" ], "additionalProperties": false } ``` ## Code Examples ### cURL ```bash curl -X PUT "https://api.inth.com/v1/website-audit/targets/{targetId}" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "approvedAuditPolicy": {}, "crawlMode": "mixed", "includeUrls": [ "string" ], "maxDepth": 0, "maxPages": 0, "monitoringEnabled": true, "origin": "string", "policyUrls": [ "string" ], "projectId": "string", "regionProfiles": [ "uk_gdpr" ], "scheduleCadence": "hourly", "enabled": true }' ``` ### JavaScript ```ts const response = await fetch("https://api.inth.com/v1/website-audit/targets/{targetId}", { method: "PUT", headers: { "Authorization": "Bearer ", "Content-Type": "application/json" }, body: JSON.stringify({ "approvedAuditPolicy": {}, "crawlMode": "mixed", "includeUrls": [ "string" ], "maxDepth": 0, "maxPages": 0, "monitoringEnabled": true, "origin": "string", "policyUrls": [ "string" ], "projectId": "string", "regionProfiles": [ "uk_gdpr" ], "scheduleCadence": "hourly", "enabled": true }), }); const data = await response.json(); ``` ## Responses ### 200 Success Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|unknown|required|| |`data`|object|required|| |`data.approvedAuditPolicy`|object|optional|| |`data.approvedAuditPolicy.version`|1|required|| |`data.approvedAuditPolicy.revision`|string|required|| |`data.approvedAuditPolicy.origin`|string|required|| |`data.approvedAuditPolicy.approvedAt`|string|required|| |`data.approvedAuditPolicy.approvalReference`|string|required|| |`data.approvedAuditPolicy.cookies`|object\[]|required|| |`data.approvedAuditPolicy.cookies[].name`|string|required|| |`data.approvedAuditPolicy.cookies[].ownerHost`|string|required|| |`data.approvedAuditPolicy.cookies[].partitionKey`|string \|null|required|| |`data.approvedAuditPolicy.cookies[].maxRemainingSeconds`|number|optional|| |`data.approvedAuditPolicy.cookies[].sessionOnly`|boolean|optional|| |`data.approvedAuditPolicy.cookies[].security`|object|optional|| |`data.approvedAuditPolicy.cookies[].security.secure`|boolean|optional|| |`data.approvedAuditPolicy.cookies[].security.httpOnly`|boolean|optional|| |`data.approvedAuditPolicy.cookies[].security.sameSite`|"Strict" \|"Lax" \|"None"|optional|| |`data.approvedAuditPolicy.cookies[].security.domain`|string|optional|| |`data.approvedAuditPolicy.cookies[].security.path`|string|optional|| |`data.approvedAuditPolicy.cookies[].security.hostOnly`|boolean|optional|| |`data.approvedAuditPolicy.cookies[].security.partitioned`|boolean|optional|| |`data.approvedAuditPolicy.cookies[].priorConsent`|object|optional|| |`data.approvedAuditPolicy.cookies[].priorConsent.purpose`|"advertising" \|"measurement"|required|| |`data.approvedAuditPolicy.cookies[].priorConsent.path`|string|required|| |`data.approvedAuditPolicy.cookies[].priorConsent.countries`|string\[]|required|| |`data.approvedAuditPolicy.cookies[].priorConsent.requirement`|object \|object \|object|required|| |`data.approvedAuditPolicy.cookies[].afterWithdrawal`|object|optional|| |`data.approvedAuditPolicy.cookies[].afterWithdrawal.removal`|"required"|required|| |`data.approvedAuditPolicy.cookies[].afterWithdrawal.purposeId`|string|required|| |`data.approvedAuditPolicy.cookies[].afterWithdrawal.reference`|string|required|| |`data.approvedAuditPolicy.cookies[].afterRefusal`|object|optional|| |`data.approvedAuditPolicy.cookies[].afterRefusal.role`|"identifier"|required|| |`data.approvedAuditPolicy.cookies[].afterRefusal.documentScope`|"root"|required|| |`data.approvedAuditPolicy.cookies[].afterRefusal.purposeId`|string|required|| |`data.approvedAuditPolicy.cookies[].afterRefusal.channels`|"cookie\_read" \|"cookie\_header"\[]|required|| |`data.approvedAuditPolicy.cookies[].afterRefusal.transmission`|object|optional|| |`data.approvedAuditPolicy.cookies[].afterRefusal.transmission.kind`|"cookie\_header"|required|| |`data.approvedAuditPolicy.cookies[].afterRefusal.transmission.origin`|string|required|| |`data.approvedAuditPolicy.cookies[].afterRefusal.transmission.path`|string|required|| |`data.approvedAuditPolicy.cookies[].afterRefusal.transmission.method`|"GET" \|"POST"|required|| |`data.approvedAuditPolicy.cookies[].afterRefusal.transmission.reference`|string|required|| |`data.approvedAuditPolicy.cookies[].afterRefusal.reference`|string|required|| |`data.approvedAuditPolicy.cookies[].embeddedDocument`|object|optional|| |`data.approvedAuditPolicy.cookies[].embeddedDocument.url`|string|required|| |`data.approvedAuditPolicy.cookies[].embeddedDocument.reference`|string|required|| |`data.approvedAuditPolicy.cookies[].refreshApproval`|object|optional|| |`data.approvedAuditPolicy.cookies[].refreshApproval.reference`|string|required|| |`data.approvedAuditPolicy.collections`|object\[]|optional|| |`data.approvedAuditPolicy.collections[].vendor`|"google-analytics" \|"posthog" \|"plausible" \|"databuddy" \|"linkedin-insight-tag" \|"x-pixel" \|"custom"|required|| |`data.approvedAuditPolicy.collections[].origin`|string|required|| |`data.approvedAuditPolicy.collections[].path`|string|required|| |`data.approvedAuditPolicy.collections[].method`|"GET" \|"POST"|required|| |`data.approvedAuditPolicy.collections[].initiatorUrl`|string|required|| |`data.approvedAuditPolicy.collections[].purpose`|"advertising" \|"measurement"|required|| |`data.approvedAuditPolicy.collections[].countries`|string\[]|required|| |`data.approvedAuditPolicy.collections[].requirement`|object \|object \|object|required|| |`data.approvedAuditPolicy.collections[].payloadFields`|string\[]|required|| |`data.approvedAuditPolicy.collections[].replayProbe`|object|optional|| |`data.approvedAuditPolicy.collections[].replayProbe.eventType`|string|required|| |`data.approvedAuditPolicy.collections[].replayProbe.markerField`|string|required|| |`data.approvedAuditPolicy.collections[].replayProbe.purposeId`|string|required|| |`data.approvedAuditPolicy.collections[].replayProbe.permittedBehaviour`|"discard\_denied\_events"|required|| |`data.approvedAuditPolicy.collections[].replayProbe.reference`|string|required|| |`data.approvedAuditPolicy.collections[].embeddedDocument`|object|optional|| |`data.approvedAuditPolicy.collections[].embeddedDocument.url`|string|required|| |`data.approvedAuditPolicy.collections[].embeddedDocument.source`|"script" \|"parser" \|"document"|required|| |`data.approvedAuditPolicy.collections[].embeddedDocument.reference`|string|required|| |`data.approvedAuditPolicy.collections[].identifyingSignal`|object|optional|| |`data.approvedAuditPolicy.collections[].identifyingSignal.kind`|"pixel" \|"fingerprint"|required|| |`data.approvedAuditPolicy.collections[].identifyingSignal.source`|"script" \|"parser" \|"document"|required|| |`data.approvedAuditPolicy.collections[].identifyingSignal.fields`|string\[]|required|| |`data.approvedAuditPolicy.collections[].identifyingSignal.reference`|string|required|| |`data.approvedAuditPolicy.collections[].afterWithdrawal`|object|optional|| |`data.approvedAuditPolicy.collections[].afterWithdrawal.purposeId`|string|required|| |`data.approvedAuditPolicy.collections[].afterWithdrawal.reference`|string|required|| |`data.approvedAuditPolicy.collections[].proxyRouting`|object|optional|| |`data.approvedAuditPolicy.collections[].proxyRouting.kind`|"server\_proxy" \|"cname"|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.forwarding`|"unconditional" \|"conditional"|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.reference`|string|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.revision`|string|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.digest`|string|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.observedAt`|string|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.validUntil`|string|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.recipient`|object|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.recipient.origin`|string|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.recipient.path`|string|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.recipient.relationship`|"third\_party" \|"first\_party" \|"unresolved"|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.recipient.method`|"GET" \|"POST"|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.fields`|object\[]|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.fields[].source`|string|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.fields[].destination`|string|required|| |`data.approvedAuditPolicy.collections[].proxyRouting.cnameChain`|string\[]|optional|| |`data.approvedAuditPolicy.storage`|object\[]|optional|| |`data.approvedAuditPolicy.storage[].mechanism`|"local" \|"session" \|"indexeddb" \|"cache"|required|| |`data.approvedAuditPolicy.storage[].accessScope`|"document-native-methods"|required|| |`data.approvedAuditPolicy.storage[].origin`|string|required|| |`data.approvedAuditPolicy.storage[].key`|string|required|| |`data.approvedAuditPolicy.storage[].database`|string \|null|required|| |`data.approvedAuditPolicy.storage[].store`|string \|null|required|| |`data.approvedAuditPolicy.storage[].purpose`|"advertising" \|"measurement"|required|| |`data.approvedAuditPolicy.storage[].countries`|string\[]|required|| |`data.approvedAuditPolicy.storage[].requirement`|object \|object \|object|required|| |`data.approvedAuditPolicy.storage[].embeddedDocument`|object|optional|| |`data.approvedAuditPolicy.storage[].embeddedDocument.url`|string|required|| |`data.approvedAuditPolicy.storage[].embeddedDocument.reference`|string|required|| |`data.approvedAuditPolicy.storage[].afterRefusal`|object|optional|| |`data.approvedAuditPolicy.storage[].afterRefusal.role`|"identifier"|required|| |`data.approvedAuditPolicy.storage[].afterRefusal.documentScope`|"root"|required|| |`data.approvedAuditPolicy.storage[].afterRefusal.purposeId`|string|required|| |`data.approvedAuditPolicy.storage[].afterRefusal.channels`|"native\_read" \|"transmission" \|"property\_read" \|"worker"\[]|required|| |`data.approvedAuditPolicy.storage[].afterRefusal.transmission`|object|optional|| |`data.approvedAuditPolicy.storage[].afterRefusal.transmission.kind`|"fetch\_get\_query"|required|| |`data.approvedAuditPolicy.storage[].afterRefusal.transmission.origin`|string|required|| |`data.approvedAuditPolicy.storage[].afterRefusal.transmission.path`|string|required|| |`data.approvedAuditPolicy.storage[].afterRefusal.transmission.parameter`|string|required|| |`data.approvedAuditPolicy.storage[].afterRefusal.transmission.reference`|string|required|| |`data.approvedAuditPolicy.storage[].afterRefusal.reference`|string|required|| |`data.approvedAuditPolicy.withdrawal`|object|optional|| |`data.approvedAuditPolicy.withdrawal.reference`|string|required|| |`data.approvedAuditPolicy.withdrawal.countries`|string\[]|required|| |`data.approvedAuditPolicy.withdrawal.route`|object|optional|| |`data.approvedAuditPolicy.withdrawal.route.selector`|string|optional|| |`data.approvedAuditPolicy.withdrawal.route.label`|string|optional|| |`data.approvedAuditPolicy.withdrawal.route.reference`|string|required|| |`data.approvedAuditPolicy.googleInitialization`|object|optional|| |`data.approvedAuditPolicy.googleInitialization.reference`|string|required|| |`data.approvedAuditPolicy.googleInitialization.transport`|"native\_data\_layer\_push"|required|| |`data.approvedAuditPolicy.googleInitialization.dataLayerName`|"dataLayer"|required|| |`data.approvedAuditPolicy.googleInitialization.requiredDefault`|true|required|| |`data.approvedAuditPolicy.googleInitialization.countries`|string\[]|required|| |`data.approvedAuditPolicy.googleInitialization.consentTypes`|"ad\_storage" \|"analytics\_storage" \|"ad\_user\_data" \|"ad\_personalization"\[]|required|| |`data.approvedAuditPolicy.googleInitialization.defaultStates`|object\[]|optional|| |`data.approvedAuditPolicy.googleInitialization.defaultStates[].type`|"ad\_storage" \|"analytics\_storage" \|"ad\_user\_data" \|"ad\_personalization" \|"functionality\_storage" \|"personalization\_storage" \|"security\_storage"|required|| |`data.approvedAuditPolicy.googleInitialization.defaultStates[].state`|"denied" \|"granted"|required|| |`data.approvedAuditPolicy.googleInitialization.choiceStates`|object\[]|optional|| |`data.approvedAuditPolicy.googleInitialization.choiceStates[].choice`|"accept\_all" \|"reject\_all" \|"accept\_measurement\_only" \|"accept\_functionality\_only" \|"accept\_marketing\_only"|required|| |`data.approvedAuditPolicy.googleInitialization.choiceStates[].updateRequired`|boolean|required|| |`data.approvedAuditPolicy.googleInitialization.choiceStates[].states`|object\[]|required|| |`data.approvedAuditPolicy.googleInitialization.choiceStates[].states[].type`|"ad\_storage" \|"analytics\_storage" \|"ad\_user\_data" \|"ad\_personalization" \|"functionality\_storage" \|"personalization\_storage" \|"security\_storage"|required|| |`data.approvedAuditPolicy.googleInitialization.choiceStates[].states[].state`|"denied" \|"granted"|required|| |`data.approvedAuditPolicy.googleInitialization.categoryMapping`|object|optional|| |`data.approvedAuditPolicy.googleInitialization.categoryMapping.reference`|string|required|| |`data.approvedAuditPolicy.googleInitialization.categoryMapping.categories`|object\[]|required|| |`data.approvedAuditPolicy.googleInitialization.categoryMapping.categories[].categoryId`|string|required|| |`data.approvedAuditPolicy.googleInitialization.categoryMapping.categories[].consentTypes`|"ad\_storage" \|"analytics\_storage" \|"ad\_user\_data" \|"ad\_personalization" \|"functionality\_storage" \|"personalization\_storage" \|"security\_storage"\[]|required|| |`data.approvedAuditPolicy.googleInitialization.adsDataRedaction`|object|optional|| |`data.approvedAuditPolicy.googleInitialization.adsDataRedaction.reference`|string|required|| |`data.approvedAuditPolicy.googleInitialization.adsDataRedaction.required`|true|required|| |`data.approvedAuditPolicy.googleInitialization.implementationMode`|object|optional|| |`data.approvedAuditPolicy.googleInitialization.implementationMode.reference`|string|required|| |`data.approvedAuditPolicy.googleInitialization.implementationMode.mode`|"basic" \|"advanced"|required|| |`data.approvedAuditPolicy.auditExpectations`|object|optional|| |`data.approvedAuditPolicy.auditExpectations.regionalBanner`|object\[]|optional|| |`data.approvedAuditPolicy.auditExpectations.regionalBanner[].countries`|string\[]|required|| |`data.approvedAuditPolicy.auditExpectations.regionalBanner[].banner`|"required" \|"not\_expected"|required|| |`data.approvedAuditPolicy.auditExpectations.regionalBanner[].reference`|string|required|| |`data.approvedAuditPolicy.auditExpectations.noticeAtCollection`|object|optional|| |`data.approvedAuditPolicy.auditExpectations.noticeAtCollection.countries`|string\[]|required|| |`data.approvedAuditPolicy.auditExpectations.noticeAtCollection.notice`|object|required|| |`data.approvedAuditPolicy.auditExpectations.noticeAtCollection.notice.selector`|string|optional|| |`data.approvedAuditPolicy.auditExpectations.noticeAtCollection.notice.label`|string|optional|| |`data.approvedAuditPolicy.auditExpectations.noticeAtCollection.notice.reference`|string|required|| |`data.approvedAuditPolicy.auditExpectations.noticeAtCollection.reference`|string|required|| |`data.approvedAuditPolicy.auditExpectations.consentStorageScope`|object|optional|| |`data.approvedAuditPolicy.auditExpectations.consentStorageScope.scope`|"host\_only"|required|| |`data.approvedAuditPolicy.auditExpectations.consentStorageScope.countries`|string\[]|required|| |`data.approvedAuditPolicy.auditExpectations.consentStorageScope.reference`|string|required|| |`data.approvedAuditPolicy.auditExpectations.statisticalException`|object|optional|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.countries`|string\[]|required|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.purposeIds`|string\[]|required|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.notice`|object|required|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.notice.selector`|string|optional|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.notice.label`|string|optional|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.notice.reference`|string|required|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.objection`|object|required|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.objection.selector`|string|optional|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.objection.label`|string|optional|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.objection.reference`|string|required|| |`data.approvedAuditPolicy.auditExpectations.statisticalException.reference`|string|required|| |`data.approvedAuditPolicy.auditExpectations.disclosedVendors`|object|optional|| |`data.approvedAuditPolicy.auditExpectations.disclosedVendors.vendors`|string\[]|required|| |`data.approvedAuditPolicy.auditExpectations.disclosedVendors.reference`|string|required|| |`data.approvedAuditPolicy.auditExpectations.cmpMaintenance`|object|optional|| |`data.approvedAuditPolicy.auditExpectations.cmpMaintenance.platform`|string|required|| |`data.approvedAuditPolicy.auditExpectations.cmpMaintenance.minimumVersion`|string|required|| |`data.approvedAuditPolicy.auditExpectations.cmpMaintenance.reference`|string|required|| |`data.approvedAuditPolicy.auditExpectations.downstreamAssurance`|object|optional|| |`data.approvedAuditPolicy.auditExpectations.downstreamAssurance.recipients`|string\[]|required|| |`data.approvedAuditPolicy.auditExpectations.downstreamAssurance.reference`|string|required|| |`data.approvedAuditPolicy.auditExpectations.instrumentedEvidence`|object|optional|| |`data.approvedAuditPolicy.auditExpectations.instrumentedEvidence.rules`|"N06" \|"D10" \|"D13" \|"X01" \|"X04" \|"X06" \|"X07" \|"X08"\[]|required|| |`data.approvedAuditPolicy.auditExpectations.instrumentedEvidence.reference`|string|required|| |`data.approvedAuditPolicy.selectedActivity`|object|optional|| |`data.approvedAuditPolicy.selectedActivity.reference`|string|required|| |`data.approvedAuditPolicy.selectedActivity.countries`|string\[]|required|| |`data.approvedAuditPolicy.selectedActivity.categories`|object\[]|required|| |`data.approvedAuditPolicy.selectedActivity.categories[].categoryId`|string|required|| |`data.approvedAuditPolicy.selectedActivity.categories[].collection`|true|optional|| |`data.approvedAuditPolicy.selectedActivity.categories[].cookies`|string\[]|optional|| |`data.approvedAuditPolicy.choiceInterface`|object|optional|| |`data.approvedAuditPolicy.choiceInterface.reference`|string|required|| |`data.approvedAuditPolicy.choiceInterface.countries`|string\[]|required|| |`data.approvedAuditPolicy.choiceInterface.affirmativeOptIn`|true|optional|| |`data.approvedAuditPolicy.choiceInterface.privacyNoticeUrl`|string|optional|| |`data.approvedAuditPolicy.choiceInterface.accessibility`|"wcag\_2\_1\_aa"|optional|| |`data.approvedAuditPolicy.choiceInterface.acceptAllOffered`|true|optional|| |`data.approvedAuditPolicy.refusalPersistence`|object|optional|| |`data.approvedAuditPolicy.refusalPersistence.reference`|string|required|| |`data.approvedAuditPolicy.refusalPersistence.countries`|string\[]|required|| |`data.approvedAuditPolicy.refusalPersistence.scopes`|"reload" \|"same\_session\_return"\[]|required|| |`data.approvedAuditPolicy.tcf`|object|optional|| |`data.approvedAuditPolicy.tcf.reference`|string|required|| |`data.approvedAuditPolicy.tcf.countries`|string\[]|required|| |`data.approvedAuditPolicy.tcf.choices`|object|optional|| |`data.approvedAuditPolicy.tcf.choices.acceptAll`|object|optional|| |`data.approvedAuditPolicy.tcf.choices.acceptAll.purposeConsents`|integer\[]|required|| |`data.approvedAuditPolicy.tcf.choices.acceptAll.vendorConsents`|unknown|required|| |`data.approvedAuditPolicy.tcf.choices.acceptAll.specialFeatureOptins`|integer\[]|required|| |`data.approvedAuditPolicy.tcf.choices.rejectAll`|object|optional|| |`data.approvedAuditPolicy.tcf.choices.rejectAll.allowedPurposeConsents`|integer\[]|required|| |`data.approvedAuditPolicy.tcf.choices.rejectAll.allowedVendorConsents`|unknown|required|| |`data.approvedAuditPolicy.tcf.choices.rejectAll.allowedSpecialFeatureOptins`|integer\[]|required|| |`data.approvedAuditPolicy.tcf.publisherRestrictions`|object\[]|optional|| |`data.approvedAuditPolicy.tcf.publisherRestrictions[].purposeId`|integer|required|| |`data.approvedAuditPolicy.tcf.publisherRestrictions[].restrictionType`|0 \|1 \|2|required|| |`data.approvedAuditPolicy.tcf.publisherRestrictions[].vendorIds`|unknown|required|| |`data.approvedAuditPolicy.tcf.consentModeMapping`|object|optional|| |`data.approvedAuditPolicy.tcf.consentModeMapping.reference`|string|required|| |`data.approvedAuditPolicy.tcf.consentModeMapping.transport`|"native\_data\_layer\_push"|required|| |`data.approvedAuditPolicy.tcf.consentModeMapping.dataLayerName`|"dataLayer"|required|| |`data.approvedAuditPolicy.tcf.consentModeMapping.types`|object\[]|required|| |`data.approvedAuditPolicy.tcf.consentModeMapping.types[].type`|"ad\_storage" \|"analytics\_storage" \|"ad\_user\_data" \|"ad\_personalization" \|"functionality\_storage" \|"personalization\_storage" \|"security\_storage"|required|| |`data.approvedAuditPolicy.tcf.consentModeMapping.types[].purposeConsents`|integer\[]|required|| |`data.approvedAuditPolicy.usPrivacy`|object|optional|| |`data.approvedAuditPolicy.usPrivacy.reference`|string|required|| |`data.approvedAuditPolicy.usPrivacy.subdivisions`|string\[]|required|| |`data.approvedAuditPolicy.usPrivacy.optOutChoice`|"saved\_rejection"|optional|| |`data.approvedAuditPolicy.usPrivacy.gpp`|object|optional|| |`data.approvedAuditPolicy.usPrivacy.gpp.sections`|object\[]|required|| |`data.approvedAuditPolicy.usPrivacy.gpp.sections[].api`|"usnat" \|"usca" \|"usva" \|"usco" \|"usut" \|"usct"|required|| |`data.approvedAuditPolicy.usPrivacy.gpp.sections[].subdivisions`|string\[]|required|| |`data.approvedAuditPolicy.usPrivacy.gpp.optOutFields`|"SaleOptOut" \|"SharingOptOut" \|"TargetedAdvertisingOptOut"\[]|required|| |`data.approvedAuditPolicy.usPrivacy.usp`|object|optional|| |`data.approvedAuditPolicy.usPrivacy.usp.optOutFlag`|"required"|required|| |`data.approvedAuditPolicy.usPrivacy.saleSharing`|object|optional|| |`data.approvedAuditPolicy.usPrivacy.saleSharing.transports`|object\[]|required|| |`data.approvedAuditPolicy.usPrivacy.saleSharing.transports[].origin`|string|required|| |`data.approvedAuditPolicy.usPrivacy.saleSharing.transports[].path`|string|required|| |`data.approvedAuditPolicy.usPrivacy.saleSharing.transports[].method`|"GET" \|"POST"|required|| |`data.approvedAuditPolicy.usPrivacy.saleSharing.transports[].activity`|"sale" \|"sharing" \|"targeted\_advertising"|required|| |`data.approvedAuditPolicy.usPrivacy.saleSharing.transports[].reference`|string|required|| |`data.approvedAuditPolicy.usPrivacy.optOutRoute`|object \|object|optional|| |`data.crawlMode`|string|required|| |`data.enabled`|boolean|required|| |`data.id`|string|required|| |`data.includeUrls`|string\[]|optional|| |`data.lastRunAt`|string \|null|required|| |`data.lastRunStatus`|string \|null|required|| |`data.maxDepth`|integer|required|| |`data.maxPages`|integer|required|| |`data.monitoring`|object \|null|optional|| |`data.organizationId`|string|required|| |`data.origin`|string|required|| |`data.policyUrls`|string\[]|optional|| |`data.projectId`|string|required|| |`data.projectName`|string|required|| |`data.projectSlug`|string|required|| |`data.regionProfiles`|"uk\_gdpr" \|"eu\_eea\_gdpr" \|"us\_ca\_cpra" \|"us\_tx\_baseline" \|"custom"\[]|optional|| |`data.scheduleCadence`|string|required|| |`data.ownership`|object|optional|| |`data.ownership.domain`|string|required|| |`data.ownership.method`|"dns" \|"http" \|"email" \|"search\_console" \|null|required|| |`data.ownership.status`|"unverified" \|"pending" \|"verified" \|"recheck\_failed" \|"third\_party"|required|| |`data.ownership.tier`|"unverified" \|"verified" \|"third\_party"|required|| |`data.ownership.verifiedAt`|string \|null|required|| Example: ```json { "success": {}, "data": { "approvedAuditPolicy": { "version": 1, "revision": "string", "origin": "string", "approvedAt": "string", "approvalReference": "string", "cookies": [ { "name": "string", "ownerHost": "string", "partitionKey": "string", "maxRemainingSeconds": 0, "sessionOnly": true, "security": { "secure": true, "httpOnly": true, "sameSite": "Strict", "domain": "string", "path": "string", "hostOnly": true, "partitioned": true }, "priorConsent": { "purpose": "advertising", "path": "string", "countries": [ null ], "requirement": {} }, "afterWithdrawal": { "removal": "required", "purposeId": "string", "reference": "string" }, "afterRefusal": { "role": "identifier", "documentScope": "root", "purposeId": "string", "channels": [ null ], "transmission": { "kind": null, "origin": null, "path": null, "method": null, "reference": null }, "reference": "string" }, "embeddedDocument": { "url": "string", "reference": "string" }, "refreshApproval": { "reference": "string" } } ], "collections": [ { "vendor": "google-analytics", "origin": "string", "path": "string", "method": "GET", "initiatorUrl": "string", "purpose": "advertising", "countries": [ "string" ], "requirement": {}, "payloadFields": [ "string" ], "replayProbe": { "eventType": "string", "markerField": "string", "purposeId": "string", "permittedBehaviour": "discard_denied_events", "reference": "string" }, "embeddedDocument": { "url": "string", "source": "script", "reference": "string" }, "identifyingSignal": { "kind": "pixel", "source": "script", "fields": [ null ], "reference": "string" }, "afterWithdrawal": { "purposeId": "string", "reference": "string" }, "proxyRouting": { "kind": "server_proxy", "forwarding": "unconditional", "reference": "string", "revision": "string", "digest": "string", "observedAt": "string", "validUntil": "string", "recipient": { "origin": null, "path": null, "relationship": null, "method": null }, "fields": [ null ], "cnameChain": [ null ] } } ], "storage": [ { "mechanism": "local", "accessScope": "document-native-methods", "origin": "string", "key": "string", "database": "string", "store": "string", "purpose": "advertising", "countries": [ "string" ], "requirement": {}, "embeddedDocument": { "url": "string", "reference": "string" }, "afterRefusal": { "role": "identifier", "documentScope": "root", "purposeId": "string", "channels": [ null ], "transmission": { "kind": null, "origin": null, "path": null, "parameter": null, "reference": null }, "reference": "string" } } ], "withdrawal": { "reference": "string", "countries": [ "string" ], "route": { "selector": "string", "label": "string", "reference": "string" } }, "googleInitialization": { "reference": "string", "transport": "native_data_layer_push", "dataLayerName": "dataLayer", "requiredDefault": true, "countries": [ "string" ], "consentTypes": [ "ad_storage" ], "defaultStates": [ { "type": "ad_storage", "state": "denied" } ], "choiceStates": [ { "choice": "accept_all", "updateRequired": true, "states": [ null ] } ], "categoryMapping": { "reference": "string", "categories": [ { "categoryId": null, "consentTypes": null } ] }, "adsDataRedaction": { "reference": "string", "required": true }, "implementationMode": { "reference": "string", "mode": "basic" } }, "auditExpectations": { "regionalBanner": [ { "countries": [ null ], "banner": "required", "reference": "string" } ], "noticeAtCollection": { "countries": [ "string" ], "notice": { "selector": "string", "label": "string", "reference": "string" }, "reference": "string" }, "consentStorageScope": { "scope": "host_only", "countries": [ "string" ], "reference": "string" }, "statisticalException": { "countries": [ "string" ], "purposeIds": [ "string" ], "notice": { "selector": "string", "label": "string", "reference": "string" }, "objection": { "selector": "string", "label": "string", "reference": "string" }, "reference": "string" }, "disclosedVendors": { "vendors": [ "string" ], "reference": "string" }, "cmpMaintenance": { "platform": "string", "minimumVersion": "string", "reference": "string" }, "downstreamAssurance": { "recipients": [ "string" ], "reference": "string" }, "instrumentedEvidence": { "rules": [ "N06" ], "reference": "string" } }, "selectedActivity": { "reference": "string", "countries": [ "string" ], "categories": [ { "categoryId": "string", "collection": true, "cookies": [ null ] } ] }, "choiceInterface": { "reference": "string", "countries": [ "string" ], "affirmativeOptIn": true, "privacyNoticeUrl": "string", "accessibility": "wcag_2_1_aa", "acceptAllOffered": true }, "refusalPersistence": { "reference": "string", "countries": [ "string" ], "scopes": [ "reload" ] }, "tcf": { "reference": "string", "countries": [ "string" ], "choices": { "acceptAll": { "purposeConsents": [ null ], "vendorConsents": [ null ], "specialFeatureOptins": [ null ] }, "rejectAll": { "allowedPurposeConsents": [ null ], "allowedVendorConsents": [ null ], "allowedSpecialFeatureOptins": [ null ] } }, "publisherRestrictions": [ { "purposeId": 0, "restrictionType": 0, "vendorIds": [ null ] } ], "consentModeMapping": { "reference": "string", "transport": "native_data_layer_push", "dataLayerName": "dataLayer", "types": [ { "type": null, "purposeConsents": null } ] } }, "usPrivacy": { "reference": "string", "subdivisions": [ "string" ], "optOutChoice": "saved_rejection", "gpp": { "sections": [ { "api": null, "subdivisions": null } ], "optOutFields": [ "SaleOptOut" ] }, "usp": { "optOutFlag": "required" }, "saleSharing": { "transports": [ { "origin": null, "path": null, "method": null, "activity": null, "reference": null } ] }, "optOutRoute": {} } }, "crawlMode": "string", "enabled": true, "id": "string", "includeUrls": [ "string" ], "lastRunAt": "string", "lastRunStatus": "string", "maxDepth": 0, "maxPages": 0, "monitoring": {}, "organizationId": "string", "origin": "string", "policyUrls": [ "string" ], "projectId": "string", "projectName": "string", "projectSlug": "string", "regionProfiles": [ "uk_gdpr" ], "scheduleCadence": "string", "ownership": { "domain": "string", "method": {}, "status": "unverified", "tier": "unverified", "verifiedAt": "string" } } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "const": true }, "data": { "type": "object", "properties": { "approvedAuditPolicy": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "revision": { "type": "string", "minLength": 1, "maxLength": 200 }, "origin": { "type": "string", "minLength": 1 }, "approvedAt": { "type": "string", "minLength": 1, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$" }, "approvalReference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "cookies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "ownerHost": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$", "maxLength": 253 }, "partitionKey": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "maxRemainingSeconds": { "type": "number", "minimum": 0 }, "sessionOnly": { "type": "boolean" }, "security": { "type": "object", "properties": { "secure": { "type": "boolean" }, "httpOnly": { "type": "boolean" }, "sameSite": { "type": "string", "enum": [ "Strict", "Lax", "None" ] }, "domain": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$", "maxLength": 253 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/", "maxLength": 1024 }, "hostOnly": { "type": "boolean" }, "partitioned": { "type": "boolean" } }, "additionalProperties": false }, "priorConsent": { "type": "object", "properties": { "purpose": { "type": "string", "enum": [ "advertising", "measurement" ] }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/", "maxLength": 1024 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "requirement": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "required" ] } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "exempt" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "kind", "reference" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "unresolved" ] } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "purpose", "path", "countries", "requirement" ], "additionalProperties": false }, "afterWithdrawal": { "type": "object", "properties": { "removal": { "type": "string", "enum": [ "required" ] }, "purposeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "removal", "purposeId", "reference" ], "additionalProperties": false }, "afterRefusal": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "identifier" ] }, "documentScope": { "type": "string", "enum": [ "root" ] }, "purposeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "channels": { "type": "array", "items": { "type": "string", "enum": [ "cookie_read", "cookie_header" ] }, "minItems": 1, "maxItems": 2 }, "transmission": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "cookie_header" ] }, "origin": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "kind", "origin", "path", "method", "reference" ], "additionalProperties": false }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "role", "documentScope", "purposeId", "channels", "reference" ], "additionalProperties": false }, "embeddedDocument": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "url", "reference" ], "additionalProperties": false }, "refreshApproval": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reference" ], "additionalProperties": false } }, "required": [ "name", "ownerHost", "partitionKey" ], "additionalProperties": false }, "maxItems": 500 }, "collections": { "type": "array", "items": { "type": "object", "properties": { "vendor": { "type": "string", "enum": [ "google-analytics", "posthog", "plausible", "databuddy", "linkedin-insight-tag", "x-pixel", "custom" ] }, "origin": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "initiatorUrl": { "type": "string", "minLength": 1 }, "purpose": { "type": "string", "enum": [ "advertising", "measurement" ] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "requirement": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "required" ] } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "exempt" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "kind", "reference" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "unresolved" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "payloadFields": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "minItems": 1, "maxItems": 100 }, "replayProbe": { "type": "object", "properties": { "eventType": { "type": "string", "pattern": "^inth-audit-[a-z0-9-]{1,80}$" }, "markerField": { "type": "string", "minLength": 1, "maxLength": 200 }, "purposeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "permittedBehaviour": { "type": "string", "enum": [ "discard_denied_events" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "eventType", "markerField", "purposeId", "permittedBehaviour", "reference" ], "additionalProperties": false }, "embeddedDocument": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "source": { "type": "string", "enum": [ "script", "parser", "document" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "url", "source", "reference" ], "additionalProperties": false }, "identifyingSignal": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "pixel", "fingerprint" ] }, "source": { "type": "string", "enum": [ "script", "parser", "document" ] }, "fields": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "minItems": 1, "maxItems": 100 }, "reference": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "kind", "source", "fields", "reference" ], "additionalProperties": false }, "afterWithdrawal": { "type": "object", "properties": { "purposeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "purposeId", "reference" ], "additionalProperties": false }, "proxyRouting": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "server_proxy", "cname" ] }, "forwarding": { "type": "string", "enum": [ "unconditional", "conditional" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "revision": { "type": "string", "minLength": 1, "maxLength": 200 }, "digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "observedAt": { "type": "string", "minLength": 1, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$" }, "validUntil": { "type": "string", "minLength": 1, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$" }, "recipient": { "type": "object", "properties": { "origin": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "relationship": { "type": "string", "enum": [ "third_party", "first_party", "unresolved" ] }, "method": { "type": "string", "enum": [ "GET", "POST" ] } }, "required": [ "origin", "path", "relationship", "method" ], "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1, "maxLength": 200 }, "destination": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "source", "destination" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 }, "cnameChain": { "type": "array", "items": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$", "maxLength": 253 }, "minItems": 2, "maxItems": 16 } }, "required": [ "kind", "forwarding", "reference", "revision", "digest", "observedAt", "validUntil", "recipient", "fields" ], "additionalProperties": false } }, "required": [ "vendor", "origin", "path", "method", "initiatorUrl", "purpose", "countries", "requirement", "payloadFields" ], "additionalProperties": false }, "maxItems": 500 }, "storage": { "type": "array", "items": { "type": "object", "properties": { "mechanism": { "type": "string", "enum": [ "local", "session", "indexeddb", "cache" ] }, "accessScope": { "type": "string", "enum": [ "document-native-methods" ] }, "origin": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1, "maxLength": 1024 }, "database": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] }, "store": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] }, "purpose": { "type": "string", "enum": [ "advertising", "measurement" ] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "requirement": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "required" ] } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "exempt" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "kind", "reference" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "unresolved" ] } }, "required": [ "kind" ], "additionalProperties": false } ] }, "embeddedDocument": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "url", "reference" ], "additionalProperties": false }, "afterRefusal": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "identifier" ] }, "documentScope": { "type": "string", "enum": [ "root" ] }, "purposeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "channels": { "type": "array", "items": { "type": "string", "enum": [ "native_read", "transmission", "property_read", "worker" ] }, "minItems": 1, "maxItems": 4 }, "transmission": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "fetch_get_query" ] }, "origin": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "parameter": { "type": "string", "minLength": 1, "maxLength": 200 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "kind", "origin", "path", "parameter", "reference" ], "additionalProperties": false }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "role", "documentScope", "purposeId", "channels", "reference" ], "additionalProperties": false } }, "required": [ "mechanism", "accessScope", "origin", "key", "database", "store", "purpose", "countries", "requirement" ], "additionalProperties": false }, "maxItems": 500 }, "withdrawal": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "route": { "type": "object", "properties": { "selector": { "type": "string", "minLength": 1, "maxLength": 512 }, "label": { "type": "string", "minLength": 1, "maxLength": 120 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reference" ], "additionalProperties": false } }, "required": [ "reference", "countries" ], "additionalProperties": false }, "googleInitialization": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "transport": { "type": "string", "enum": [ "native_data_layer_push" ] }, "dataLayerName": { "type": "string", "enum": [ "dataLayer" ] }, "requiredDefault": { "type": "boolean", "enum": [ true ] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "consentTypes": { "type": "array", "items": { "type": "string", "enum": [ "ad_storage", "analytics_storage", "ad_user_data", "ad_personalization" ] }, "minItems": 1, "maxItems": 4 }, "defaultStates": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ad_storage", "analytics_storage", "ad_user_data", "ad_personalization", "functionality_storage", "personalization_storage", "security_storage" ] }, "state": { "type": "string", "enum": [ "denied", "granted" ] } }, "required": [ "type", "state" ], "additionalProperties": false }, "minItems": 1, "maxItems": 7 }, "choiceStates": { "type": "array", "items": { "type": "object", "properties": { "choice": { "type": "string", "enum": [ "accept_all", "reject_all", "accept_measurement_only", "accept_functionality_only", "accept_marketing_only" ] }, "updateRequired": { "type": "boolean" }, "states": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ad_storage", "analytics_storage", "ad_user_data", "ad_personalization", "functionality_storage", "personalization_storage", "security_storage" ] }, "state": { "type": "string", "enum": [ "denied", "granted" ] } }, "required": [ "type", "state" ], "additionalProperties": false }, "minItems": 1, "maxItems": 7 } }, "required": [ "choice", "updateRequired", "states" ], "additionalProperties": false }, "minItems": 1, "maxItems": 5 }, "categoryMapping": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "categories": { "type": "array", "items": { "type": "object", "properties": { "categoryId": { "type": "string", "minLength": 1, "maxLength": 200 }, "consentTypes": { "type": "array", "items": { "type": "string", "enum": [ "ad_storage", "analytics_storage", "ad_user_data", "ad_personalization", "functionality_storage", "personalization_storage", "security_storage" ] }, "minItems": 1, "maxItems": 7 } }, "required": [ "categoryId", "consentTypes" ], "additionalProperties": false }, "minItems": 1, "maxItems": 32 } }, "required": [ "reference", "categories" ], "additionalProperties": false }, "adsDataRedaction": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "required": { "type": "boolean", "enum": [ true ] } }, "required": [ "reference", "required" ], "additionalProperties": false }, "implementationMode": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "mode": { "type": "string", "enum": [ "basic", "advanced" ] } }, "required": [ "reference", "mode" ], "additionalProperties": false } }, "required": [ "reference", "transport", "dataLayerName", "requiredDefault", "countries", "consentTypes" ], "additionalProperties": false }, "auditExpectations": { "type": "object", "properties": { "regionalBanner": { "type": "array", "items": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "banner": { "type": "string", "enum": [ "required", "not_expected" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "countries", "banner", "reference" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 }, "noticeAtCollection": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "notice": { "type": "object", "properties": { "selector": { "type": "string", "minLength": 1, "maxLength": 512 }, "label": { "type": "string", "minLength": 1, "maxLength": 120 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reference" ], "additionalProperties": false }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "countries", "notice", "reference" ], "additionalProperties": false }, "consentStorageScope": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "host_only" ] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "scope", "countries", "reference" ], "additionalProperties": false }, "statisticalException": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "purposeIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "minItems": 1, "maxItems": 32 }, "notice": { "type": "object", "properties": { "selector": { "type": "string", "minLength": 1, "maxLength": 512 }, "label": { "type": "string", "minLength": 1, "maxLength": 120 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reference" ], "additionalProperties": false }, "objection": { "type": "object", "properties": { "selector": { "type": "string", "minLength": 1, "maxLength": 512 }, "label": { "type": "string", "minLength": 1, "maxLength": 120 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reference" ], "additionalProperties": false }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "countries", "purposeIds", "notice", "objection", "reference" ], "additionalProperties": false }, "disclosedVendors": { "type": "object", "properties": { "vendors": { "type": "array", "items": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{0,99}$" }, "maxItems": 500 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "vendors", "reference" ], "additionalProperties": false }, "cmpMaintenance": { "type": "object", "properties": { "platform": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{0,99}$" }, "minimumVersion": { "type": "string", "pattern": "^\\d{1,4}\\.\\d{1,4}\\.\\d{1,4}$" }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "platform", "minimumVersion", "reference" ], "additionalProperties": false }, "downstreamAssurance": { "type": "object", "properties": { "recipients": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 100 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "recipients", "reference" ], "additionalProperties": false }, "instrumentedEvidence": { "type": "object", "properties": { "rules": { "type": "array", "items": { "type": "string", "enum": [ "N06", "D10", "D13", "X01", "X04", "X06", "X07", "X08" ] }, "minItems": 1, "maxItems": 8 }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "rules", "reference" ], "additionalProperties": false } }, "additionalProperties": false }, "selectedActivity": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "categories": { "type": "array", "items": { "type": "object", "properties": { "categoryId": { "type": "string", "minLength": 1, "maxLength": 200 }, "collection": { "type": "boolean", "enum": [ true ] }, "cookies": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "minItems": 1, "maxItems": 100 } }, "required": [ "categoryId" ], "additionalProperties": false }, "minItems": 1, "maxItems": 50 } }, "required": [ "reference", "countries", "categories" ], "additionalProperties": false }, "choiceInterface": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "affirmativeOptIn": { "type": "boolean", "enum": [ true ] }, "privacyNoticeUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "accessibility": { "type": "string", "enum": [ "wcag_2_1_aa" ] }, "acceptAllOffered": { "type": "boolean", "enum": [ true ] } }, "required": [ "reference", "countries" ], "additionalProperties": false }, "refusalPersistence": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "reload", "same_session_return" ] }, "minItems": 1, "maxItems": 2 } }, "required": [ "reference", "countries", "scopes" ], "additionalProperties": false }, "tcf": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Z]{2}$" }, "minItems": 1, "maxItems": 250 }, "choices": { "type": "object", "properties": { "acceptAll": { "type": "object", "properties": { "purposeConsents": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 24 }, "maxItems": 24, "minItems": 1 }, "vendorConsents": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "maxItems": 65535, "allOf": [ { "maxItems": 5000 } ] }, "specialFeatureOptins": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 12 }, "maxItems": 12 } }, "required": [ "purposeConsents", "vendorConsents", "specialFeatureOptins" ], "additionalProperties": false }, "rejectAll": { "type": "object", "properties": { "allowedPurposeConsents": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 24 }, "maxItems": 24 }, "allowedVendorConsents": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "maxItems": 65535, "allOf": [ { "maxItems": 5000 } ] }, "allowedSpecialFeatureOptins": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 12 }, "maxItems": 12 } }, "required": [ "allowedPurposeConsents", "allowedVendorConsents", "allowedSpecialFeatureOptins" ], "additionalProperties": false } }, "additionalProperties": false }, "publisherRestrictions": { "type": "array", "items": { "type": "object", "properties": { "purposeId": { "type": "integer", "minimum": 1, "maximum": 24 }, "restrictionType": { "type": "number", "enum": [ 0, 1, 2 ] }, "vendorIds": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "maxItems": 65535, "allOf": [ { "maxItems": 5000 } ], "minItems": 1 } }, "required": [ "purposeId", "restrictionType", "vendorIds" ], "additionalProperties": false }, "minItems": 1, "maxItems": 64 }, "consentModeMapping": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "transport": { "type": "string", "enum": [ "native_data_layer_push" ] }, "dataLayerName": { "type": "string", "enum": [ "dataLayer" ] }, "types": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "ad_storage", "analytics_storage", "ad_user_data", "ad_personalization", "functionality_storage", "personalization_storage", "security_storage" ] }, "purposeConsents": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 24 }, "maxItems": 24, "minItems": 1 } }, "required": [ "type", "purposeConsents" ], "additionalProperties": false }, "minItems": 1, "maxItems": 4 } }, "required": [ "reference", "transport", "dataLayerName", "types" ], "additionalProperties": false } }, "required": [ "reference", "countries" ], "additionalProperties": false }, "usPrivacy": { "type": "object", "properties": { "reference": { "type": "string", "minLength": 1, "maxLength": 1000 }, "subdivisions": { "type": "array", "items": { "type": "string", "pattern": "^US-[A-Z]{2}$" }, "minItems": 1, "maxItems": 60 }, "optOutChoice": { "type": "string", "enum": [ "saved_rejection" ] }, "gpp": { "type": "object", "properties": { "sections": { "type": "array", "items": { "type": "object", "properties": { "api": { "type": "string", "enum": [ "usnat", "usca", "usva", "usco", "usut", "usct" ] }, "subdivisions": { "type": "array", "items": { "type": "string", "pattern": "^US-[A-Z]{2}$" }, "minItems": 1, "maxItems": 60 } }, "required": [ "api", "subdivisions" ], "additionalProperties": false }, "minItems": 1, "maxItems": 6 }, "optOutFields": { "type": "array", "items": { "type": "string", "enum": [ "SaleOptOut", "SharingOptOut", "TargetedAdvertisingOptOut" ] }, "minItems": 1, "maxItems": 3 } }, "required": [ "sections", "optOutFields" ], "additionalProperties": false }, "usp": { "type": "object", "properties": { "optOutFlag": { "type": "string", "enum": [ "required" ] } }, "required": [ "optOutFlag" ], "additionalProperties": false }, "saleSharing": { "type": "object", "properties": { "transports": { "type": "array", "items": { "type": "object", "properties": { "origin": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "method": { "type": "string", "enum": [ "GET", "POST" ] }, "activity": { "type": "string", "enum": [ "sale", "sharing", "targeted_advertising" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "origin", "path", "method", "activity", "reference" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 } }, "required": [ "transports" ], "additionalProperties": false }, "optOutRoute": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "consent_manager" ] }, "label": { "type": "string", "enum": [ "Do Not Sell or Share My Personal Information", "Do Not Sell My Personal Information", "Do Not Share My Personal Information", "Your Privacy Choices", "Your California Privacy Choices" ] }, "pages": { "type": "array", "items": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "minItems": 1, "maxItems": 50 } }, "required": [ "kind", "label" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "page" ] }, "label": { "type": "string", "enum": [ "Do Not Sell or Share My Personal Information", "Do Not Sell My Personal Information", "Do Not Share My Personal Information", "Your Privacy Choices", "Your California Privacy Choices" ] }, "path": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "pages": { "type": "array", "items": { "type": "string", "minLength": 1, "pattern": "^\\/(?!\\/)[^?#]*$", "maxLength": 1024 }, "minItems": 1, "maxItems": 50 } }, "required": [ "kind", "label", "path" ], "additionalProperties": false } ] } }, "required": [ "reference", "subdivisions" ], "additionalProperties": false } }, "required": [ "version", "revision", "origin", "approvedAt", "approvalReference", "cookies" ], "additionalProperties": false }, "crawlMode": { "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "includeUrls": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "lastRunAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastRunStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "maxDepth": { "type": "integer", "minimum": 0 }, "maxPages": { "type": "integer", "minimum": 0 }, "monitoring": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "pending": { "anyOf": [ { "type": "object", "properties": { "effectiveAt": { "type": "string" }, "scheduleCadence": { "type": "string", "enum": [ "hourly", "daily", "weekly", "biweekly", "monthly" ] } }, "required": [ "effectiveAt", "scheduleCadence" ], "additionalProperties": false }, { "type": "null" } ] }, "periodEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scheduleCadence": { "type": "string", "enum": [ "hourly", "daily", "weekly", "biweekly", "monthly" ] } }, "required": [ "enabled", "scheduleCadence" ], "additionalProperties": false }, { "type": "null" } ] }, "organizationId": { "type": "string" }, "origin": { "type": "string" }, "policyUrls": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "projectId": { "type": "string" }, "projectName": { "type": "string" }, "projectSlug": { "type": "string" }, "regionProfiles": { "type": "array", "items": { "type": "string", "enum": [ "uk_gdpr", "eu_eea_gdpr", "us_ca_cpra", "us_tx_baseline", "custom" ] } }, "scheduleCadence": { "type": "string" }, "ownership": { "type": "object", "properties": { "domain": { "type": "string" }, "method": { "anyOf": [ { "type": "string", "enum": [ "dns", "http", "email", "search_console" ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "unverified", "pending", "verified", "recheck_failed", "third_party" ] }, "tier": { "type": "string", "enum": [ "unverified", "verified", "third_party" ] }, "verifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "domain", "method", "status", "tier", "verifiedAt" ], "additionalProperties": false } }, "required": [ "crawlMode", "enabled", "id", "lastRunAt", "lastRunStatus", "maxDepth", "maxPages", "organizationId", "origin", "projectId", "projectName", "projectSlug", "scheduleCadence" ], "additionalProperties": false } } } ``` ### 400 The request payload or parameters are invalid. Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|boolean|required|| |`error`|object|required|| |`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required|| |`error.message`|string|required|| |`error.details`|unknown|optional|Optional structured error details.| Example: default ```json { "success": false, "error": { "code": "INVALID_PAYLOAD", "message": "Invalid request payload", "details": [ { "code": "too_small", "message": "Too small: expected string to have >=1 characters", "path": [ "name" ] } ] } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } } ``` ### 401 Authentication is missing, invalid, or expired. Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|boolean|required|| |`error`|object|required|| |`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required|| |`error.message`|string|required|| |`error.details`|unknown|optional|Optional structured error details.| Example: default ```json { "success": false, "error": { "code": "UNAUTHORIZED", "message": "Authentication required" } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } } ``` ### 403 The credential is valid but may not perform the operation. \`INSUFFICIENT\_SCOPE\`: the credential was never granted the capability the operation needs. \`details.requiredScope\` names it, and the \`WWW-Authenticate\` header carries \`Bearer error="insufficient\_scope"\`. An OAuth client fixes this by requesting the scope; an organization API key cannot gain it. \`FORBIDDEN\`: the capability is present but the membership behind the credential lacks the role, or the resource belongs to another organization. Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|boolean|required|| |`error`|object|required|| |`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required|| |`error.message`|string|required|| |`error.details`|unknown|optional|Optional structured error details.| Example: insufficientScope ```json { "success": false, "error": { "code": "INSUFFICIENT_SCOPE", "message": "This token was not granted the projects.write scope", "details": { "requiredScope": "projects.write" } } } ``` Example: forbidden ```json { "success": false, "error": { "code": "FORBIDDEN", "message": "Organization membership is required" } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } } ``` #### Headers |Name|Type|Required|Description| |:--|:--|:--|:--| |`WWW-Authenticate`|string|optional|Present on \`INSUFFICIENT\_SCOPE\`: \`Bearer error="insufficient\_scope", scope="\"\`.| ### 404 The requested resource was not found. Content type: application/json |Property|Type|Required|Description| |:--|:--|:--|:--| |`success`|boolean|required|| |`error`|object|required|| |`error.code`|"UNAUTHORIZED" \|"FORBIDDEN" \|"INSUFFICIENT\_SCOPE" \|"PLAN\_LIMIT\_REACHED" \|"PLAN\_REQUIRED" \|"INVALID\_ORIGIN" \|"INVALID\_REGION" \|"INVALID\_PAYLOAD" \|"NOT\_FOUND" \|"CONFLICT" \|"KEY\_LIMIT\_REACHED" \|"INSUFFICIENT\_CREDITS" \|"SCAN\_IN\_PROGRESS" \|"UNLOCK\_REQUIRED" \|"REPOSITORY\_NOT\_LINKED" \|"PAYLOAD\_TOO\_LARGE" \|"RATE\_LIMITED" \|"SERVICE\_UNAVAILABLE" \|"INTERNAL\_ERROR"|required|| |`error.message`|string|required|| |`error.details`|unknown|optional|Optional structured error details.| Example: ```json { "success": true, "error": { "code": "UNAUTHORIZED", "message": "string", "details": {} } } ``` JSON Schema: ```json { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "UNAUTHORIZED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PLAN_LIMIT_REACHED", "PLAN_REQUIRED", "INVALID_ORIGIN", "INVALID_REGION", "INVALID_PAYLOAD", "NOT_FOUND", "CONFLICT", "KEY_LIMIT_REACHED", "INSUFFICIENT_CREDITS", "SCAN_IN_PROGRESS", "UNLOCK_REQUIRED", "REPOSITORY_NOT_LINKED", "PAYLOAD_TOO_LARGE", "RATE_LIMITED", "SERVICE_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "details": { "description": "Optional structured error details." } } } } } ``` ## Related * [REST API overview](/docs/rest-api): Every operation in this API.