{ "openapi": "3.1.0", "info": { "title": "SanctionsKit API", "version": "1.0.0", "description": "Potential-match screening for review. No-match is limited to selected, qualified sources. Sandbox uses synthetic records and is never billed. Each successfully completed subject consumes one allowance unit, including monitoring rescreens. Failed rows and idempotent retries do not consume additional units." }, "servers": [ { "url": "https://sanctionskit.com/api/v1", "description": "Production after operator launch" }, { "url": "http://localhost:3000/api/v1", "description": "Local development; provider configuration required" } ], "paths": { "/sources": { "get": { "operationId": "get__sources", "summary": "Discover source capabilities, qualification and availability", "description": "Required API key scope: sources:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/SourceList" } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/screenings": { "post": { "operationId": "post__screenings", "summary": "Screen one subject against explicitly selected coverage", "description": "Required API key scope: screenings:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreeningRequest" } } } }, "responses": { "201": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ScreeningResult" } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/results": { "get": { "operationId": "get__results", "summary": "List retained results", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/results/{id}": { "get": { "operationId": "get__results_id_", "summary": "Retrieve one retained screening", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ScreeningResult" } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/results/{id}/evidence": { "get": { "operationId": "get__results_id_evidence", "summary": "Download retained JSON evidence", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/usage": { "get": { "operationId": "get__usage", "summary": "Read period allowance, used subjects and pending reservations", "description": "Required API key scope: usage:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/batches": { "post": { "operationId": "post__batches", "summary": "Accept up to 100 inline requests or an authorized private upload", "description": "Required API key scope: batches:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchRequest" } } } }, "responses": { "202": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "operationId": "get__batches", "summary": "List batches with progress", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/batches/{id}": { "get": { "operationId": "get__batches_id_", "summary": "Read batch and row outcomes", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "delete__batches_id_", "summary": "Cancel pending batch rows", "description": "Required API key scope: batches:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/uploads/intent": { "post": { "operationId": "post__uploads_intent", "summary": "Authorize a direct private Blob upload", "description": "Required API key scope: batches:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/files/{id}": { "get": { "operationId": "get__files_id_", "summary": "Download a private file after tenant authorization", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitors": { "get": { "operationId": "get__monitors", "summary": "List retained monitoring subjects", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "post__monitors", "summary": "Create a monitor with retained subject data", "description": "Required API key scope: monitors:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorRequest" } } } }, "responses": { "201": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitors/{id}": { "patch": { "operationId": "patch__monitors_id_", "summary": "Update a monitored subject and queue a fresh screen", "description": "Required API key scope: monitors:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorUpdate" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "delete__monitors_id_", "summary": "Stop monitoring and remove retained monitor input", "description": "Required API key scope: monitors:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/cases": { "get": { "operationId": "get__cases", "summary": "List analyst review cases", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "post__cases", "summary": "Record an analyst decision about a retained result", "description": "Required API key scope: cases:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaseRequest" } } } }, "responses": { "201": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/cases/{id}": { "get": { "operationId": "get__cases_id_", "summary": "Read a case and append-only decisions", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patch__cases_id_", "summary": "Append a review decision", "description": "Required API key scope: cases:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Decision" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api-keys": { "get": { "operationId": "get__api_keys", "summary": "List API key metadata without secrets", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "post__api_keys", "summary": "Create a scoped key and reveal the secret once", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyRequest" } } } }, "responses": { "201": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api-keys/{id}/rotate": { "post": { "operationId": "post__api_keys_id_rotate", "summary": "Rotate a key and revoke its prior secret atomically", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "201": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api-keys/{id}": { "delete": { "operationId": "delete__api_keys_id_", "summary": "Revoke an API key", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/team": { "get": { "operationId": "get__team", "summary": "List organization memberships", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "post__team", "summary": "Invite a member through WorkOS", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invitation" } } } }, "responses": { "201": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/team/{id}": { "patch": { "operationId": "patch__team_id_", "summary": "Change a non-owner member role", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRole" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "delete__team_id_", "summary": "Remove a member and revoke organization sessions", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/settings": { "get": { "operationId": "get__settings", "summary": "Read organization retention and spending cap", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patch__settings", "summary": "Update retention and spending cap", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settings" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/webhooks": { "get": { "operationId": "get__webhooks", "summary": "Read endpoints and recent delivery history", "description": "Required API key scope: webhooks:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "post__webhooks", "summary": "Register a public HTTPS endpoint and obtain its signing secret once", "description": "Required API key scope: webhooks:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } } }, "responses": { "201": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/webhooks/{id}": { "delete": { "operationId": "delete__webhooks_id_", "summary": "Disable a webhook endpoint", "description": "Required API key scope: webhooks:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/webhooks/{id}/retry": { "post": { "operationId": "post__webhooks_id_retry", "summary": "Retry a failed webhook delivery", "description": "Required API key scope: webhooks:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "202": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/counterparties": { "get": { "operationId": "get__counterparties", "summary": "List persistent customer and vendor records", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "cursor", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "query", "schema": { "type": "string", "maxLength": 200 } }, { "in": "query", "name": "status", "schema": { "enum": [ "active", "archived" ] } } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "post__counterparties", "summary": "Create a customer or vendor record", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterpartyCreate" } } } }, "responses": { "201": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/counterparties/{id}": { "get": { "operationId": "get__counterparties_id_", "summary": "Read a counterparty and linked screening, case and monitor history", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patch__counterparties_id_", "summary": "Update or archive a counterparty using its current revision", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterpartyUpdate" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/investigations/{id}": { "get": { "operationId": "get__investigations_id_", "summary": "Read match decisions, assignments, retained notes and attachment metadata", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patch__investigations_id_", "summary": "Assign, prioritize, escalate or require independent review", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationUpdate" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/investigations/{id}/matches": { "post": { "operationId": "post__investigations_id_matches", "summary": "Record identity and business decisions for one match", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchReview" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/investigations/{id}/comments": { "post": { "operationId": "post__investigations_id_comments", "summary": "Add a retained investigation comment", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationComment" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/investigations/{id}/attachments": { "post": { "operationId": "post__investigations_id_attachments", "summary": "Attach a UTF-8 text document of at most 200000 bytes", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationAttachment" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/investigations/{id}/submit": { "post": { "operationId": "post__investigations_id_submit", "summary": "Submit resolved matches; requested reuse requires independent approval", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationSubmit" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/investigations/{id}/approve": { "post": { "operationId": "post__investigations_id_approve", "summary": "Independently approve or return a submitted investigation", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationApprove" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/investigations/{id}/attachments/{attachmentId}": { "get": { "operationId": "get__investigations_id_attachments_attachmentId_", "summary": "Download a retained text attachment", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "path", "name": "attachmentId", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring": { "get": { "operationId": "get__monitoring", "summary": "List monitoring controls and recent attempt status", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 25, "default": 20 } }, { "in": "query", "name": "cursor", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/{id}": { "patch": { "operationId": "patch__monitoring_id_", "summary": "Pause, resume or set a six-hour, daily or weekly cadence using the current revision", "description": "Required API key scope: monitors:write. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorControl" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/inbox": { "get": { "operationId": "get__monitoring_inbox", "summary": "List meaningful changes, failures and reviews that must be renewed", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 25, "default": 20 } }, { "in": "query", "name": "cursor", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "status", "schema": { "enum": [ "all", "unread", "acknowledged" ] } }, { "in": "query", "name": "kind", "schema": { "enum": [ "initial_match", "match_added", "match_removed", "evidence_changed", "policy_changed", "baseline_unavailable", "screening_failed", "screening_recovered", "review_required" ] } }, { "in": "query", "name": "monitorId", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/monitoring/inbox/{id}": { "get": { "operationId": "get__monitoring_inbox_id_", "summary": "Read bounded before-and-after previews from retained evidence", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patch__monitoring_inbox_id_", "summary": "Acknowledge a monitoring event without clearing the investigation", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringAcknowledgement" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/investigation-assistant/{id}": { "get": { "operationId": "get__investigation_assistant_id_", "summary": "Suggest the most useful missing identity fact for a retained screening; id is a screening ID", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/reports": { "get": { "operationId": "get__reports", "summary": "Read operations, reviewer, source-coverage and retention metrics", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "from", "schema": { "type": "string", "format": "date" }, "description": "Inclusive UTC date. At most 366 days per report." }, { "in": "query", "name": "to", "schema": { "type": "string", "format": "date" }, "description": "Inclusive UTC date. At most 366 days per report." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/reports/screenings": { "get": { "operationId": "get__reports_screenings", "summary": "Download a bounded screening CSV with explicit expired outcomes", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "query", "name": "from", "schema": { "type": "string", "format": "date" }, "description": "Inclusive UTC date. At most 366 days per report." }, { "in": "query", "name": "to", "schema": { "type": "string", "format": "date" }, "description": "Inclusive UTC date. At most 366 days per report." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/reports/cases/{id}": { "get": { "operationId": "get__reports_cases_id_", "summary": "Download a retained audit package with JSON evidence, decisions and text attachments", "description": "Required API key scope: results:read. Keys own their organization and sandbox/production environment.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "query", "name": "format", "schema": { "enum": [ "json", "pdf" ], "default": "json" } } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/reports/cases/{id}/hold": { "post": { "operationId": "post__reports_cases_id_hold", "summary": "Owner or admin preserves available standard-retention evidence until a specified date", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvidenceHold" } } } }, "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "operationId": "delete__reports_cases_id_hold", "summary": "Owner or admin releases preservation and restores the applicable retention dates", "description": "Requires an authenticated human session, authorized organization role and same-origin protection on writes.", "security": [ { "humanSession": [] } ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Opaque resource identifier owned by the authenticated organization." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 }, "description": "Reuse for identical retries. Reuse with different input returns 409." } ], "responses": { "200": { "description": "Completed and persisted successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true } } } } } }, "400": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Structured error. See code and requestId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Coverage or a required service is unavailable. No all-clear result was produced.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "Subject": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 300 }, "entityType": { "default": "person", "type": "string", "enum": [ "person", "organization", "vessel", "aircraft", "other" ] }, "identifiers": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "minLength": 1, "maxLength": 80 }, "value": { "type": "string", "minLength": 1, "maxLength": 160 }, "issuer": { "type": "string", "maxLength": 100 } }, "required": [ "type", "value" ] } }, "birthDate": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}$" }, { "type": "string", "pattern": "^(?!0000)\\d{4}-(0[1-9]|1[0-2])$" }, { "type": "string", "allOf": [ { "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "pattern": "^(?!0000)" } ] } ] }, "country": { "type": "string", "minLength": 2, "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false }, "ScreeningRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "subject": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 300 }, "entityType": { "default": "person", "type": "string", "enum": [ "person", "organization", "vessel", "aircraft", "other" ] }, "identifiers": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "minLength": 1, "maxLength": 80 }, "value": { "type": "string", "minLength": 1, "maxLength": 160 }, "issuer": { "type": "string", "maxLength": 100 } }, "required": [ "type", "value" ] } }, "birthDate": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}$" }, { "type": "string", "pattern": "^(?!0000)\\d{4}-(0[1-9]|1[0-2])$" }, { "type": "string", "allOf": [ { "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "pattern": "^(?!0000)" } ] } ] }, "country": { "type": "string", "minLength": 2, "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false }, "counterpartyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sources": { "minItems": 1, "maxItems": 512, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "package": { "type": "string", "maxLength": 80 }, "retention": { "default": "standard", "type": "string", "enum": [ "standard", "minimal" ] } }, "required": [ "subject" ], "additionalProperties": false, "oneOf": [ { "required": [ "sources" ], "not": { "required": [ "package" ] } }, { "required": [ "package" ], "not": { "required": [ "sources" ] } } ] }, "BatchRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "subjects": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "subject": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 300 }, "entityType": { "default": "person", "type": "string", "enum": [ "person", "organization", "vessel", "aircraft", "other" ] }, "identifiers": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "minLength": 1, "maxLength": 80 }, "value": { "type": "string", "minLength": 1, "maxLength": 160 }, "issuer": { "type": "string", "maxLength": 100 } }, "required": [ "type", "value" ] } }, "birthDate": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}$" }, { "type": "string", "pattern": "^(?!0000)\\d{4}-(0[1-9]|1[0-2])$" }, { "type": "string", "allOf": [ { "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "pattern": "^(?!0000)" } ] } ] }, "country": { "type": "string", "minLength": 2, "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false }, "counterpartyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sources": { "minItems": 1, "maxItems": 512, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "package": { "type": "string", "maxLength": 80 }, "retention": { "default": "standard", "type": "string", "enum": [ "standard", "minimal" ] } }, "required": [ "subject" ], "additionalProperties": false } }, "uploadId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "name" ], "additionalProperties": false, "oneOf": [ { "required": [ "subjects" ], "not": { "required": [ "uploadId" ] } }, { "required": [ "uploadId" ], "not": { "required": [ "subjects" ] } } ] }, "MonitorRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "counterpartyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "subject": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 300 }, "entityType": { "default": "person", "type": "string", "enum": [ "person", "organization", "vessel", "aircraft", "other" ] }, "identifiers": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "minLength": 1, "maxLength": 80 }, "value": { "type": "string", "minLength": 1, "maxLength": 160 }, "issuer": { "type": "string", "maxLength": 100 } }, "required": [ "type", "value" ] } }, "birthDate": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}$" }, { "type": "string", "pattern": "^(?!0000)\\d{4}-(0[1-9]|1[0-2])$" }, { "type": "string", "allOf": [ { "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "pattern": "^(?!0000)" } ] } ] }, "country": { "type": "string", "minLength": 2, "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false }, "sources": { "minItems": 1, "maxItems": 512, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "package": { "type": "string" } }, "required": [ "name", "subject" ], "additionalProperties": false, "oneOf": [ { "required": [ "sources" ], "not": { "required": [ "package" ] } }, { "required": [ "package" ], "not": { "required": [ "sources" ] } } ] }, "CaseRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "decision": { "type": "string", "enum": [ "open", "confirmed", "dismissed" ] }, "notes": { "type": "string", "minLength": 1, "maxLength": 5000 }, "screeningId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedUpdatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "decision", "notes", "screeningId" ], "additionalProperties": false }, "MonitorUpdate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "counterpartyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "subject": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 300 }, "entityType": { "default": "person", "type": "string", "enum": [ "person", "organization", "vessel", "aircraft", "other" ] }, "identifiers": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "minLength": 1, "maxLength": 80 }, "value": { "type": "string", "minLength": 1, "maxLength": 160 }, "issuer": { "type": "string", "maxLength": 100 } }, "required": [ "type", "value" ] } }, "birthDate": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}$" }, { "type": "string", "pattern": "^(?!0000)\\d{4}-(0[1-9]|1[0-2])$" }, { "type": "string", "allOf": [ { "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "pattern": "^(?!0000)" } ] } ] }, "country": { "type": "string", "minLength": 2, "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false }, "sources": { "minItems": 1, "maxItems": 512, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "package": { "type": "string" }, "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": [ "name", "subject", "expectedRevision" ], "additionalProperties": false, "oneOf": [ { "required": [ "sources" ], "not": { "required": [ "package" ] } }, { "required": [ "package" ], "not": { "required": [ "sources" ] } } ] }, "CounterpartyCreate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "label": { "type": "string", "minLength": 2, "maxLength": 200 }, "externalId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 160 }, { "type": "null" } ] }, "relationship": { "default": "customer", "type": "string", "enum": [ "customer", "vendor", "employee", "other" ] }, "subject": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 300 }, "entityType": { "default": "person", "type": "string", "enum": [ "person", "organization", "vessel", "aircraft", "other" ] }, "identifiers": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "minLength": 1, "maxLength": 80 }, "value": { "type": "string", "minLength": 1, "maxLength": 160 }, "issuer": { "type": "string", "maxLength": 100 } }, "required": [ "type", "value" ] } }, "birthDate": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}$" }, { "type": "string", "pattern": "^(?!0000)\\d{4}-(0[1-9]|1[0-2])$" }, { "type": "string", "allOf": [ { "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "pattern": "^(?!0000)" } ] } ] }, "country": { "type": "string", "minLength": 2, "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false }, "tags": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 } } }, "required": [ "label", "subject" ], "additionalProperties": false }, "CounterpartyUpdate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "label": { "type": "string", "minLength": 2, "maxLength": 200 }, "externalId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 160 }, { "type": "null" } ] }, "relationship": { "default": "customer", "type": "string", "enum": [ "customer", "vendor", "employee", "other" ] }, "subject": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 300 }, "entityType": { "default": "person", "type": "string", "enum": [ "person", "organization", "vessel", "aircraft", "other" ] }, "identifiers": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "minLength": 1, "maxLength": 80 }, "value": { "type": "string", "minLength": 1, "maxLength": 160 }, "issuer": { "type": "string", "maxLength": 100 } }, "required": [ "type", "value" ] } }, "birthDate": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}$" }, { "type": "string", "pattern": "^(?!0000)\\d{4}-(0[1-9]|1[0-2])$" }, { "type": "string", "allOf": [ { "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "pattern": "^(?!0000)" } ] } ] }, "country": { "type": "string", "minLength": 2, "maxLength": 100 } }, "required": [ "name" ], "additionalProperties": false }, "tags": { "default": [], "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 } }, "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "active", "archived" ] } }, "required": [ "expectedRevision" ], "additionalProperties": false }, "InvestigationUpdate": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "assigneeId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "priority": { "type": "string", "enum": [ "low", "normal", "high", "urgent" ] }, "dueAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "escalate": { "type": "boolean" }, "requiresSecondReview": { "type": "boolean" } }, "required": [ "expectedRevision" ], "additionalProperties": false }, "MatchReview": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "screeningId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sourceId": { "type": "string", "minLength": 1, "maxLength": 80 }, "recordId": { "type": "string", "minLength": 1, "maxLength": 300 }, "identityDecision": { "type": "string", "enum": [ "unresolved", "same", "different" ] }, "businessDecision": { "type": "string", "enum": [ "pending", "allow", "restrict", "escalate" ] }, "rationale": { "type": "string", "minLength": 3, "maxLength": 5000 }, "reusableUntil": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] } }, "required": [ "expectedRevision", "screeningId", "sourceId", "recordId", "identityDecision", "businessDecision", "rationale" ], "additionalProperties": false }, "InvestigationSubmit": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "screeningId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rationale": { "type": "string", "minLength": 3, "maxLength": 5000 } }, "required": [ "expectedRevision", "screeningId", "rationale" ], "additionalProperties": false }, "InvestigationApprove": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "screeningId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "rationale": { "type": "string", "minLength": 3, "maxLength": 5000 }, "decision": { "default": "approve", "type": "string", "enum": [ "approve", "return" ] } }, "required": [ "expectedRevision", "screeningId", "rationale" ], "additionalProperties": false }, "InvestigationComment": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "screeningId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "body": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "expectedRevision", "screeningId", "body" ], "additionalProperties": false }, "InvestigationAttachment": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "screeningId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "title": { "type": "string", "minLength": 1, "maxLength": 200 }, "content": { "type": "string", "minLength": 1, "maxLength": 200000 } }, "required": [ "expectedRevision", "screeningId", "title", "content" ], "additionalProperties": false }, "MonitorControl": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "active", "paused" ] }, "intervalHours": { "anyOf": [ { "type": "number", "const": 6 }, { "type": "number", "const": 24 }, { "type": "number", "const": 168 } ] } }, "required": [ "expectedRevision" ], "additionalProperties": false, "anyOf": [ { "required": [ "status" ] }, { "required": [ "intervalHours" ] } ] }, "MonitoringAcknowledgement": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "status": { "type": "string", "const": "acknowledged" } }, "required": [ "status" ], "additionalProperties": false }, "EvidenceHold": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "reason": { "type": "string", "minLength": 3, "maxLength": 1000 }, "until": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "reason", "until" ], "additionalProperties": false }, "Decision": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "decision": { "type": "string", "enum": [ "open", "confirmed", "dismissed" ] }, "notes": { "type": "string", "minLength": 1, "maxLength": 5000 }, "screeningId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedUpdatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "decision", "notes" ], "additionalProperties": false }, "KeyRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "environment": { "type": "string", "enum": [ "sandbox", "production" ] }, "scopes": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "enum": [ "sources:read", "screenings:write", "results:read", "batches:write", "monitors:write", "cases:write", "usage:read", "webhooks:write" ] } } }, "required": [ "name", "environment", "scopes" ], "additionalProperties": false }, "WebhookRequest": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "url" ], "additionalProperties": false }, "Settings": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 100 }, "retentionDays": { "type": "integer", "minimum": 1, "maximum": 3650 }, "spendingCap": { "type": "integer", "minimum": 0, "maximum": 1000000 } }, "additionalProperties": false }, "Invitation": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "email": { "type": "string", "maxLength": 254, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "role": { "type": "string", "enum": [ "admin", "analyst", "developer", "viewer" ] } }, "required": [ "email", "role" ], "additionalProperties": false }, "TeamRole": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "role": { "type": "string", "enum": [ "admin", "analyst", "developer", "viewer" ] } }, "required": [ "role" ], "additionalProperties": false }, "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "requestId" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "details": {} } } } }, "SourceNotice": { "type": "object", "required": [ "text", "sourceUrl", "termsUrl" ], "properties": { "text": { "type": "string", "description": "Required publisher attribution and reuse notices captured when screening runs." }, "sourceUrl": { "type": "string", "format": "uri" }, "termsUrl": { "type": "string", "format": "uri" }, "licenseUrl": { "type": "string", "format": "uri", "description": "Only included for a reviewed explicit license instrument." }, "databaseDownloadUrl": { "type": "string", "format": "uri-reference", "description": "Free complete derivative database for the exact immutable source version, where required. A relative path resolves against this API origin." } } }, "Coverage": { "type": "object", "required": [ "sourceId", "version", "retrievedAt", "fresh" ], "properties": { "sourceId": { "type": "string" }, "version": { "type": "string" }, "retrievedAt": { "type": "string", "format": "date-time" }, "publishedAt": { "type": "string", "format": "date-time", "description": "Omitted when the authority does not supply a genuine publication timestamp." }, "fresh": { "type": "boolean" }, "sourceNotice": { "$ref": "#/components/schemas/SourceNotice", "description": "Included in new production screening results, including no-match results. Absent from synthetic sandbox coverage and older retained evidence; historical evidence is not rewritten." } } }, "SourceRecord": { "type": "object", "required": [ "id", "sourceId", "authority", "list", "sourceUrl", "entityType", "names", "identifiers", "birthDates", "addresses", "nationalities", "designations", "extensions" ], "properties": { "id": { "type": "string" }, "sourceId": { "type": "string" }, "authority": { "type": "string" }, "list": { "type": "string" }, "sourceUrl": { "type": "string" }, "entityType": { "type": "string", "enum": [ "person", "organization", "vessel", "aircraft", "other" ] }, "names": { "type": "array", "items": { "type": "object", "required": [ "value", "kind" ], "properties": { "value": { "type": "string" }, "kind": { "enum": [ "primary", "alias" ] }, "quality": { "enum": [ "strong", "weak", "unknown" ] }, "script": { "type": "string" }, "provenance": { "type": "object" } } } }, "identifiers": { "type": "array", "items": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "issuer": { "type": "string" }, "provenance": { "type": "object" } } } }, "birthDates": { "type": "array", "items": { "type": "object", "required": [ "value", "precision", "original" ], "properties": { "value": { "type": "string" }, "precision": { "enum": [ "day", "month", "year", "range", "unknown" ] }, "original": { "type": "string" } } } }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "country": { "type": "string" } } } }, "nationalities": { "type": "array", "items": { "type": "string" } }, "designations": { "type": "array", "items": { "type": "object", "required": [ "category", "programs", "legalReferences" ], "properties": { "category": { "enum": [ "financial_sanctions", "export_control", "debarment", "other" ] }, "programs": { "type": "array", "items": { "type": "string" } }, "legalReferences": { "type": "array", "items": { "type": "string" } }, "wording": { "type": "string" }, "effectiveDate": { "type": "string" } } } }, "dataThrough": { "type": "string", "format": "date", "description": "Inclusive publisher data-availability deadline; not a legal end date." }, "screeningPeriods": { "type": "array", "maxItems": 1000, "description": "Inclusive UTC date intervals for current screening. Omitted means no date filter; an empty array excludes the record from current screening.", "items": { "type": "object", "additionalProperties": false, "properties": { "from": { "type": "string", "format": "date" }, "through": { "type": "string", "format": "date" } } } }, "publicContext": { "type": "array", "maxItems": 100, "items": { "type": "object", "required": [ "label", "value" ], "additionalProperties": false, "properties": { "label": { "type": "string", "maxLength": 100 }, "value": { "type": "string", "maxLength": 2000 } } } }, "extensions": { "type": "object", "additionalProperties": true, "description": "Source-specific retained facts. Additive extension keys do not change the normalized contract." } } }, "SourceList": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "authority", "availability", "capabilities", "rightsStatus", "category" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "authority": { "type": "string" }, "availability": { "enum": [ "available", "disabled" ] }, "capabilities": { "type": "array", "items": { "type": "string" } }, "category": { "enum": [ "financial_sanctions", "export_control", "debarment", "regulatory_enforcement", "public_office", "reference", "other", "mixed" ] }, "rightsStatus": { "enum": [ "approved", "review_required", "restricted" ] } } } }, "ScreeningResult": { "type": "object", "required": [ "id", "environment", "status", "createdAt", "matches", "coverage", "versions", "disclaimer" ], "properties": { "id": { "type": "string", "format": "uuid" }, "environment": { "enum": [ "sandbox", "production" ] }, "status": { "enum": [ "potential_match", "no_match" ] }, "createdAt": { "type": "string", "format": "date-time" }, "matches": { "type": "array", "items": { "type": "object", "required": [ "record", "score", "evidence", "conflicts" ], "properties": { "record": { "$ref": "#/components/schemas/SourceRecord" }, "score": { "type": "number", "minimum": 0, "maximum": 100, "description": "Similarity measure, not probability of wrongdoing." }, "evidence": { "type": "array", "items": { "type": "object", "required": [ "field", "queryValue", "sourceValue", "method", "contribution", "explanation" ], "properties": { "field": { "type": "string" }, "queryValue": { "type": "string" }, "sourceValue": { "type": "string" }, "method": { "type": "string" }, "contribution": { "type": "number" }, "explanation": { "type": "string" } } } }, "conflicts": { "type": "array", "items": { "type": "string" } } } } }, "coverage": { "type": "array", "items": { "$ref": "#/components/schemas/Coverage" } }, "versions": { "type": "object", "required": [ "dataset", "matchingEngine", "policy" ], "properties": { "dataset": { "type": "string" }, "matchingEngine": { "type": "string" }, "policy": { "type": "string" }, "package": { "type": "string" } } }, "disclaimer": { "type": "string" } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "sk_test_... or sk_live_..." }, "humanSession": { "type": "apiKey", "in": "cookie", "name": "wos-session", "description": "WorkOS AuthKit session. Cookie name can be configured by the operator." } } } }