{ "components": { "schemas": { "adapter_Descriptor": { "properties": { "capabilities": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "id": { "type": "string" }, "implemented": { "type": "boolean" }, "license": { "type": "string" }, "license_restricted": { "type": "boolean" }, "name": { "type": "string" }, "readiness": { "type": "string" } }, "required": [ "capabilities", "id", "implemented", "license", "license_restricted", "name", "readiness" ], "type": "object" }, "digitalcaptcha_Difficulty": { "properties": { "choices": { "type": "integer" }, "iterations_per_derivation": { "type": "integer" }, "operands": { "type": "integer" }, "profile": { "type": "string" }, "search_prefix": { "type": "string" }, "selections": { "type": "integer" }, "work_rounds": { "type": "integer" } }, "required": [ "profile" ], "type": "object" }, "digitalcaptcha_Point": { "properties": { "x": { "type": "integer" }, "y": { "type": "integer" } }, "required": [ "x", "y" ], "type": "object" }, "geo_Info": { "properties": { "countries": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "dataset_module": { "type": "string" }, "external_requests": { "type": "boolean" }, "ipv4": { "type": "boolean" }, "ipv6": { "type": "boolean" }, "mode": { "type": "string" }, "source": { "type": "string" } }, "required": [ "countries", "dataset_module", "external_requests", "ipv4", "ipv6", "mode", "source" ], "type": "object" }, "httpapi_buildVersion": { "properties": { "built_at": { "type": "string" }, "go": { "type": "string" }, "modified": { "type": "boolean" }, "revision": { "type": "string" } }, "required": [ "built_at", "go", "modified", "revision" ], "type": "object" }, "httpapi_errorBody": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retryable": { "type": "boolean" } }, "required": [ "code", "message", "request_id", "retryable" ], "type": "object" } }, "required": [ "error" ], "type": "object" }, "httpapi_loginCaptchaProof": { "properties": { "intent_id": { "type": "string" }, "receipt": { "type": "string" }, "request_hash": { "type": "string" } }, "required": [ "intent_id", "receipt", "request_hash" ], "type": "object" }, "store_CapInstance": { "properties": { "cap_site_key": { "type": "string" }, "config_version": { "type": "integer" }, "cors_origins": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "evaluation": { "type": "string" }, "hashwx_difficulty": { "type": "integer" }, "instance_id": { "type": "string" }, "instrumentation": { "type": "boolean" }, "policy_version": { "type": "string" }, "protocol": { "type": "string" }, "revision": { "type": "string" }, "site_id": { "type": "string" }, "upstream_commit": { "type": "string" } }, "required": [ "cap_site_key", "config_version", "cors_origins", "evaluation", "hashwx_difficulty", "instance_id", "instrumentation", "policy_version", "protocol", "revision", "site_id", "upstream_commit" ], "type": "object" }, "store_CommercialPlan": { "properties": { "allowed_engines": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "duration_days": { "type": "integer" }, "engine_limit": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "price_irr": { "type": "integer" }, "price_usd_minor": { "type": "integer" }, "request_quota": { "type": "integer" }, "revision": { "type": "string" }, "site_limit": { "type": "integer" }, "status": { "type": "string" } }, "required": [ "allowed_engines", "duration_days", "engine_limit", "id", "name", "price_irr", "price_usd_minor", "request_quota", "site_limit", "status" ], "type": "object" }, "store_CountryStat": { "properties": { "country": { "type": "string" }, "failed": { "type": "integer" }, "rejected": { "type": "integer" }, "sessions_issued": { "type": "integer" }, "solved": { "type": "integer" }, "verified": { "type": "integer" } }, "required": [ "country", "failed", "rejected", "sessions_issued", "solved", "verified" ], "type": "object" }, "store_Credential": { "properties": { "id": { "type": "string" }, "ip_allowlist": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "prefix": { "type": "string" }, "scopes": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "secret": { "type": "string" }, "site_id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "ip_allowlist", "prefix", "scopes", "site_id", "status" ], "type": "object" }, "store_CredentialUpdate": { "properties": { "ip_allowlist": { "anyOf": [ { "items": { "type": "string" }, "type": [ "array", "null" ] }, { "type": "null" } ] }, "label": { "type": "string" }, "scopes": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "ip_allowlist", "label", "scopes" ], "type": "object" }, "store_Customer": { "properties": { "contact": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "revision": { "type": "integer" }, "sites": { "type": "integer" }, "status": { "type": "string" } }, "required": [ "contact", "id", "name", "revision", "sites", "status" ], "type": "object" }, "store_CustomerInvite": { "properties": { "customer": { "$ref": "#/components/schemas/store_Customer" }, "expires_at": { "format": "date-time", "type": "string" }, "invitation_token": { "type": "string" } }, "required": [ "customer", "expires_at", "invitation_token" ], "type": "object" }, "store_CyberGenRevision": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "current": { "type": "boolean" }, "settings": { "$ref": "#/components/schemas/store_GoCaptchaSettings" }, "version": { "type": "integer" } }, "required": [ "created_at", "current", "settings", "version" ], "type": "object" }, "store_DailyStat": { "properties": { "day": { "type": "string" }, "failed": { "type": "integer" }, "indeterminate": { "type": "integer" }, "rejected": { "type": "integer" }, "sessions_issued": { "type": "integer" }, "solved": { "type": "integer" }, "verified": { "type": "integer" } }, "required": [ "day", "failed", "indeterminate", "rejected", "sessions_issued", "solved", "verified" ], "type": "object" }, "store_EngineInstance": { "properties": { "config_version": { "type": "integer" }, "evaluation": { "type": "string" }, "instance_id": { "type": "string" }, "name": { "type": "string" }, "provider_id": { "type": "string" }, "site_id": { "type": "string" }, "upstream_commit": { "type": "string" }, "variant": { "type": "string" } }, "required": [ "config_version", "evaluation", "instance_id", "name", "provider_id", "site_id", "upstream_commit" ], "type": "object" }, "store_EventPage": { "properties": { "items": {}, "next_cursor": { "type": "string" } }, "required": [ "items" ], "type": "object" }, "store_GoCaptchaSettings": { "properties": { "expected_config_version": { "type": "integer" }, "max_attempts": { "type": "integer" }, "max_refreshes": { "type": "integer" }, "profile": { "type": "string" }, "scenes": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "tolerance_override": { "type": "integer" }, "ttl_seconds": { "type": "integer" } }, "required": [ "max_attempts", "max_refreshes", "profile", "scenes", "tolerance_override", "ttl_seconds" ], "type": "object" }, "store_HourStat": { "properties": { "blocked": { "type": "integer" }, "failed": { "type": "integer" }, "hour": { "format": "date-time", "type": "string" }, "rejected": { "type": "integer" }, "sessions_issued": { "type": "integer" }, "solved": { "type": "integer" }, "verified": { "type": "integer" } }, "required": [ "blocked", "failed", "hour", "rejected", "sessions_issued", "solved", "verified" ], "type": "object" }, "store_IPStat": { "properties": { "blocked": { "type": "integer" }, "country": { "type": "string" }, "failed": { "type": "integer" }, "ip": { "type": "string" }, "last_seen": { "format": "date-time", "type": "string" }, "requests": { "type": "integer" } }, "required": [ "blocked", "country", "failed", "ip", "last_seen", "requests" ], "type": "object" }, "store_Intent": { "properties": { "action": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "intent_id": { "type": "string" } }, "required": [ "action", "expires_at", "intent_id" ], "type": "object" }, "store_Invoice": { "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" }, "id": { "type": "string" }, "plan_id": { "type": "string" }, "plan_name": { "type": "string" }, "state": { "type": "string" } }, "required": [ "amount", "currency", "id", "plan_id", "plan_name", "state" ], "type": "object" }, "store_MCPToken": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "id": { "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "prefix": { "type": "string" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "token": { "type": "string" } }, "required": [ "created_at", "created_by", "id", "name", "prefix" ], "type": "object" }, "store_PublicInquiry": { "properties": { "contact": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "locale": { "type": "string" }, "message": { "type": "string" }, "organization": { "type": "string" }, "purpose": { "type": "string" }, "revision": { "type": "integer" }, "state": { "type": "string" } }, "required": [ "contact", "created_at", "id", "locale", "message", "organization", "purpose", "revision", "state" ], "type": "object" }, "store_PublicKey": { "properties": { "id": { "type": "string" }, "public_key": { "type": "string" }, "site_id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "public_key", "site_id", "status" ], "type": "object" }, "store_PublicPlan": { "properties": { "duration_days": { "type": "integer" }, "id": { "type": "string" }, "name_en": { "type": "string" }, "name_fa": { "type": "string" }, "price_usd_minor": { "type": "integer" }, "request_quota": { "type": "integer" }, "site_limit": { "type": "integer" }, "status": { "type": "string" } }, "required": [ "duration_days", "id", "name_en", "name_fa", "price_usd_minor", "request_quota", "site_limit", "status" ], "type": "object" }, "store_PublicStats": { "properties": { "countries": { "items": { "$ref": "#/components/schemas/store_CountryStat" }, "type": [ "array", "null" ] }, "days": { "type": "integer" }, "name": { "type": "string" }, "series": { "items": { "$ref": "#/components/schemas/store_DailyStat" }, "type": [ "array", "null" ] }, "site_id": { "type": "string" }, "totals": { "$ref": "#/components/schemas/store_DailyStat" } }, "required": [ "countries", "days", "name", "series", "site_id", "totals" ], "type": "object" }, "store_ReceiptIssue": { "properties": { "intent_id": { "type": "string" }, "receipt": { "type": "string" }, "receipt_expires_at": { "format": "date-time", "type": "string" }, "session_id": { "type": "string" } }, "required": [ "intent_id", "receipt", "receipt_expires_at", "session_id" ], "type": "object" }, "store_SMTPSettings": { "properties": { "enabled": { "type": "boolean" }, "from": { "type": "string" }, "from_name": { "type": "string" }, "host": { "type": "string" }, "mode": { "type": "string" }, "password_set": { "type": "boolean" }, "port": { "type": "integer" }, "revision": { "type": "string" }, "username": { "type": "string" } }, "required": [ "enabled", "from", "from_name", "host", "mode", "password_set", "port", "revision", "username" ], "type": "object" }, "store_SessionIssue": { "properties": { "challenge": { "description": "Arbitrary JSON evidence or forwarded provider payload" }, "completion_token": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "intent_id": { "type": "string" }, "policy_version": { "type": "string" }, "session_id": { "type": "string" } }, "required": [ "challenge", "completion_token", "expires_at", "intent_id", "policy_version", "session_id" ], "type": "object" }, "store_SessionProfile": { "properties": { "platform_admin": { "type": "boolean" }, "role": { "type": "string" }, "username": { "type": "string" } }, "required": [ "platform_admin", "role", "username" ], "type": "object" }, "store_Settings": { "properties": { "ip_mode": { "type": "string" }, "login_captcha_site": { "type": "string" }, "retention_days": { "type": "integer" } }, "required": [ "ip_mode", "login_captcha_site", "retention_days" ], "type": "object" }, "store_Site": { "properties": { "allowed_origins": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "environment": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "revision": { "type": "string" }, "status": { "type": "string" } }, "required": [ "allowed_origins", "environment", "id", "name", "revision", "status" ], "type": "object" }, "store_SiteCredential": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "ip_allowlist": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "label": { "type": "string" }, "prefix": { "type": "string" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "scopes": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "status": { "type": "string" } }, "required": [ "created_at", "id", "ip_allowlist", "label", "prefix", "scopes", "status" ], "type": "object" }, "store_SiteDetail": { "properties": { "allowed_origins": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "credentials": { "items": { "$ref": "#/components/schemas/store_SiteCredential" }, "type": [ "array", "null" ] }, "environment": { "type": "string" }, "id": { "type": "string" }, "instances": { "items": { "$ref": "#/components/schemas/store_SiteInstance" }, "type": [ "array", "null" ] }, "name": { "type": "string" }, "public_keys": { "items": { "$ref": "#/components/schemas/store_SiteKey" }, "type": [ "array", "null" ] }, "rate_limit_per_min": { "type": "integer" }, "revision": { "type": "string" }, "stats_token_prefix": { "type": "string" }, "status": { "type": "string" } }, "required": [ "allowed_origins", "credentials", "environment", "id", "instances", "name", "public_keys", "rate_limit_per_min", "revision", "stats_token_prefix", "status" ], "type": "object" }, "store_SiteInstance": { "properties": { "config_version": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "current": { "type": "boolean" }, "cybergen": { "anyOf": [ { "$ref": "#/components/schemas/store_GoCaptchaSettings" }, { "type": "null" } ] }, "difficulty": { "type": "integer" }, "evaluation": { "type": "string" }, "hashwx_difficulty": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "obfuscation_level": { "type": "integer" }, "provider_id": { "type": "string" }, "state": { "type": "string" }, "ttl_seconds": { "type": "integer" }, "variant": { "type": "string" } }, "required": [ "config_version", "created_at", "current", "evaluation", "hashwx_difficulty", "id", "name", "obfuscation_level", "provider_id", "state" ], "type": "object" }, "store_SiteKey": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "public_key": { "type": "string" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" } }, "required": [ "created_at", "id", "label", "public_key", "status" ], "type": "object" }, "store_SitePage": { "properties": { "items": { "items": { "$ref": "#/components/schemas/store_Site" }, "type": [ "array", "null" ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "type": "object" }, "store_SiteStat": { "properties": { "day": { "type": "string" }, "failed": { "type": "integer" }, "indeterminate": { "type": "integer" }, "name": { "type": "string" }, "rejected": { "type": "integer" }, "sessions_issued": { "type": "integer" }, "site_id": { "type": "string" }, "solved": { "type": "integer" }, "status": { "type": "string" }, "verified": { "type": "integer" } }, "required": [ "day", "failed", "indeterminate", "name", "rejected", "sessions_issued", "site_id", "solved", "status", "verified" ], "type": "object" }, "store_SiteUpdate": { "properties": { "allowed_origins": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "environment": { "type": "string" }, "name": { "type": "string" }, "revision": { "type": "string" }, "status": { "type": "string" } }, "required": [ "allowed_origins", "name", "revision", "status" ], "type": "object" }, "store_StatsToken": { "properties": { "prefix": { "type": "string" }, "token": { "type": "string" } }, "required": [ "prefix", "token" ], "type": "object" }, "store_Subscription": { "properties": { "allowed_engines": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "ends_at": { "format": "date-time", "type": "string" }, "org_id": { "type": "string" }, "plan_id": { "type": "string" }, "request_quota": { "type": "integer" }, "revision": { "type": "integer" }, "site_limit": { "type": "integer" }, "source": { "type": "string" }, "starts_at": { "format": "date-time", "type": "string" }, "state": { "type": "string" }, "used_requests": { "type": "integer" } }, "required": [ "allowed_engines", "ends_at", "org_id", "plan_id", "request_quota", "revision", "site_limit", "source", "starts_at", "state", "used_requests" ], "type": "object" }, "store_Verification": { "properties": { "action": { "type": "string" }, "intent_id": { "type": "string" }, "request_hash": { "type": "string" }, "site_id": { "type": "string" }, "success": { "type": "boolean" }, "verification_id": { "type": "string" }, "verified_at": { "format": "date-time", "type": "string" } }, "required": [ "action", "intent_id", "request_hash", "site_id", "success", "verification_id", "verified_at" ], "type": "object" } }, "securitySchemes": { "AdminSession": { "in": "cookie", "name": "digicaptcha_session", "type": "apiKey" }, "BackendBearer": { "description": "Server-only credential with required operation scopes Never include in browser code", "scheme": "bearer", "type": "http" }, "CSRFToken": { "in": "header", "name": "X-CSRF-Token", "type": "apiKey" }, "MFAChallenge": { "in": "cookie", "name": "digicaptcha_mfa", "type": "apiKey" }, "PublicSiteKey": { "in": "header", "name": "X-DigiCaptcha-Site-Key", "type": "apiKey" }, "SessionToken": { "in": "header", "name": "X-DigiCaptcha-Session-Token", "type": "apiKey" }, "StatsBearer": { "description": "Read-only statistics token, not a backend verification credential", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Current implemented JSON API, generated from registered Go routes and wire types with reviewed validation rules Native/provider readiness is not established by documentation or health alone Proposed operations are excluded Browser administration uses cookies plus CSRF, never a backend bearer credential", "title": "Captchas.ir runtime API", "version": "0.2.0" }, "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "openapi": "3.1.0", "paths": { "/admin/v1/billing": { "get": { "description": "Read the authenticated organization's subscription and invoices Published plans are visible to customers Draft plans and platform controls are visible only to the installation owner Prices in IRR and USD minor units are independent Usage counts created intents Payment is unconfigured until a real gateway is connected", "operationId": "get_admin_v1_billing", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "currencies": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "engine_catalog": { "items": { "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "invoices": { "items": { "$ref": "#/components/schemas/store_Invoice" }, "type": [ "array", "null" ] }, "payment_configured": { "type": "boolean" }, "plans": { "items": { "$ref": "#/components/schemas/store_CommercialPlan" }, "type": [ "array", "null" ] }, "platform_admin": { "type": "boolean" }, "quota_unit": { "type": "string" }, "subscription": { "anyOf": [ { "$ref": "#/components/schemas/store_Subscription" }, { "type": "null" } ] } }, "required": [ "currencies", "engine_catalog", "invoices", "payment_configured", "plans", "platform_admin", "quota_unit", "subscription" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "billing", "tags": [ "Administration" ], "x-source": "internal/httpapi/commerce.go:32" } }, "/admin/v1/billing/checkout": { "post": { "description": "Authenticated CSRF-protected fail-closed checkout returns PAYMENT_NOT_CONFIGURED with HTTP 503 until a real gateway is implemented It never marks an invoice paid or changes a subscription", "operationId": "post_admin_v1_billing_checkout", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "checkout", "tags": [ "Administration" ], "x-source": "internal/httpapi/commerce.go:37" } }, "/admin/v1/billing/invoices": { "post": { "description": "Organization owner/admin creates an idempotent awaiting_payment invoice for a published plan The original price and currency are snapshotted No payment or purchased subscription is activated Idempotency-Key is required", "operationId": "post_admin_v1_billing_invoices", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "currency": { "enum": [ "IRR", "USD" ], "type": "string" }, "plan_id": { "pattern": "^[a-f0-9]{32}$", "type": "string" } }, "required": [ "plan_id", "currency" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_Invoice" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "invoiceCreate", "tags": [ "Administration" ], "x-source": "internal/httpapi/commerce.go:36" } }, "/admin/v1/billing/plans": { "post": { "description": "Installation-owner-only plan creation Drafts may keep zero pending allowances Published plans require positive quotas and site limits No conversion or automatic payment activation allowed_engines=null means all, [] is an unconfigured restricted draft A restricted published plan needs at least one selected engine and may not exceed engine_limit when positive", "operationId": "post_admin_v1_billing_plans", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "allowed_engines": { "items": { "enum": [ "prosopo", "wicketkeeper", "mosparo", "iconcaptcha", "go-captcha", "digitalcaptcha", "fcaptcha", "cap", "captcha-pro", "mcaptcha", "altcha" ], "type": "string" }, "maxItems": 11, "type": [ "array", "null" ], "uniqueItems": true }, "duration_days": { "maximum": 366, "minimum": 1, "type": "integer" }, "engine_limit": { "maximum": 11, "minimum": 0, "type": "integer" }, "id": { "type": "string" }, "name": { "maxLength": 100, "minLength": 2, "type": "string" }, "price_irr": { "maximum": 100000000000000, "minimum": 0, "type": "integer" }, "price_usd_minor": { "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "request_quota": { "maximum": 1000000000, "minimum": 0, "type": "integer" }, "revision": { "type": "string" }, "site_limit": { "maximum": 10000, "minimum": 0, "type": "integer" }, "status": { "enum": [ "draft", "published" ], "type": "string" } }, "required": [ "name", "price_irr", "price_usd_minor", "request_quota", "site_limit", "duration_days", "status" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_CommercialPlan" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "planCreate", "tags": [ "Administration" ], "x-source": "internal/httpapi/commerce.go:33" } }, "/admin/v1/billing/plans/{id}": { "put": { "description": "Installation-owner-only draft edit with required current revision Published plans, existing invoices and subscription snapshots cannot be changed here allowed_engines=null means all, [] is an unconfigured restricted draft A restricted published plan needs at least one selected engine and may not exceed engine_limit when positive", "operationId": "put_admin_v1_billing_plans_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "allowed_engines": { "items": { "enum": [ "prosopo", "wicketkeeper", "mosparo", "iconcaptcha", "go-captcha", "digitalcaptcha", "fcaptcha", "cap", "captcha-pro", "mcaptcha", "altcha" ], "type": "string" }, "maxItems": 11, "type": [ "array", "null" ], "uniqueItems": true }, "duration_days": { "maximum": 366, "minimum": 1, "type": "integer" }, "engine_limit": { "maximum": 11, "minimum": 0, "type": "integer" }, "id": { "type": "string" }, "name": { "maxLength": 100, "minLength": 2, "type": "string" }, "price_irr": { "maximum": 100000000000000, "minimum": 0, "type": "integer" }, "price_usd_minor": { "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "request_quota": { "maximum": 1000000000, "minimum": 0, "type": "integer" }, "revision": { "description": "Opaque revision of the plan the operator reviewed", "pattern": "^[a-f0-9]{64}$", "type": "string" }, "site_limit": { "maximum": 10000, "minimum": 0, "type": "integer" }, "status": { "enum": [ "draft" ], "type": "string" } }, "required": [ "name", "price_irr", "price_usd_minor", "request_quota", "site_limit", "duration_days", "status", "revision", "engine_limit" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updated": { "type": "boolean" } }, "required": [ "updated" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "planUpdate", "tags": [ "Administration" ], "x-source": "internal/httpapi/commerce.go:34" } }, "/admin/v1/billing/plans/{id}/publish": { "post": { "description": "Installation-owner-only transition from draft to published with explicit approved terms Published terms cannot be overwritten Use a new plan for new prices or allowances Optional reviewed revision rejects stale publication allowed_engines=null means all, [] is an unconfigured restricted draft A restricted published plan needs at least one selected engine and may not exceed engine_limit when positive", "operationId": "post_admin_v1_billing_plans_id_publish", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "allowed_engines": { "items": { "enum": [ "prosopo", "wicketkeeper", "mosparo", "iconcaptcha", "go-captcha", "digitalcaptcha", "fcaptcha", "cap", "captcha-pro", "mcaptcha", "altcha" ], "type": "string" }, "maxItems": 11, "type": [ "array", "null" ], "uniqueItems": true }, "duration_days": { "maximum": 366, "minimum": 1, "type": "integer" }, "engine_limit": { "maximum": 11, "minimum": 0, "type": "integer" }, "id": { "type": "string" }, "name": { "maxLength": 100, "minLength": 2, "type": "string" }, "price_irr": { "maximum": 100000000000000, "minimum": 0, "type": "integer" }, "price_usd_minor": { "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "request_quota": { "maximum": 1000000000, "minimum": 1, "type": "integer" }, "revision": { "description": "Opaque revision of the plan the operator reviewed", "pattern": "^[a-f0-9]{64}$", "type": "string" }, "site_limit": { "maximum": 10000, "minimum": 1, "type": "integer" }, "status": { "type": "string" } }, "required": [ "name", "price_irr", "price_usd_minor", "request_quota", "site_limit", "duration_days" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "published": { "type": "boolean" } }, "required": [ "published" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "planPublish", "tags": [ "Administration" ], "x-source": "internal/httpapi/commerce.go:35" } }, "/admin/v1/cap-instances/{id}/config": { "put": { "operationId": "put_admin_v1_cap_instances_id_config", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "hashwx_difficulty": { "type": "integer" }, "obfuscation_level": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "config_version": { "type": "integer" }, "hashwx_difficulty": { "type": "integer" }, "instance_id": { "type": "string" }, "obfuscation_level": { "type": "integer" } }, "required": [ "config_version", "hashwx_difficulty", "instance_id", "obfuscation_level" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "putCapConfig", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:32" } }, "/admin/v1/cap-instances/{id}/rotate-secret": { "post": { "operationId": "post_admin_v1_cap_instances_id_rotate_secret", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "config_version": { "type": "integer" }, "instance_id": { "type": "string" }, "secret_returned": { "type": "boolean" } }, "required": [ "config_version", "instance_id", "secret_returned" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "rotateCapSecret", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:55" } }, "/admin/v1/credentials/{id}": { "put": { "operationId": "put_admin_v1_credentials_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "ip_allowlist": { "anyOf": [ { "items": { "type": "string" }, "type": [ "array", "null" ] }, { "type": "null" } ] }, "label": { "type": "string" }, "scopes": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_SiteCredential" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "updateCredential", "tags": [ "Administration" ], "x-source": "internal/httpapi/keyroutes.go:12" } }, "/admin/v1/credentials/{id}/revoke": { "post": { "operationId": "post_admin_v1_credentials_id_revoke", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "revokeCredential", "tags": [ "Administration" ], "x-source": "internal/httpapi/keyroutes.go:13" } }, "/admin/v1/credentials/{id}/rotate": { "post": { "description": "Replaces the credential and returns the new secret once; prior secret is revoked", "operationId": "post_admin_v1_credentials_id_rotate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_Credential" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "rotateCredential", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:53" } }, "/admin/v1/engines/digitalcaptcha/options": { "get": { "operationId": "get_admin_v1_engines_digitalcaptcha_options", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ai_resistance": { "type": "string" }, "difficulty": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/digitalcaptcha_Difficulty" }, "type": [ "object", "null" ] }, "type": [ "object", "null" ] }, "invisible_method": { "type": "string" }, "invisible_version": { "type": "string" }, "methods": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "methods_by_version": { "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "pow_implementation": { "type": "string" }, "profiles": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "protocol": { "type": "integer" }, "widget_versions": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "ai_resistance", "difficulty", "invisible_method", "invisible_version", "methods", "methods_by_version", "pow_implementation", "profiles", "protocol", "widget_versions" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "digitalSuiteOptions", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:94" } }, "/admin/v1/engines/go-captcha/options": { "get": { "operationId": "get_admin_v1_engines_go_captcha_options", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "can_customize_tolerance": { "type": "boolean" }, "max_attempts": { "type": "integer" }, "max_refreshes": { "type": "integer" }, "native_variants": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "profiles": { "items": { "additionalProperties": {}, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "scenes": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "can_customize_tolerance", "max_attempts", "max_refreshes", "native_variants", "profiles", "scenes" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "goCaptchaOptions", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:93" } }, "/admin/v1/events/audit": { "get": { "operationId": "get_admin_v1_events_audit", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_EventPage" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "auditEvents", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:20" } }, "/admin/v1/events/traffic": { "get": { "operationId": "get_admin_v1_events_traffic", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_EventPage" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "trafficEvents", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:19" } }, "/admin/v1/geo": { "get": { "operationId": "get_admin_v1_geo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/geo_Info" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "geoInfo", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:18" } }, "/admin/v1/mcp-tokens": { "get": { "operationId": "get_admin_v1_mcp_tokens", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/store_MCPToken" }, "type": [ "array", "null" ] }, "listener": { "type": "boolean" } }, "required": [ "items", "listener" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "listMCPTokens", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:26" }, "post": { "operationId": "post_admin_v1_mcp_tokens", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_MCPToken" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "createMCPToken", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:27" } }, "/admin/v1/mcp-tokens/{id}": { "delete": { "operationId": "delete_admin_v1_mcp_tokens_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "revokeMCPToken", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:28" } }, "/admin/v1/monitor": { "get": { "operationId": "get_admin_v1_monitor", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "altcha": { "additionalProperties": {}, "type": [ "object", "null" ] }, "cap": { "properties": { "commit": { "type": "string" }, "configured": { "type": "boolean" }, "latency_ms": { "type": "integer" }, "state": { "type": "string" }, "version": { "type": "string" } }, "required": [ "commit", "configured", "latency_ms", "state", "version" ], "type": "object" }, "cap_evaluation": { "type": "string" }, "counts": { "properties": { "receipts": { "type": "integer" }, "sites": { "type": "integer" }, "users": { "type": "integer" } }, "required": [ "receipts", "sites", "users" ], "type": "object" }, "engine": { "type": "string" }, "local": { "properties": { "cap_loopback": { "type": "integer" }, "captcha_upstreams": { "type": "integer" }, "database_host": { "type": "string" }, "mcp": { "type": "string" }, "panel_assets": { "type": "string" } }, "required": [ "cap_loopback", "captcha_upstreams", "database_host", "mcp", "panel_assets" ], "type": "object" }, "mail_configured": { "type": "boolean" }, "mcaptcha": { "additionalProperties": {}, "type": [ "object", "null" ] }, "ping_ms": { "type": "integer" }, "pool": { "properties": { "idle": { "type": "integer" }, "in_use": { "type": "integer" }, "open": { "type": "integer" } }, "required": [ "idle", "in_use", "open" ], "type": "object" }, "schema": { "type": "integer" } }, "required": [ "altcha", "cap", "cap_evaluation", "counts", "engine", "local", "mail_configured", "mcaptcha", "ping_ms", "pool", "schema" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "monitor", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:35" } }, "/admin/v1/password-recovery/complete": { "post": { "description": "Consumes a one-use email-bound reset capability Revokes all sessions and pending MFA tickets Does not disable MFA or create a sign-in session", "operationId": "post_admin_v1_password_recovery_complete", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "password_changed": { "type": "boolean" }, "sign_in_required": { "type": "boolean" } }, "required": [ "password_changed", "sign_in_required" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "passwordRecoveryComplete", "tags": [ "Administration" ], "x-source": "internal/httpapi/password_recovery.go:12" } }, "/admin/v1/password-recovery/request": { "post": { "description": "Same-origin bounded email recovery Always returns a generic accepted response Never exposes account existence, delivery status or reset tokens Only an already verified address receives a short-lived one-use link", "operationId": "post_admin_v1_password_recovery_request", "responses": { "202": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "passwordRecoveryRequest", "tags": [ "Administration" ], "x-source": "internal/httpapi/password_recovery.go:11" } }, "/admin/v1/platform/customers": { "get": { "description": "Installation-owner-only customer directory A customer organization owner cannot enumerate other customers", "operationId": "get_admin_v1_platform_customers", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/store_Customer" }, "type": [ "array", "null" ] } }, "required": [ "items" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "customers", "tags": [ "Administration" ], "x-source": "internal/httpapi/commerce.go:28" }, "post": { "description": "Installation-owner-only creation of an isolated customer organization Returns a one-time onboarding token valid for 24 hours No automatic email is sent Store and share the token privately", "operationId": "post_admin_v1_platform_customers", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "contact": { "maxLength": 254, "type": "string" }, "name": { "maxLength": 120, "minLength": 2, "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_CustomerInvite" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "customerCreate", "tags": [ "Administration" ], "x-source": "internal/httpapi/commerce.go:29" } }, "/admin/v1/platform/customers/{id}": { "put": { "description": "Installation-owner-only access suspension or restoration Requires the current customer revision Cannot suspend the installation owner's organization Revoked sessions must sign in again after restoration", "operationId": "put_admin_v1_platform_customers_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "revision": { "minimum": 1, "type": "integer" }, "status": { "enum": [ "active", "suspended" ], "type": "string" } }, "required": [ "status", "revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updated": { "type": "boolean" } }, "required": [ "updated" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "customerStatus", "tags": [ "Administration" ], "x-source": "internal/httpapi/commerce.go:30" } }, "/admin/v1/platform/customers/{id}/subscription": { "post": { "description": "Installation-owner-only allocation of a published plan to an active managed customer An audited operator_grant is not payment confirmation Existing active allowance and usage are not reset", "operationId": "post_admin_v1_platform_customers_id_subscription", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "plan_id": { "pattern": "^[a-f0-9]{32}$", "type": "string" }, "reason": { "maxLength": 240, "minLength": 5, "type": "string" } }, "required": [ "plan_id", "reason" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "source": { "type": "string" } }, "required": [ "source" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "subscriptionGrant", "tags": [ "Administration" ], "x-source": "internal/httpapi/commerce.go:31" } }, "/admin/v1/platform/inquiries": { "get": { "description": "Installation-owner-only inbox, latest 100 records within 90 days No-store No customer access", "operationId": "get_admin_v1_platform_inquiries", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/store_PublicInquiry" }, "type": [ "array", "null" ] } }, "required": [ "items" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "inquiryList", "tags": [ "Administration" ], "x-source": "internal/httpapi/public_inquiries.go:13" } }, "/admin/v1/platform/inquiries/{id}": { "put": { "description": "Installation-owner-only state update or permanent deletion with CSRF, compare-and-swap revision and redacted audit", "operationId": "put_admin_v1_platform_inquiries_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "revision": { "minimum": 1, "type": "integer" }, "state": { "enum": [ "reviewed", "closed", "deleted" ], "type": "string" } }, "required": [ "state", "revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updated": { "type": "boolean" } }, "required": [ "updated" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "inquiryUpdate", "tags": [ "Administration" ], "x-source": "internal/httpapi/public_inquiries.go:14" } }, "/admin/v1/platform/mail": { "get": { "description": "Installation-owner-only SMTP configuration Password is never returned No-store", "operationId": "get_admin_v1_platform_mail", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_SMTPSettings" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "smtpGet", "tags": [ "Administration" ], "x-source": "internal/httpapi/smtp_settings.go:49" }, "put": { "description": "Installation-owner-only CSRF-protected configuration with password step-up and revision CAS Credentials are encrypted at rest and never returned Verified TLS is mandatory", "operationId": "put_admin_v1_platform_mail", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "current_password": { "type": "string", "writeOnly": true }, "enabled": { "type": "boolean" }, "from": { "type": "string" }, "from_name": { "type": "string" }, "host": { "type": "string" }, "mode": { "enum": [ "starttls", "tls" ], "type": "string" }, "password": { "maxLength": 2048, "type": "string", "writeOnly": true }, "password_action": { "enum": [ "keep", "replace", "clear" ], "type": "string" }, "port": { "maximum": 65535, "minimum": 1, "type": "integer" }, "revision": { "type": "string" }, "username": { "type": "string" } }, "required": [ "enabled", "host", "port", "from", "mode", "password_action", "current_password", "revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_SMTPSettings" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "smtpPut", "tags": [ "Administration" ], "x-source": "internal/httpapi/smtp_settings.go:50" } }, "/admin/v1/platform/mail/test": { "post": { "description": "Installation-owner-only bounded test of saved configuration Requires current password Successful SMTP acceptance does not prove inbox delivery", "operationId": "post_admin_v1_platform_mail_test", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "current_password": { "type": "string", "writeOnly": true }, "to": { "maxLength": 254, "type": "string" } }, "required": [ "to", "current_password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted_by_smtp": { "type": "boolean" } }, "required": [ "accepted_by_smtp" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "smtpTest", "tags": [ "Administration" ], "x-source": "internal/httpapi/smtp_settings.go:51" } }, "/admin/v1/providers": { "get": { "operationId": "get_admin_v1_providers", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/adapter_Descriptor" }, "type": [ "array", "null" ] } }, "required": [ "items" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "providers", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:56" } }, "/admin/v1/public-keys/{id}": { "put": { "operationId": "put_admin_v1_public_keys_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "label": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "labelPublicKey", "tags": [ "Administration" ], "x-source": "internal/httpapi/keyroutes.go:10" } }, "/admin/v1/public-keys/{id}/revoke": { "post": { "operationId": "post_admin_v1_public_keys_id_revoke", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "revokePublicKey", "tags": [ "Administration" ], "x-source": "internal/httpapi/keyroutes.go:11" } }, "/admin/v1/security/mfa": { "get": { "operationId": "get_admin_v1_security_mfa", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "email": { "type": "string" }, "email_enabled": { "type": "boolean" }, "email_pending": { "type": "boolean" }, "mail_configured": { "type": "boolean" }, "recovery_remaining": { "type": "integer" }, "totp_enabled": { "type": "boolean" }, "totp_installed": { "type": "boolean" } }, "required": [ "email", "email_enabled", "email_pending", "mail_configured", "recovery_remaining", "totp_enabled", "totp_installed" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "mfaStatus", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:37" } }, "/admin/v1/security/mfa/email": { "post": { "operationId": "post_admin_v1_security_mfa_email", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "emailBegin", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:43" } }, "/admin/v1/security/mfa/email/change": { "post": { "operationId": "post_admin_v1_security_mfa_email_change", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "password": { "type": "string" }, "wipe": { "type": "boolean" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "emailChange", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:46" } }, "/admin/v1/security/mfa/email/confirm": { "post": { "operationId": "post_admin_v1_security_mfa_email_confirm", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "emailConfirm", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:44" } }, "/admin/v1/security/mfa/email/resume": { "post": { "operationId": "post_admin_v1_security_mfa_email_resume", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "emailResume", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:47" } }, "/admin/v1/security/mfa/email/send": { "post": { "operationId": "post_admin_v1_security_mfa_email_send", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "purpose": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "emailSend", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:45" } }, "/admin/v1/security/mfa/recovery": { "post": { "operationId": "post_admin_v1_security_mfa_recovery", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "password": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "codes": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "codes" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "recoveryCodes", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:42" } }, "/admin/v1/security/mfa/totp": { "post": { "operationId": "post_admin_v1_security_mfa_totp", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "totpBegin", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:38" } }, "/admin/v1/security/mfa/totp/confirm": { "post": { "operationId": "post_admin_v1_security_mfa_totp_confirm", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "totpConfirm", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:39" } }, "/admin/v1/security/mfa/totp/delete": { "post": { "operationId": "post_admin_v1_security_mfa_totp_delete", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "totpDelete", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:41" } }, "/admin/v1/security/mfa/totp/disable": { "post": { "operationId": "post_admin_v1_security_mfa_totp_disable", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "totpDisable", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:40" } }, "/admin/v1/session": { "get": { "operationId": "get_admin_v1_session", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_SessionProfile" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "session", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:34" } }, "/admin/v1/session/bootstrap": { "post": { "description": "One-time installation exchange, unavailable after bootstrap is consumed", "operationId": "post_admin_v1_session_bootstrap", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "token": { "type": "string" } }, "required": [ "token" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "csrf_token": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "role": { "type": "string" } }, "required": [ "csrf_token", "expires_at", "role" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "bootstrap", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:30" } }, "/admin/v1/session/login": { "post": { "description": "May return MFA_REQUIRED and a short-lived HttpOnly challenge cookie rather than an authenticated session", "operationId": "post_admin_v1_session_login", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "captcha": { "anyOf": [ { "$ref": "#/components/schemas/httpapi_loginCaptchaProof" }, { "type": "null" } ] }, "password": { "type": "string" }, "username": { "type": "string" } }, "required": [ "username", "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "properties": { "email": { "type": "string" }, "methods": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "mfa_required": { "type": "boolean" } }, "required": [ "email", "methods", "mfa_required" ], "type": "object" }, { "properties": { "csrf_token": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "role": { "type": "string" }, "username": { "type": "string" } }, "required": [ "csrf_token", "expires_at", "role", "username" ], "type": "object" } ] } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "login", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:31" } }, "/admin/v1/session/login-captcha": { "get": { "operationId": "get_admin_v1_session_login_captcha", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "enabled": { "type": "boolean" }, "provider": { "type": "string" } }, "required": [ "enabled", "provider" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "loginCaptchaStatus", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:35" }, "post": { "operationId": "post_admin_v1_session_login_captcha", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } } }, "description": "JSON result" }, "201": { "content": { "application/json": { "schema": { "properties": { "enabled": { "type": "boolean" }, "expires_at": { "format": "date-time", "type": "string" }, "intent_id": { "type": "string" }, "request_hash": { "type": "string" }, "site_key": { "type": "string" } }, "required": [ "enabled", "expires_at", "intent_id", "request_hash", "site_key" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "loginCaptchaIntent", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:36" } }, "/admin/v1/session/logout": { "post": { "operationId": "post_admin_v1_session_logout", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "role": { "type": "string" }, "status": { "type": "string" } }, "required": [ "role", "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "logout", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:36" } }, "/admin/v1/session/mfa": { "post": { "operationId": "post_admin_v1_session_mfa", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "method": { "type": "string" } }, "required": [ "method", "code" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "csrf_token": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "role": { "type": "string" }, "username": { "type": "string" } }, "required": [ "csrf_token", "expires_at", "role", "username" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "MFAChallenge": [] } ], "summary": "completeMFA", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:32" } }, "/admin/v1/session/mfa/email": { "post": { "operationId": "post_admin_v1_session_mfa_email", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "MFAChallenge": [] } ], "summary": "sendLoginEmail", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:33" } }, "/admin/v1/session/password": { "post": { "description": "Password changes require the authenticated user's current password", "operationId": "post_admin_v1_session_password", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "current_password": { "type": "string" }, "new_password": { "type": "string" } }, "required": [ "current_password", "new_password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "changePassword", "tags": [ "Administration" ], "x-source": "internal/httpapi/settings.go:15" } }, "/admin/v1/settings": { "get": { "operationId": "get_admin_v1_settings", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": [ "object", "null" ] } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "getSettings", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:24" }, "put": { "operationId": "put_admin_v1_settings", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "ip_mode": { "type": "string" }, "login_captcha_site": { "type": "string" }, "retention_days": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": {}, "type": [ "object", "null" ] } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "putSettings", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:25" } }, "/admin/v1/sites": { "get": { "operationId": "get_admin_v1_sites", "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_SitePage" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "listSites", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:48" }, "post": { "description": "Idempotent site creation Optional provider pinning can fail after the site was persisted: retry the same operation key rather than creating another site", "operationId": "post_admin_v1_sites", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "allowed_origins": { "items": { "format": "uri", "type": "string" }, "minItems": 1, "type": "array" }, "difficulty_profile": { "type": "string" }, "environment": { "enum": [ "development", "staging", "production" ], "type": "string" }, "method": { "type": "string" }, "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "profile": { "enum": [ "", "relaxed", "balanced", "strict" ], "type": "string" }, "provider": { "type": "string" }, "variant": { "type": "string" }, "widget_version": { "type": "string" } }, "required": [ "name", "environment", "allowed_origins" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_Site" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "createSite", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:49" } }, "/admin/v1/sites/{id}": { "delete": { "description": "Soft-deletes the tenant-owned site and revokes its keys Exact site name confirmation is required", "operationId": "delete_admin_v1_sites_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "confirm_name": { "type": "string" } }, "required": [ "confirm_name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "deleteSite", "tags": [ "Administration" ], "x-source": "internal/httpapi/keyroutes.go:14" }, "get": { "operationId": "get_admin_v1_sites_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_SiteDetail" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "siteDetail", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:50" }, "put": { "operationId": "put_admin_v1_sites_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "allowed_origins": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "environment": { "type": "string" }, "name": { "type": "string" }, "revision": { "type": "string" }, "status": { "type": "string" } }, "required": [ "name", "allowed_origins", "status", "revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_Site" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "updateSite", "tags": [ "Administration" ], "x-source": "internal/httpapi/settings.go:16" } }, "/admin/v1/sites/{id}/cap-instances": { "post": { "operationId": "post_admin_v1_sites_id_cap_instances", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "admin_key": { "type": "string" }, "endpoint": { "type": "string" }, "hashwx_difficulty": { "type": "integer" }, "name": { "type": "string" }, "obfuscation_level": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_CapInstance" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "provisionCap", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:54" } }, "/admin/v1/sites/{id}/credentials": { "post": { "description": "Returns the new server secret once Store it only on your backend", "operationId": "post_admin_v1_sites_id_credentials", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "ip_allowlist": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "scopes": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "scopes" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_Credential" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "createCredential", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:52" } }, "/admin/v1/sites/{id}/engines": { "post": { "description": "Pin one configured healthy compatible engine to the site No cross-provider retry of an issued proof", "operationId": "post_admin_v1_sites_id_engines", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "difficulty_profile": { "type": "string" }, "method": { "type": "string" }, "name": { "type": "string" }, "profile": { "type": "string" }, "provider": { "type": "string" }, "variant": { "type": "string" }, "widget_version": { "type": "string" } }, "required": [ "provider" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_EngineInstance" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "activateEngine", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:74" } }, "/admin/v1/sites/{id}/engines/altcha": { "put": { "operationId": "put_admin_v1_sites_id_engines_altcha", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "difficulty": { "type": "integer" }, "ttl_seconds": { "type": "integer" } }, "required": [ "difficulty", "ttl_seconds" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "config_version": { "type": "integer" }, "difficulty": { "type": "integer" }, "ttl_seconds": { "type": "integer" } }, "required": [ "config_version", "difficulty", "ttl_seconds" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "updateAltcha", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:92" } }, "/admin/v1/sites/{id}/engines/altcha/rotate": { "post": { "operationId": "post_admin_v1_sites_id_engines_altcha_rotate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "rotated": { "type": "boolean" } }, "required": [ "rotated" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "rotateAltcha", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:98" } }, "/admin/v1/sites/{id}/engines/go-captcha": { "put": { "description": "Publish an immutable site-owned configuration revision with optimistic concurrency Owner/admin may change tolerance override, operator may preserve it only Issued sessions keep their revision", "operationId": "put_admin_v1_sites_id_engines_go_captcha", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_config_version": { "type": "integer" }, "max_attempts": { "type": "integer" }, "max_refreshes": { "type": "integer" }, "profile": { "type": "string" }, "scenes": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "tolerance_override": { "type": "integer" }, "ttl_seconds": { "type": "integer" } }, "required": [ "profile", "scenes", "ttl_seconds", "max_attempts", "max_refreshes", "tolerance_override", "expected_config_version" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "config_version": { "type": "integer" }, "settings": { "$ref": "#/components/schemas/store_GoCaptchaSettings" } }, "required": [ "config_version", "settings" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "updateGoCaptcha", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:95" } }, "/admin/v1/sites/{id}/engines/go-captcha/history": { "get": { "description": "Tenant-scoped public GoCaptcha settings history for the currently pinned instance Requires sites:read Returns settings, revision and timestamps only Never returns provider endpoints or secret references", "operationId": "get_admin_v1_sites_id_engines_go_captcha_history", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/store_CyberGenRevision" }, "type": [ "array", "null" ] } }, "required": [ "items" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "cyberGenHistory", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:96" } }, "/admin/v1/sites/{id}/engines/go-captcha/restore": { "post": { "description": "Tenant-scoped restoration requires configuration:apply and the current revision Creates a fresh immutable revision from historical public settings while retaining current secrets and pinned in-flight sessions Operators cannot change owner-only tolerance settings through restore", "operationId": "post_admin_v1_sites_id_engines_go_captcha_restore", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_config_version": { "minimum": 1, "type": "integer" }, "version": { "minimum": 1, "type": "integer" } }, "required": [ "version", "expected_config_version" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "config_version": { "type": "integer" } }, "required": [ "config_version" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "cyberGenRestore", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:97" } }, "/admin/v1/sites/{id}/playground/intent": { "post": { "operationId": "post_admin_v1_sites_id_playground_intent", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "action": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "intent_id": { "type": "string" }, "request_hash": { "type": "string" } }, "required": [ "action", "expires_at", "intent_id", "request_hash" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "playgroundIntent", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:57" } }, "/admin/v1/sites/{id}/playground/verify": { "post": { "operationId": "post_admin_v1_sites_id_playground_verify", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "intent_id": { "type": "string" }, "receipt": { "type": "string" }, "request_hash": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_Verification" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "playgroundVerify", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:58" } }, "/admin/v1/sites/{id}/public-keys": { "post": { "operationId": "post_admin_v1_sites_id_public_keys", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_PublicKey" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "createPublicKey", "tags": [ "Administration" ], "x-source": "internal/httpapi/routes.go:51" } }, "/admin/v1/sites/{id}/settings": { "put": { "operationId": "put_admin_v1_sites_id_settings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "rate_limit_per_min": { "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "rate_limit_per_min": { "type": "integer" } }, "required": [ "rate_limit_per_min" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "putSiteSettings", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:29" } }, "/admin/v1/sites/{id}/stats": { "get": { "operationId": "get_admin_v1_sites_id_stats", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "series": { "items": { "$ref": "#/components/schemas/store_DailyStat" }, "type": [ "array", "null" ] }, "totals": { "$ref": "#/components/schemas/store_DailyStat" }, "zone": { "type": "string" } }, "required": [ "series", "totals", "zone" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "siteStats", "tags": [ "Administration" ], "x-source": "internal/httpapi/settings.go:19" } }, "/admin/v1/sites/{id}/stats-token": { "delete": { "operationId": "delete_admin_v1_sites_id_stats_token", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "revokeStatsToken", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:31" }, "post": { "operationId": "post_admin_v1_sites_id_stats_token", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_StatsToken" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [], "CSRFToken": [] } ], "summary": "issueStatsToken", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:30" } }, "/admin/v1/stats/addresses": { "get": { "operationId": "get_admin_v1_stats_addresses", "parameters": [ { "in": "query", "name": "site", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "hours": { "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/store_IPStat" }, "type": [ "array", "null" ] } }, "required": [ "hours", "items" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "addressStats", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:23" } }, "/admin/v1/stats/countries": { "get": { "operationId": "get_admin_v1_stats_countries", "parameters": [ { "in": "query", "name": "site", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "days": { "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/store_CountryStat" }, "type": [ "array", "null" ] } }, "required": [ "days", "items" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "countryStats", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:21" } }, "/admin/v1/stats/hourly": { "get": { "operationId": "get_admin_v1_stats_hourly", "parameters": [ { "in": "query", "name": "site", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "hours": { "type": "integer" }, "items": { "items": { "$ref": "#/components/schemas/store_HourStat" }, "type": [ "array", "null" ] } }, "required": [ "hours", "items" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "hourlyStats", "tags": [ "Administration" ], "x-source": "internal/httpapi/insights.go:22" } }, "/admin/v1/stats/overview": { "get": { "operationId": "get_admin_v1_stats_overview", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "series": { "items": { "$ref": "#/components/schemas/store_DailyStat" }, "type": [ "array", "null" ] }, "today": { "$ref": "#/components/schemas/store_DailyStat" }, "totals": { "$ref": "#/components/schemas/store_DailyStat" }, "zone": { "type": "string" } }, "required": [ "series", "today", "totals", "zone" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "statsOverview", "tags": [ "Administration" ], "x-source": "internal/httpapi/settings.go:17" } }, "/admin/v1/stats/sites": { "get": { "operationId": "get_admin_v1_stats_sites", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "day": { "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/store_SiteStat" }, "type": [ "array", "null" ] }, "zone": { "type": "string" } }, "required": [ "day", "items", "zone" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "statsSites", "tags": [ "Administration" ], "x-source": "internal/httpapi/settings.go:18" } }, "/admin/v1/version": { "get": { "operationId": "get_admin_v1_version", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "build": { "$ref": "#/components/schemas/httpapi_buildVersion" }, "cap": { "properties": { "commit": { "type": "string" }, "version": { "type": "string" } }, "required": [ "commit", "version" ], "type": "object" }, "engine": { "type": "string" }, "schema": { "type": "integer" } }, "required": [ "build", "cap", "engine", "schema" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "AdminSession": [] } ], "summary": "version", "tags": [ "Administration" ], "x-source": "internal/httpapi/settings.go:14" } }, "/healthz": { "get": { "operationId": "get_healthz", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "stage": { "type": "string" }, "status": { "type": "string" } }, "required": [ "stage", "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "ready", "tags": [ "Public API" ], "x-source": "internal/httpapi/settings.go:13" } }, "/livez": { "get": { "operationId": "getLiveness", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "stage": { "type": "string" }, "status": { "type": "string" } }, "required": [ "stage", "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "inline", "tags": [ "Public API" ], "x-source": "internal/httpapi/server.go:162" } }, "/openapi.json": { "get": { "operationId": "get_openapi.json", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "openAPIJSON", "tags": [ "Public API" ], "x-source": "internal/httpapi/openapi.go:14" } }, "/openapi.yaml": { "get": { "operationId": "get_openapi.yaml", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "openAPIYAML", "tags": [ "Public API" ], "x-source": "internal/httpapi/openapi.go:15" } }, "/public/v1/capabilities": { "get": { "operationId": "get_public_v1_capabilities", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "grants_customer_access": { "type": "boolean" }, "methods_by_version": { "additionalProperties": { "type": "string" }, "type": [ "object", "null" ] }, "observed_health": { "type": "boolean" }, "profiles": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "protocol": { "type": "integer" }, "scope": { "type": "string" }, "widget_versions": { "items": { "type": "string" }, "type": [ "array", "null" ] } }, "required": [ "grants_customer_access", "methods_by_version", "observed_health", "profiles", "protocol", "scope", "widget_versions" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "publicSiteCapabilities", "tags": [ "Public API" ], "x-source": "internal/httpapi/public_inquiries.go:15" } }, "/public/v1/inquiries": { "post": { "description": "Same-origin JSON contact form, rate limited and bounded No uploads Public response contains stored boolean only Inbox is installation-owner-only", "operationId": "post_public_v1_inquiries", "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "stored": { "type": "boolean" } }, "required": [ "stored" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "inquiryCreate", "tags": [ "Public API" ], "x-source": "internal/httpapi/public_inquiries.go:12" } }, "/readyz": { "get": { "operationId": "get_readyz", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "stage": { "type": "string" }, "status": { "type": "string" } }, "required": [ "stage", "status" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "ready", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:29" } }, "/v1/accounts/accept-invitation": { "post": { "description": "Public same-origin-only invitation acceptance Requires Sec-Fetch-Site same-origin and an Origin or Referer matching this host Consumes the invitation exactly once before expiry Sets a password without issuing a login session Ordinary login and configured MFA remain required No browser CORS grant", "operationId": "post_v1_accounts_accept_invitation", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "password": { "maxLength": 128, "minLength": 12, "type": "string", "writeOnly": true }, "token": { "maxLength": 256, "minLength": 32, "type": "string" }, "username": { "pattern": "^[a-z][a-z0-9._-]{2,31}$", "type": "string" } }, "required": [ "token", "username", "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "activated": { "type": "boolean" } }, "required": [ "activated" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "acceptCustomer", "tags": [ "Public API" ], "x-source": "internal/httpapi/commerce.go:38" } }, "/v1/capabilities": { "get": { "operationId": "get_v1_capabilities", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "providers": { "items": { "$ref": "#/components/schemas/adapter_Descriptor" }, "type": [ "array", "null" ] }, "stage": { "type": "string" } }, "required": [ "providers", "stage" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "capabilities", "tags": [ "Public API" ], "x-source": "internal/httpapi/server.go:182" } }, "/v1/intents": { "post": { "description": "Requires intents:create scope Business payload canonicalization and business idempotency remain the integrating backend's responsibility", "operationId": "post_v1_intents", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "action": { "type": "string" }, "binding_version": { "const": "jcs-v1", "type": "string" }, "expires_in_seconds": { "default": 300, "maximum": 600, "minimum": 30, "type": "integer" }, "request_hash": { "pattern": "^sha256:[a-f0-9]{64}$", "type": "string" }, "site_id": { "type": "string" } }, "required": [ "site_id", "action", "request_hash", "binding_version" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_Intent" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "BackendBearer": [] } ], "summary": "createIntent", "tags": [ "Public API" ], "x-required-scopes": [ "intents:create" ], "x-source": "internal/httpapi/routes.go:68" } }, "/v1/plans": { "get": { "description": "Public projection of the four canonical tiers only Includes pending prices and allowances but no tenant, invoice, secret, revision or private custom plan data Checkout is not configured", "operationId": "get_v1_plans", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "payment_configured": { "type": "boolean" }, "plans": { "items": { "$ref": "#/components/schemas/store_PublicPlan" }, "type": [ "array", "null" ] } }, "required": [ "payment_configured", "plans" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [], "summary": "publicPlans", "tags": [ "Public API" ], "x-source": "internal/httpapi/commerce.go:27" } }, "/v1/sessions": { "post": { "description": "Origin must be explicitly allowed by the site Browser capability claims never select a weaker provider", "operationId": "post_v1_sessions", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "client_capabilities": { "description": "Arbitrary JSON evidence or forwarded provider payload" }, "intent_id": { "type": "string" }, "locale": { "type": "string" } }, "required": [ "intent_id" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_SessionIssue" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [] } ], "summary": "createSession", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:69" } }, "/v1/sessions/{id}/altcha/challenge": { "post": { "operationId": "post_v1_sessions_id_altcha_challenge", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "altchaChallenge", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:90" } }, "/v1/sessions/{id}/altcha/verify": { "post": { "operationId": "post_v1_sessions_id_altcha_verify", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "payload": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "verified": { "type": "boolean" } }, "required": [ "verified" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "altchaVerify", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:91" } }, "/v1/sessions/{id}/cap/challenge": { "post": { "operationId": "post_v1_sessions_id_cap_challenge", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "capChallenge", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:71" } }, "/v1/sessions/{id}/cap/redeem": { "post": { "operationId": "post_v1_sessions_id_cap_redeem", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Arbitrary JSON evidence or forwarded provider payload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "capRedeem", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:72" } }, "/v1/sessions/{id}/captchapro/data": { "post": { "description": "Optional native image width excluding the 20px shell padding Default 280, bounded 200 through 280, with proportional height The method remains pinned to the session", "operationId": "post_v1_sessions_id_captchapro_data", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "width": { "maximum": 280, "minimum": 200, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "captchaProData", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:82" } }, "/v1/sessions/{id}/captchapro/verify": { "post": { "operationId": "post_v1_sessions_id_captchapro_verify", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "captchaProVerify", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:83" } }, "/v1/sessions/{id}/complete": { "post": { "description": "Complete the already-pinned provider session One-use provider success becomes a short-lived opaque DigiCaptcha receipt UPSTREAM_RESULT_UNKNOWN must not cause blind re-verification", "operationId": "post_v1_sessions_id_complete", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "provider_evidence": { "description": "Arbitrary JSON evidence or forwarded provider payload" } }, "required": [ "provider_evidence" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "complete", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:73" } }, "/v1/sessions/{id}/digitalcaptcha/challenge": { "post": { "operationId": "post_v1_sessions_id_digitalcaptcha_challenge", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "digitalCaptchaChallenge", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:80" } }, "/v1/sessions/{id}/digitalcaptcha/check": { "post": { "description": "Submit ordered points or a sum answer for the pinned method Versioned widget policies also require pow_payload against the exact issued signed work challenge The browser cannot change the widget edition, method or difficulty", "operationId": "post_v1_sessions_id_digitalcaptcha_check", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "answer": { "type": "string" }, "challenge_id": { "type": "string" }, "points": { "items": { "$ref": "#/components/schemas/digitalcaptcha_Point" }, "type": [ "array", "null" ] }, "pow_payload": { "type": "string" } }, "required": [ "challenge_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "digitalCaptchaCheck", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:81" } }, "/v1/sessions/{id}/fcaptcha/api/pow/challenge": { "get": { "operationId": "get_v1_sessions_id_fcaptcha_api_pow_challenge", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "fcaptchaChallenge", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:76" } }, "/v1/sessions/{id}/fcaptcha/api/verify": { "post": { "operationId": "post_v1_sessions_id_fcaptcha_api_verify", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "fcaptchaVerify", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:77" } }, "/v1/sessions/{id}/gocaptcha/check": { "post": { "operationId": "post_v1_sessions_id_gocaptcha_check", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "captchaKey": { "type": "string" }, "value": { "type": "string" } }, "required": [ "captchaKey", "value" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "goCaptchaCheck", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:79" } }, "/v1/sessions/{id}/gocaptcha/data": { "post": { "operationId": "post_v1_sessions_id_gocaptcha_data", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "goCaptchaData", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:78" } }, "/v1/sessions/{id}/iconcaptcha": { "post": { "operationId": "post_v1_sessions_id_iconcaptcha", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "iconProxy", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:84" } }, "/v1/sessions/{id}/mcaptcha/config": { "post": { "operationId": "post_v1_sessions_id_mcaptcha_config", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "mcaptchaConfig", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:87" } }, "/v1/sessions/{id}/mcaptcha/frame": { "post": { "operationId": "post_v1_sessions_id_mcaptcha_frame", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "frame": { "type": "string" } }, "required": [ "frame" ], "type": "object" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "mcaptchaFrameIssue", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:89" } }, "/v1/sessions/{id}/mcaptcha/verify": { "post": { "operationId": "post_v1_sessions_id_mcaptcha_verify", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "nonce": { "type": "integer" }, "result": { "type": "string" }, "string": { "type": "string" }, "time": { "type": "integer" }, "worker_type": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "mcaptchaVerify", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:88" } }, "/v1/sessions/{id}/mosparo/api/v1/frontend/{action}": { "post": { "operationId": "post_v1_sessions_id_mosparo_api_v1_frontend_action", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "action", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "mosparoFrontend", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:85" } }, "/v1/sessions/{id}/wicketkeeper/challenge": { "post": { "operationId": "post_v1_sessions_id_wicketkeeper_challenge", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Origin", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Pinned provider or gateway result See the source-specific protocol; an upstream success alone is not a DigiCaptcha receipt" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "PublicSiteKey": [], "SessionToken": [] } ], "summary": "wicketkeeperChallenge", "tags": [ "Public API" ], "x-source": "internal/httpapi/routes.go:75" } }, "/v1/siteverify": { "post": { "description": "Requires receipts:verify scope Atomic one-use receipt consumption Same idempotency key and same binding recover the same operation result, never a second verification", "operationId": "post_v1_siteverify", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "action": { "type": "string" }, "intent_id": { "type": "string" }, "receipt": { "type": "string" }, "request_hash": { "type": "string" } }, "required": [ "receipt", "intent_id", "action", "request_hash" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_Verification" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "BackendBearer": [] } ], "summary": "siteverify", "tags": [ "Public API" ], "x-required-scopes": [ "receipts:verify" ], "x-source": "internal/httpapi/routes.go:122" } }, "/v1/stats": { "get": { "description": "Read-only per-site statistics credential; separate from server verification keys", "operationId": "get_v1_stats", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store_PublicStats" } } }, "description": "JSON result" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/httpapi_errorBody" } } }, "description": "Failure is closed; UPSTREAM_RESULT_UNKNOWN must not trigger a new provider dispatch" } }, "security": [ { "StatsBearer": [] } ], "summary": "publicStats", "tags": [ "Public API" ], "x-source": "internal/httpapi/insights.go:33" } } }, "security": [], "servers": [ { "url": "/" } ], "x-generation": { "command": "go run ./tools/contractgen", "limitations": "Provider passthrough payloads and runtime diagnostic maps are intentionally open JSON; source-derived fields do not imply a completed provider acceptance test", "source": "registered net/http routes and Go JSON tags" } }