{ "openapi": "3.1.0", "info": { "title": "Esheria Regulatory API", "version": "1.0.0", "description": "Citation-backed regulatory pack API for pack discovery, obligations, applicability checks, version history, diffs, change events, evidence requirements, filing rules, penalty facts, legal review audit metadata, graph queries, and claim verification." }, "paths": { "/healthz": { "get": { "summary": "Healthz", "operationId": "healthz_healthz_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "tags": [ "Operations" ], "security": [] } }, "/readyz": { "get": { "summary": "Readyz", "operationId": "readyz_readyz_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "tags": [ "Operations" ], "security": [] } }, "/metrics": { "get": { "summary": "Metrics", "operationId": "metrics_metrics_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "tags": [ "Operations" ], "security": [] } }, "/.well-known/oauth-protected-resource": { "get": { "summary": "Oauth Protected Resource Metadata", "operationId": "oauth_protected_resource_metadata__well_known_oauth_protected_resource_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/.well-known/oauth-authorization-server": { "get": { "summary": "Oauth Authorization Server Metadata", "operationId": "oauth_authorization_server_metadata__well_known_oauth_authorization_server_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/register": { "post": { "summary": "Oauth Register", "operationId": "oauth_register_register_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/authorize": { "get": { "summary": "Oauth Authorize", "operationId": "oauth_authorize_authorize_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/token": { "post": { "summary": "Oauth Token", "operationId": "oauth_token_token_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/revoke": { "post": { "summary": "Oauth Revoke", "operationId": "oauth_revoke_revoke_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/oauth/introspect": { "get": { "summary": "Oauth Introspect", "operationId": "oauth_introspect_api_v1_oauth_introspect_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/admin/oauth/claude/requests/{authorization_request_id}": { "get": { "summary": "Get Oauth Authorization Request", "operationId": "get_oauth_authorization_request_api_v1_admin_oauth_claude_requests__authorization_request_id__get", "parameters": [ { "name": "authorization_request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Authorization Request Id" } }, { "name": "X-Billing-Admin-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Billing-Admin-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/oauth/claude/requests/{authorization_request_id}/approve": { "post": { "summary": "Approve Oauth Authorization Request", "operationId": "approve_oauth_authorization_request_api_v1_admin_oauth_claude_requests__authorization_request_id__approve_post", "parameters": [ { "name": "authorization_request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Authorization Request Id" } }, { "name": "X-Billing-Admin-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Billing-Admin-Key" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/admin/oauth/claude/requests/{authorization_request_id}/deny": { "post": { "summary": "Deny Oauth Authorization Request", "operationId": "deny_oauth_authorization_request_api_v1_admin_oauth_claude_requests__authorization_request_id__deny_post", "parameters": [ { "name": "authorization_request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Authorization Request Id" } }, { "name": "X-Billing-Admin-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Billing-Admin-Key" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v1/workspace": { "get": { "tags": [ "Workspace" ], "summary": "Get the current workspace", "operationId": "get_workspace_api_v1_workspace_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Update the current workspace settings", "operationId": "update_workspace_api_v1_workspace_patch", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/tokens": { "post": { "tags": [ "API Tokens" ], "summary": "Create a data API token", "operationId": "create_api_token_api_v1_tokens_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiTokenCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] }, "get": { "tags": [ "API Tokens" ], "summary": "List workspace API tokens", "operationId": "list_api_tokens_api_v1_tokens_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "token_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Token Type" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/tokens/{token_id}/revoke": { "post": { "tags": [ "API Tokens" ], "summary": "Revoke an API token", "operationId": "revoke_api_token_api_v1_tokens__token_id__revoke_post", "parameters": [ { "name": "token_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Token Id" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/billing/balance": { "get": { "tags": [ "Billing" ], "summary": "Get workspace credit balance", "operationId": "billing_balance_api_v1_billing_balance_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/billing/usage": { "get": { "tags": [ "Billing" ], "summary": "List metered API usage", "operationId": "billing_usage_api_v1_billing_usage_get", "parameters": [ { "name": "token_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Token Id" } }, { "name": "endpoint_family", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Endpoint Family" } }, { "name": "pack_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pack Id" } }, { "name": "date_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date From" } }, { "name": "date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date To" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/billing/plans": { "get": { "tags": [ "Billing" ], "summary": "List available billing plans", "operationId": "billing_plans_api_v1_billing_plans_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/billing/topups/checkout-session": { "post": { "tags": [ "Billing" ], "summary": "Create a Stripe Checkout session for credits or subscription", "operationId": "create_billing_checkout_session_api_v1_billing_topups_checkout_session_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCheckoutSessionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/billing/subscription": { "get": { "tags": [ "Billing" ], "summary": "Get the current workspace subscription", "operationId": "billing_subscription_api_v1_billing_subscription_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/billing/subscription/cancel": { "post": { "tags": [ "Billing" ], "summary": "Cancel the current workspace subscription", "operationId": "cancel_billing_subscription_api_v1_billing_subscription_cancel_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSubscriptionCancelRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/legal-status/verify-claim": { "post": { "tags": [ "Regulatory Pack API" ], "summary": "Verify a legal claim against a selected regulatory pack", "operationId": "verify_legal_status_claim_api_v1_legal_status_verify_claim_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalStatusVerifyClaimRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/domain-packs": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "List current regulatory domain packs", "operationId": "list_domain_packs_api_v1_domain_packs_get", "parameters": [ { "name": "jurisdiction", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Jurisdiction" } }, { "name": "legal_domain", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Legal Domain" } }, { "name": "domain", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "readiness_label", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Readiness Label" } }, { "name": "is_current", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true, "title": "Is Current" } }, { "name": "detail", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^(summary|full)$" }, { "type": "null" } ], "title": "Detail" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "Inspect a regulatory domain pack summary", "operationId": "get_domain_pack_api_v1_domain_packs__pack_id__get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/versions": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "List historical versions for a regulatory domain pack", "operationId": "list_domain_pack_versions_api_v1_domain_packs__pack_id__versions_get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/diff": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "Diff canonical facts between two regulatory domain pack versions", "operationId": "diff_domain_pack_versions_api_v1_domain_packs__pack_id__diff_get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "name": "from_version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Version" } }, { "name": "to_version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To Version" } }, { "name": "publication_mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publication Mode" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/change-events": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "List stored or generated legal change events for a regulatory domain pack", "operationId": "domain_pack_change_events_api_v1_domain_packs__pack_id__change_events_get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "name": "from_version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From Version" } }, { "name": "to_version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To Version" } }, { "name": "publication_mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publication Mode" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/obligations": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "List published obligations for a regulatory domain pack", "operationId": "list_domain_pack_obligations_api_v1_domain_packs__pack_id__obligations_get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, { "name": "publication_mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publication Mode" } }, { "name": "duty_holder", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duty Holder" } }, { "name": "workflow_target", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Target" } }, { "name": "instrument_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrument Id" } }, { "name": "evidence_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence Type" } }, { "name": "fact_class", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fact Class" } }, { "name": "customer_actionability", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Actionability" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/applicability-check": { "post": { "tags": [ "Regulatory Pack API" ], "summary": "Check which obligations potentially apply to an entity profile", "operationId": "domain_pack_applicability_check_api_v1_domain_packs__pack_id__applicability_check_post", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainPackApplicabilityCheckRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/filing-calendar": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "Return regulatory filing and deadline calendar items", "operationId": "domain_pack_filing_calendar_api_v1_domain_packs__pack_id__filing_calendar_get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, { "name": "publication_mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publication Mode" } }, { "name": "duty_holder", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duty Holder" } }, { "name": "workflow_target", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Target" } }, { "name": "instrument_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrument Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/evidence-register": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "Return evidence requirements grouped by evidence type", "operationId": "domain_pack_evidence_register_api_v1_domain_packs__pack_id__evidence_register_get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, { "name": "publication_mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publication Mode" } }, { "name": "duty_holder", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duty Holder" } }, { "name": "workflow_target", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Target" } }, { "name": "instrument_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instrument Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/penalty-facts": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "Return source-traced penalty and consequence facts", "operationId": "domain_pack_penalty_facts_api_v1_domain_packs__pack_id__penalty_facts_get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, { "name": "publication_mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publication Mode" } }, { "name": "regulator_or_enforcer", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regulator Or Enforcer" } }, { "name": "consequence_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consequence Type" } }, { "name": "linked_obligation_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Linked Obligation Id" } }, { "name": "linked_provision_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Linked Provision Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/legal-review-audit": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "Return canonical legal review and publication audit metadata", "operationId": "domain_pack_legal_review_audit_api_v1_domain_packs__pack_id__legal_review_audit_get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, { "name": "publication_mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publication Mode" } }, { "name": "review_decision", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Review Decision" } }, { "name": "promotion_state", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Promotion State" } }, { "name": "promotion_tier", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Promotion Tier" } }, { "name": "fact_class", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fact Class" } }, { "name": "customer_actionability", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Actionability" } }, { "name": "duty_holder_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duty Holder Type" } }, { "name": "audience_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Audience Type" } }, { "name": "operability_class", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Operability Class" } }, { "name": "qa_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Qa Status" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/relationships": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "Return published relationship facts involving a regulatory domain pack", "operationId": "domain_pack_relationships_api_v1_domain_packs__pack_id__relationships_get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, { "name": "publication_mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publication Mode" } }, { "name": "relationship_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relationship Type" } }, { "name": "source_pack_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Pack Id" } }, { "name": "target_pack_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Pack Id" } }, { "name": "evidence_basis", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evidence Basis" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/domain-packs/{pack_id}/export": { "get": { "tags": [ "Regulatory Pack API" ], "summary": "Export the published regulatory pack", "operationId": "domain_pack_export_api_v1_domain_packs__pack_id__export_get", "parameters": [ { "name": "pack_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pack Id" } }, { "name": "version", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, { "name": "publication_mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publication Mode" } }, { "name": "include_all_forms", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include All Forms" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/regulatory-graph/query": { "post": { "tags": [ "Regulatory Graph API" ], "summary": "Query published regulatory relationship facts across packs", "operationId": "regulatory_graph_query_api_v1_regulatory_graph_query_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryGraphQueryRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/regulatory-graph/applicability-check": { "post": { "tags": [ "Regulatory Graph API" ], "summary": "Return pack applicability results with published relationship context", "operationId": "regulatory_graph_applicability_check_api_v1_regulatory_graph_applicability_check_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryGraphApplicabilityCheckRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/regulatory-graph/entity-profile": { "get": { "tags": [ "Regulatory Graph API" ], "summary": "Summarize entity profile context from published pack and relationship facts", "operationId": "regulatory_graph_entity_profile_api_v1_regulatory_graph_entity_profile_get", "parameters": [ { "name": "pack_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Pack Ids" } }, { "name": "entity_roles", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Entity Roles" } }, { "name": "activities", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Activities" } }, { "name": "sector_tags", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Sector Tags" } }, { "name": "publication_mode", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publication Mode" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/regulatory-monitoring/source-watches": { "post": { "tags": [ "Regulatory Monitoring API" ], "summary": "Create or update a regulatory source watch", "operationId": "create_source_watch_api_v1_regulatory_monitoring_source_watches_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceWatchCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] }, "get": { "tags": [ "Regulatory Monitoring API" ], "summary": "List configured regulatory source watches", "operationId": "list_source_watches_api_v1_regulatory_monitoring_source_watches_get", "parameters": [ { "name": "domain_pack_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain Pack Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "source_kind", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Kind" } }, { "name": "authority_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authority Type" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/regulatory-monitoring/source-currentness": { "get": { "tags": [ "Regulatory Monitoring API" ], "summary": "List source currentness from the latest monitoring snapshots", "operationId": "source_currentness_api_v1_regulatory_monitoring_source_currentness_get", "parameters": [ { "name": "domain_pack_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain Pack Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/regulatory-monitoring/source-watches/check": { "post": { "tags": [ "Regulatory Monitoring API" ], "summary": "Run source snapshot and change detection for configured watches", "operationId": "check_source_watches_api_v1_regulatory_monitoring_source_watches_check_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceWatchCheckRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/regulatory-monitoring/source-change-events": { "get": { "tags": [ "Regulatory Monitoring API" ], "summary": "List recorded regulatory source-change events", "operationId": "list_source_change_events_api_v1_regulatory_monitoring_source_change_events_get", "parameters": [ { "name": "domain_pack_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain Pack Id" } }, { "name": "source_kind", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Kind" } }, { "name": "authority_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authority Type" } }, { "name": "change_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Change Type" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/regulatory-monitoring/recompile-candidates": { "get": { "tags": [ "Regulatory Monitoring API" ], "summary": "List source or fact changes queued for regulatory pack recompile", "operationId": "list_recompile_candidates_api_v1_regulatory_monitoring_recompile_candidates_get", "parameters": [ { "name": "domain_pack_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain Pack Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "candidate_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Candidate Type" } }, { "name": "priority", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Priority" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/regulatory-graph/projections/rebuild": { "post": { "tags": [ "Regulatory Graph API" ], "summary": "Rebuild published regulatory graph projections from serving facts", "operationId": "rebuild_graph_projection_api_v1_regulatory_graph_projections_rebuild_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GraphProjectionRebuildRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/regulatory-graph/coverage": { "get": { "tags": [ "Regulatory Graph API" ], "summary": "Return graph node coverage for published regulatory facts", "operationId": "regulatory_graph_coverage_api_v1_regulatory_graph_coverage_get", "parameters": [ { "name": "domain_pack_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain Pack Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/customer-lifecycle/preview": { "post": { "tags": [ "Customer Applicability API" ], "summary": "Preview customer applicability and change impacts without storing customer state", "operationId": "preview_customer_lifecycle_api_v1_customer_lifecycle_preview_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerLifecyclePreviewRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/customer-profiles": { "post": { "tags": [ "Customer Applicability API" ], "summary": "Create a workspace-scoped customer regulatory profile", "operationId": "create_customer_profile_api_v1_customer_profiles_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerProfileCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] }, "get": { "tags": [ "Customer Applicability API" ], "summary": "List workspace-scoped customer regulatory profiles", "operationId": "list_customer_profiles_api_v1_customer_profiles_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/customer-profiles/{customer_profile_id}": { "get": { "tags": [ "Customer Applicability API" ], "summary": "Inspect a workspace-scoped customer regulatory profile", "operationId": "get_customer_profile_api_v1_customer_profiles__customer_profile_id__get", "parameters": [ { "name": "customer_profile_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Customer Profile Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/customer-profiles/{customer_profile_id}/applicability-runs": { "post": { "tags": [ "Customer Applicability API" ], "summary": "Run and persist customer-specific applicability against locked pack versions", "operationId": "run_customer_applicability_api_v1_customer_profiles__customer_profile_id__applicability_runs_post", "parameters": [ { "name": "customer_profile_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Customer Profile Id" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApplicabilityRunRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "get": { "tags": [ "Customer Applicability API" ], "summary": "List persisted customer-specific applicability runs", "operationId": "list_customer_applicability_runs_api_v1_customer_profiles__customer_profile_id__applicability_runs_get", "parameters": [ { "name": "customer_profile_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Customer Profile Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/customer-obligation-instances": { "get": { "tags": [ "Customer Applicability API" ], "summary": "List workspace customer obligation instances that reference published facts", "operationId": "list_customer_obligation_instances_api_v1_customer_obligation_instances_get", "parameters": [ { "name": "customer_profile_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Profile Id" } }, { "name": "domain_pack_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain Pack Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "applicability_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Applicability Status" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/customer-obligation-instances/{customer_obligation_instance_id}": { "patch": { "tags": [ "Customer Applicability API" ], "summary": "Update tenant-owned lifecycle state for a customer obligation instance", "operationId": "update_customer_obligation_instance_api_v1_customer_obligation_instances__customer_obligation_instance_id__patch", "parameters": [ { "name": "customer_obligation_instance_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Customer Obligation Instance Id" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerObligationInstanceUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/customer-change-impacts/recompute": { "post": { "tags": [ "Customer Applicability API" ], "summary": "Recompute customer impacts from pack change events", "operationId": "recompute_customer_change_impacts_api_v1_customer_change_impacts_recompute_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerChangeImpactRecomputeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" } ] } }, "/api/v1/customer-change-impacts": { "get": { "tags": [ "Customer Applicability API" ], "summary": "List workspace customer change impacts", "operationId": "list_customer_change_impacts_api_v1_customer_change_impacts_get", "parameters": [ { "name": "customer_profile_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Profile Id" } }, { "name": "domain_pack_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain Pack Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "impact_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Impact Type" } }, { "name": "materiality", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Materiality" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/api/v1/customer-change-impacts/{customer_change_impact_id}": { "patch": { "tags": [ "Customer Applicability API" ], "summary": "Update tenant-owned lifecycle state for a customer change impact", "operationId": "update_customer_change_impact_api_v1_customer_change_impacts__customer_change_impact_id__patch", "parameters": [ { "name": "customer_change_impact_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Customer Change Impact Id" } }, { "$ref": "#/components/parameters/IdempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerChangeImpactUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "unauthorized", "message": "Invalid API key" } ], "trace_id": "trace-123" } } } }, "402": { "description": "Credits exhausted", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "credits_exhausted", "message": "API credits exhausted" } ], "trace_id": "trace-123" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "duplicate_token_name", "message": "An active data token already uses that name." } ], "trace_id": "trace-123" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "validation_error", "message": "Invalid payload", "field": "body.name" } ], "trace_id": "trace-123" } } } }, "503": { "description": "Billing or dependency unavailable", "content": { "application/json": { "example": { "status": "error", "errors": [ { "code": "billing_unavailable", "message": "Billing ledger is unavailable" } ], "trace_id": "trace-123" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } } }, "components": { "schemas": { "ApiTokenCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 2, "title": "Name" }, "scopes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Scopes" }, "pack_entitlements": { "items": { "type": "string" }, "type": "array", "title": "Pack Entitlements" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "ApiTokenCreateRequest", "example": { "name": "Production data token", "pack_entitlements": [ "UK-DATA-PROTECTION-PRIVACY" ] } }, "BillingCheckoutSessionRequest": { "properties": { "sku_id": { "type": "string", "maxLength": 120, "minLength": 2, "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$", "title": "Sku Id" } }, "additionalProperties": false, "type": "object", "required": [ "sku_id" ], "title": "BillingCheckoutSessionRequest", "example": { "sku_id": "developer-topup-1000" } }, "BillingSubscriptionCancelRequest": { "properties": { "cancel_at_period_end": { "type": "boolean", "title": "Cancel At Period End", "default": false } }, "additionalProperties": false, "type": "object", "title": "BillingSubscriptionCancelRequest", "example": { "cancel_at_period_end": false } }, "CustomerApplicabilityRunRequest": { "properties": { "pack_ids": { "items": { "type": "string" }, "type": "array", "title": "Pack Ids" }, "locked_pack_versions": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Locked Pack Versions" }, "entity_roles": { "items": { "type": "string" }, "type": "array", "title": "Entity Roles" }, "activities": { "items": { "type": "string" }, "type": "array", "title": "Activities" }, "sector_tags": { "items": { "type": "string" }, "type": "array", "title": "Sector Tags" }, "processing_characteristics": { "items": { "type": "string" }, "type": "array", "title": "Processing Characteristics" }, "entity_profile": { "additionalProperties": true, "type": "object", "title": "Entity Profile" }, "profile_facts": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Profile Facts" }, "limit": { "type": "integer", "maximum": 500.0, "minimum": 1.0, "title": "Limit", "default": 100 } }, "additionalProperties": false, "type": "object", "title": "CustomerApplicabilityRunRequest", "example": { "limit": 100, "pack_ids": [ "UK-DATA-PROTECTION-PRIVACY", "EU-GDPR-DATA-PROTECTION" ] } }, "CustomerChangeImpactRecomputeRequest": { "properties": { "customer_profile_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Customer Profile Id" }, "domain_pack_id": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "Domain Pack Id" }, "status": { "anyOf": [ { "type": "string", "maxLength": 80 }, { "type": "null" } ], "title": "Status" }, "from_version": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "From Version" }, "to_version": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "To Version" }, "limit": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "title": "Limit", "default": 500 } }, "additionalProperties": false, "type": "object", "title": "CustomerChangeImpactRecomputeRequest", "example": { "customer_profile_id": "11111111-1111-1111-1111-111111111111", "domain_pack_id": "UK-DATA-PROTECTION-PRIVACY", "status": "open" } }, "CustomerChangeImpactUpdateRequest": { "properties": { "status": { "type": "string", "enum": [ "open", "acknowledged", "resolved", "dismissed" ], "title": "Status" }, "status_reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ], "title": "Status Reason" }, "status_updated_by": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "Status Updated By" }, "resolution_payload": { "additionalProperties": true, "type": "object", "title": "Resolution Payload" } }, "additionalProperties": false, "type": "object", "required": [ "status" ], "title": "CustomerChangeImpactUpdateRequest", "example": { "resolution_payload": { "ticket_id": "COMP-43" }, "status": "acknowledged", "status_reason": "Reviewed by compliance lead.", "status_updated_by": "usr_123" } }, "CustomerLifecyclePreviewRequest": { "properties": { "pack_ids": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Pack Ids" }, "locked_pack_versions": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Locked Pack Versions" }, "entity_roles": { "items": { "type": "string" }, "type": "array", "title": "Entity Roles" }, "activities": { "items": { "type": "string" }, "type": "array", "title": "Activities" }, "sector_tags": { "items": { "type": "string" }, "type": "array", "title": "Sector Tags" }, "processing_characteristics": { "items": { "type": "string" }, "type": "array", "title": "Processing Characteristics" }, "entity_profile": { "additionalProperties": true, "type": "object", "title": "Entity Profile" }, "profile_facts": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Profile Facts" }, "include_change_impacts": { "type": "boolean", "title": "Include Change Impacts", "default": true }, "from_version": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "From Version" }, "to_version": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "To Version" }, "limit": { "type": "integer", "maximum": 500.0, "minimum": 1.0, "title": "Limit", "default": 100 } }, "additionalProperties": false, "type": "object", "required": [ "pack_ids" ], "title": "CustomerLifecyclePreviewRequest", "example": { "activities": [ "personal_data_processing" ], "entity_profile": { "entity_types": [ "data_controller" ], "jurisdictions": [ "UK", "EU" ], "regulated_activities": [ "personal_data_processing" ] }, "entity_roles": [ "data_controller" ], "include_change_impacts": true, "limit": 100, "pack_ids": [ "UK-DATA-PROTECTION-PRIVACY", "EU-GDPR-DATA-PROTECTION" ], "sector_tags": [ "financial_services" ] } }, "CustomerObligationInstanceUpdateRequest": { "properties": { "status": { "anyOf": [ { "type": "string", "enum": [ "candidate", "accepted", "not_applicable", "monitoring", "retired" ] }, { "type": "null" } ], "title": "Status" }, "owner_user_id": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "Owner User Id" }, "owner_label": { "anyOf": [ { "type": "string", "maxLength": 240 }, { "type": "null" } ], "title": "Owner Label" }, "due_date": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ], "title": "Due Date" }, "priority": { "anyOf": [ { "type": "string", "enum": [ "low", "normal", "high", "urgent" ] }, { "type": "null" } ], "title": "Priority" }, "status_reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ], "title": "Status Reason" }, "status_updated_by": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "Status Updated By" }, "lifecycle_metadata": { "additionalProperties": true, "type": "object", "title": "Lifecycle Metadata" } }, "additionalProperties": false, "type": "object", "title": "CustomerObligationInstanceUpdateRequest", "example": { "due_date": "2026-07-31", "lifecycle_metadata": { "ticket_id": "COMP-42" }, "owner_label": "Compliance lead", "owner_user_id": "usr_123", "priority": "high", "status": "monitoring", "status_reason": "Accepted into the compliance work queue." } }, "CustomerProfileCreateRequest": { "properties": { "profile_name": { "type": "string", "maxLength": 200, "minLength": 2, "title": "Profile Name" }, "default_pack_ids": { "items": { "type": "string" }, "type": "array", "title": "Default Pack Ids" }, "entity_profile": { "additionalProperties": true, "type": "object", "title": "Entity Profile" }, "profile_facts": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Profile Facts" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "additionalProperties": false, "type": "object", "required": [ "profile_name" ], "title": "CustomerProfileCreateRequest", "example": { "default_pack_ids": [ "UK-DATA-PROTECTION-PRIVACY", "EU-GDPR-DATA-PROTECTION" ], "entity_profile": { "entity_roles": [ "data_controller", "company" ], "regulated_activities": [ "personal_data_processing" ], "sector_tags": [ "financial_services" ] }, "profile_facts": [ { "confidence": 1.0, "fact_type": "entity_role", "source": "customer_attestation", "value": "data_controller" } ], "profile_name": "Acme UK and EU fintech" } }, "DomainPackApplicabilityCheckRequest": { "properties": { "entity_roles": { "items": { "type": "string" }, "type": "array", "title": "Entity Roles" }, "activities": { "items": { "type": "string" }, "type": "array", "title": "Activities" }, "sector_tags": { "items": { "type": "string" }, "type": "array", "title": "Sector Tags" }, "processing_characteristics": { "items": { "type": "string" }, "type": "array", "title": "Processing Characteristics" }, "entity_profile": { "additionalProperties": true, "type": "object", "title": "Entity Profile" }, "profile_facts": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Profile Facts" }, "include_non_matches": { "type": "boolean", "title": "Include Non Matches", "default": false }, "publication_mode": { "anyOf": [ { "type": "string", "enum": [ "published", "citation_verified", "draft", "semantic_draft" ] }, { "type": "null" } ], "title": "Publication Mode" }, "domain_pack_version": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "Domain Pack Version" }, "limit": { "type": "integer", "maximum": 500.0, "minimum": 1.0, "title": "Limit", "default": 100 } }, "additionalProperties": false, "type": "object", "title": "DomainPackApplicabilityCheckRequest", "example": { "activities": [ "personal_data_processing" ], "entity_profile": { "data_categories": [ "customer_personal_data" ], "entity_types": [ "company", "data_controller" ], "existing_controls": [], "jurisdictions": [ "UK" ], "licences": [], "regulated_activities": [ "personal_data_processing" ], "risk_flags": [] }, "entity_roles": [ "data_controller" ], "limit": 100, "publication_mode": "published", "sector_tags": [ "financial_services" ] } }, "GraphProjectionRebuildRequest": { "properties": { "reason": { "type": "string", "maxLength": 120, "title": "Reason", "default": "manual" }, "requested_by": { "type": "string", "maxLength": 160, "title": "Requested By", "default": "" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "additionalProperties": false, "type": "object", "title": "GraphProjectionRebuildRequest", "example": { "reason": "scheduled_rebuild", "requested_by": "operator" } }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "LegalStatusVerifyClaimRequest": { "properties": { "claim": { "type": "string", "maxLength": 2000, "minLength": 5, "title": "Claim" }, "pack_id": { "type": "string", "maxLength": 120, "minLength": 2, "title": "Pack Id" }, "jurisdiction": { "anyOf": [ { "type": "string", "maxLength": 32, "minLength": 2 }, { "type": "null" } ], "title": "Jurisdiction" }, "domain": { "anyOf": [ { "type": "string", "maxLength": 160, "minLength": 2 }, { "type": "null" } ], "title": "Domain" }, "publication_mode": { "anyOf": [ { "type": "string", "enum": [ "published", "citation_verified", "draft", "semantic_draft" ] }, { "type": "null" } ], "title": "Publication Mode" }, "claimed_instrument_version": { "anyOf": [ { "type": "string", "maxLength": 80 }, { "type": "null" } ], "title": "Claimed Instrument Version" }, "limit": { "type": "integer", "maximum": 10.0, "minimum": 1.0, "title": "Limit", "default": 3 } }, "additionalProperties": false, "type": "object", "required": [ "claim", "pack_id" ], "title": "LegalStatusVerifyClaimRequest", "example": { "claim": "A controller must respond to a valid data subject access request within the applicable statutory period.", "limit": 3, "pack_id": "UK-DATA-PROTECTION-PRIVACY" } }, "RegulatoryGraphApplicabilityCheckRequest": { "properties": { "pack_ids": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Pack Ids" }, "entity_roles": { "items": { "type": "string" }, "type": "array", "title": "Entity Roles" }, "activities": { "items": { "type": "string" }, "type": "array", "title": "Activities" }, "sector_tags": { "items": { "type": "string" }, "type": "array", "title": "Sector Tags" }, "publication_mode": { "anyOf": [ { "type": "string", "enum": [ "published", "citation_verified", "blocked", "draft" ] }, { "type": "null" } ], "title": "Publication Mode" }, "limit": { "type": "integer", "maximum": 500.0, "minimum": 1.0, "title": "Limit", "default": 100 } }, "additionalProperties": false, "type": "object", "required": [ "pack_ids" ], "title": "RegulatoryGraphApplicabilityCheckRequest", "example": { "activities": [ "financial_crime_controls" ], "entity_roles": [ "regulated_firm" ], "limit": 100, "pack_ids": [ "UK-FINANCIAL-CRIME-AML-CTF-SANCTIONS", "EU-AML-SINGLE-RULEBOOK-AMLA" ], "publication_mode": "published", "sector_tags": [ "financial_services" ] } }, "RegulatoryGraphQueryRequest": { "properties": { "pack_ids": { "items": { "type": "string" }, "type": "array", "minItems": 1, "title": "Pack Ids" }, "relationship_types": { "items": { "type": "string" }, "type": "array", "title": "Relationship Types" }, "source_pack_id": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Source Pack Id" }, "target_pack_id": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Target Pack Id" }, "evidence_basis": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Evidence Basis" }, "query": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Query" }, "publication_mode": { "anyOf": [ { "type": "string", "enum": [ "published", "citation_verified", "blocked", "draft" ] }, { "type": "null" } ], "title": "Publication Mode" }, "explain": { "type": "boolean", "title": "Explain", "default": false }, "limit": { "type": "integer", "maximum": 500.0, "minimum": 1.0, "title": "Limit", "default": 100 }, "offset": { "type": "integer", "minimum": 0.0, "title": "Offset", "default": 0 } }, "additionalProperties": false, "type": "object", "required": [ "pack_ids" ], "title": "RegulatoryGraphQueryRequest", "example": { "limit": 100, "pack_ids": [ "UK-OFSI-SANCTIONS", "EU-SANCTIONS-DUE-DILIGENCE" ], "publication_mode": "published", "relationship_types": [ "shares_evidence_with", "horizontal_obligation_for" ] } }, "SourceWatchCheckRequest": { "properties": { "domain_pack_id": { "anyOf": [ { "type": "string", "maxLength": 160 }, { "type": "null" } ], "title": "Domain Pack Id" }, "status": { "anyOf": [ { "type": "string", "enum": [ "active", "paused", "retired" ] }, { "type": "null" } ], "title": "Status", "default": "active" }, "source_kind": { "anyOf": [ { "type": "string", "enum": [ "binding", "guidance", "watchlist", "context" ] }, { "type": "null" } ], "title": "Source Kind" }, "authority_type": { "anyOf": [ { "type": "string", "enum": [ "binding", "non_binding", "watchlist", "context" ] }, { "type": "null" } ], "title": "Authority Type" }, "limit": { "type": "integer", "maximum": 20.0, "minimum": 1.0, "title": "Limit", "default": 20 }, "offset": { "type": "integer", "minimum": 0.0, "title": "Offset", "default": 0 } }, "additionalProperties": false, "type": "object", "title": "SourceWatchCheckRequest", "example": { "domain_pack_id": "UK-DATA-PROTECTION-PRIVACY", "limit": 20 } }, "SourceWatchCreateRequest": { "properties": { "domain_pack_id": { "type": "string", "maxLength": 160, "minLength": 2, "title": "Domain Pack Id" }, "source_asset_id": { "type": "string", "maxLength": 240, "title": "Source Asset Id", "default": "" }, "source_uri": { "type": "string", "maxLength": 2000, "minLength": 2, "title": "Source Uri" }, "source_kind": { "type": "string", "enum": [ "binding", "guidance", "watchlist", "context" ], "title": "Source Kind", "default": "binding" }, "authority_type": { "type": "string", "enum": [ "binding", "non_binding", "watchlist", "context" ], "title": "Authority Type", "default": "binding" }, "expected_hash_sha256": { "type": "string", "maxLength": 128, "title": "Expected Hash Sha256", "default": "" }, "expected_etag": { "type": "string", "maxLength": 256, "title": "Expected Etag", "default": "" }, "expected_last_modified": { "type": "string", "maxLength": 256, "title": "Expected Last Modified", "default": "" }, "check_interval_seconds": { "type": "integer", "minimum": 60.0, "title": "Check Interval Seconds", "default": 86400 }, "status": { "type": "string", "enum": [ "active", "paused", "retired" ], "title": "Status", "default": "active" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "additionalProperties": false, "type": "object", "required": [ "domain_pack_id", "source_uri" ], "title": "SourceWatchCreateRequest", "example": { "authority_type": "binding", "check_interval_seconds": 86400, "domain_pack_id": "UK-DATA-PROTECTION-PRIVACY", "expected_hash_sha256": "known-source-hash", "source_asset_id": "src_uk_ico_data_protection_guidance", "source_kind": "binding", "source_uri": "https://ico.org.uk/for-organisations/uk-gdpr-guidance-and-resources/" } }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "WorkspaceUpdateRequest": { "properties": { "display_name": { "type": "string", "maxLength": 200, "minLength": 2, "title": "Display Name" }, "billing_contact_email": { "anyOf": [ { "type": "string", "maxLength": 254 }, { "type": "null" } ], "title": "Billing Contact Email" }, "pack_entitlements": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Pack Entitlements" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "additionalProperties": false, "type": "object", "required": [ "display_name" ], "title": "WorkspaceUpdateRequest", "example": { "billing_contact_email": "billing@acme.example", "display_name": "Acme Compliance", "metadata": { "dashboard_updated_by": "ops@acme.example" }, "pack_entitlements": [ "UK-DATA-PROTECTION-PRIVACY", "EU-GDPR-DATA-PROTECTION" ] } } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "Client API key issued by Esheria.", "x-default": "YOUR_ESHERIA_API_KEY" } }, "parameters": { "IdempotencyKey": { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Unique key for mutating request replay protection.", "example": "claim-verify-2026-06-01T120000Z" } } }, "servers": [ { "url": "https://api.esheria.ai", "description": "Production API" }, { "url": "http://127.0.0.1:8080", "description": "Local development runtime" } ] }