{ "openapi": "3.1.0", "info": { "title": "Veltor API", "version": "1.0.0", "description": "Veltor is an abuse prevention API for SaaS. Test and Live use the same contract with isolated credentials and data." }, "servers": [ { "url": "https://veltor.dev", "description": "Veltor API" } ], "paths": { "/v1/organizations": { "get": { "operationId": "organizations.list", "summary": "List organizations available to this identity.", "tags": [ "organization" ], "description": "Requires `organizations:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_organizations`.", "security": [ { "serverKey": [] }, { "oauth": [ "organizations:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "organizations:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_organizations" } }, "/v1/evaluations": { "get": { "operationId": "evaluations.list", "summary": "List evaluations.", "tags": [ "evaluations" ], "description": "Requires `evaluations:read`. Available in Test and Live. Test accepts a maximum 30-day range; Live accepts up to 90 days. Requests above the Test limit return 422 TEST_RETENTION_RANGE. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_evaluations`.", "security": [ { "serverKey": [] }, { "oauth": [ "evaluations:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "evaluations:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_evaluations" }, "post": { "operationId": "evaluations.create", "summary": "Evaluate a benefit claim.", "tags": [ "evaluations" ], "description": "Requires `evaluations:create`. Available in Test and Live. The server deadline is 1.5 seconds. Equivalent MCP tool: `veltor_create_evaluation`.", "security": [ { "serverKey": [] }, { "oauth": [ "evaluations:create" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "benefit": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "claim_id": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "subject": { "type": "object", "properties": { "external_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "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,}$" }, "email_verified": { "type": "boolean" } }, "required": [ "email" ], "additionalProperties": false }, "context": { "anyOf": [ { "type": "object", "properties": { "ip": { "anyOf": [ { "type": "string", "maxLength": 45 }, { "type": "null" } ] }, "user_agent": { "type": "string", "maxLength": 512 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "additionalProperties": false }, { "type": "null" } ] }, "identifiers": { "type": "object", "properties": { "device_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "device_token": { "type": "string", "maxLength": 4096 }, "browser_cookie_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "payment": { "type": "object", "properties": { "provider": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "scope": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "fingerprint": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "provider", "scope", "fingerprint" ], "additionalProperties": false }, "phone_hash": { "type": "object", "properties": { "algorithm": { "type": "string", "const": "hmac-sha256" }, "key_version": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "value": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "algorithm", "key_version", "value" ], "additionalProperties": false }, "phone_verified": { "type": "boolean" }, "custom": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "value_hash": { "type": "object", "properties": { "algorithm": { "type": "string", "const": "hmac-sha256" }, "key_version": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "value": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "algorithm", "key_version", "value" ], "additionalProperties": false } }, "required": [ "key", "value_hash" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "benefit", "claim_id", "subject" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [ { "type": "object", "properties": { "id": { "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)$" }, "result": { "type": "string", "enum": [ "allow", "deny" ] } }, "required": [ "id", "result" ], "additionalProperties": {} }, { "type": "object", "properties": { "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string", "enum": [ "billing_overdue", "service_inactive", "trial_allowance_exhausted", "insufficient_credits", "custom_allowance_exhausted" ] } }, "required": [ "status", "reason" ], "additionalProperties": false } ] }, "example": { "id": "00000000-0000-4000-8000-000000000001", "result": "allow" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "evaluations:create", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_create_evaluation" } }, "/v1/evaluations/{id}": { "get": { "operationId": "evaluations.get", "summary": "Read an evaluation.", "tags": [ "evaluations" ], "description": "Requires `evaluations:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_evaluation`.", "security": [ { "serverKey": [] }, { "oauth": [ "evaluations:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "evaluations:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_evaluation" } }, "/v1/evaluations/{id}/graph": { "get": { "operationId": "evaluations.graph", "summary": "Read an evaluation association graph.", "tags": [ "evaluations" ], "description": "Requires `evaluations:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_evaluation_graph`.", "security": [ { "serverKey": [] }, { "oauth": [ "evaluations:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "evaluations:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_evaluation_graph" } }, "/v1/evaluations/{id}/evidence": { "get": { "operationId": "evaluations.evidence", "summary": "Read retained evaluation evidence.", "tags": [ "evaluations" ], "description": "Requires `evaluation_evidence:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_evaluation_evidence`.", "security": [ { "serverKey": [] }, { "oauth": [ "evaluation_evidence:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "evaluation_evidence:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_evaluation_evidence" } }, "/v1/outcomes": { "get": { "operationId": "outcomes.list", "summary": "List outcomes.", "tags": [ "evaluations" ], "description": "Requires `outcomes:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_outcomes`.", "security": [ { "serverKey": [] }, { "oauth": [ "outcomes:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "outcomes:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_outcomes" } }, "/v1/outcomes/{id}": { "get": { "operationId": "outcomes.get", "summary": "Read an outcome.", "tags": [ "evaluations" ], "description": "Requires `outcomes:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_outcome`.", "security": [ { "serverKey": [] }, { "oauth": [ "outcomes:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "outcomes:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_outcome" } }, "/v1/evaluations/{id}/outcome": { "post": { "operationId": "outcomes.report", "summary": "Record a known outcome.", "tags": [ "evaluations" ], "description": "Requires `outcomes:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_report_outcome`.", "security": [ { "serverKey": [] }, { "oauth": [ "outcomes:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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)$" }, "outcome": { "type": "string", "enum": [ "granted", "not_granted", "reversed" ] }, "reason": { "type": "string", "minLength": 3, "maxLength": 500 }, "external_outcome_id": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } }, "required": [ "id", "outcome" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "evaluation_id": "00000000-0000-4000-8000-000000000001", "outcome_state": "granted", "conflicts": [] } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "outcomes:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_report_outcome" } }, "/v1/evaluation-previews": { "post": { "operationId": "simulations.preview", "summary": "Preview an evaluation without writing claim history. Completed Live previews consume usage.", "tags": [ "evaluations" ], "description": "Requires `simulations:run`. Available in Test and Live. The server deadline is 1.5 seconds. Equivalent MCP tool: `veltor_preview_evaluation`.", "security": [ { "serverKey": [] }, { "oauth": [ "simulations:run" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "benefit": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "claim_id": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "subject": { "type": "object", "properties": { "external_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "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,}$" }, "email_verified": { "type": "boolean" } }, "required": [ "email" ], "additionalProperties": false }, "context": { "anyOf": [ { "type": "object", "properties": { "ip": { "anyOf": [ { "type": "string", "maxLength": 45 }, { "type": "null" } ] }, "user_agent": { "type": "string", "maxLength": 512 }, "session_id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "additionalProperties": false }, { "type": "null" } ] }, "identifiers": { "type": "object", "properties": { "device_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "device_token": { "type": "string", "maxLength": 4096 }, "browser_cookie_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "payment": { "type": "object", "properties": { "provider": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "scope": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "fingerprint": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "provider", "scope", "fingerprint" ], "additionalProperties": false }, "phone_hash": { "type": "object", "properties": { "algorithm": { "type": "string", "const": "hmac-sha256" }, "key_version": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "value": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "algorithm", "key_version", "value" ], "additionalProperties": false }, "phone_verified": { "type": "boolean" }, "custom": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "value_hash": { "type": "object", "properties": { "algorithm": { "type": "string", "const": "hmac-sha256" }, "key_version": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "value": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "algorithm", "key_version", "value" ], "additionalProperties": false } }, "required": [ "key", "value_hash" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "benefit", "claim_id", "subject" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [ { "type": "object", "properties": { "preview": { "type": "boolean", "const": true }, "result": { "type": "string", "enum": [ "allow", "deny" ] }, "facts": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "preview", "result", "facts" ], "additionalProperties": {} }, { "type": "object", "properties": { "status": { "type": "string", "const": "skipped" }, "reason": { "type": "string", "enum": [ "billing_overdue", "service_inactive", "trial_allowance_exhausted", "insufficient_credits", "custom_allowance_exhausted" ] } }, "required": [ "status", "reason" ], "additionalProperties": false } ] }, "example": { "preview": true, "result": "allow", "facts": {} } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "simulations:run", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_preview_evaluation" } }, "/v1/simulations": { "post": { "operationId": "simulations.sequence", "summary": "Simulate a retained sequence.", "tags": [ "evaluations" ], "description": "Requires `simulations:run`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_simulate_sequence`.", "security": [ { "serverKey": [] }, { "oauth": [ "simulations:run" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "benefit_id": { "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)$" }, "policy_key": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "benefit_id", "policy_key" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "simulations:run", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_simulate_sequence" } }, "/v1/replays": { "post": { "operationId": "simulations.replay", "summary": "Replay retained evaluations against a saved policy.", "tags": [ "evaluations" ], "description": "Requires `simulations:run`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_replay_evaluations`.", "security": [ { "serverKey": [] }, { "oauth": [ "simulations:run" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "benefit_id": { "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)$" }, "policy_key": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "benefit_id", "policy_key" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "simulations:run", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_replay_evaluations" } }, "/v1/benefits": { "get": { "operationId": "benefits.list", "summary": "List benefits.", "tags": [ "benefits" ], "description": "Requires `benefits:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_benefits`.", "security": [ { "serverKey": [] }, { "oauth": [ "benefits:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "benefits:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_benefits" }, "post": { "operationId": "benefits.create", "summary": "Create a benefit.", "tags": [ "benefits" ], "description": "Requires `benefits:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_create_benefit`.", "security": [ { "serverKey": [] }, { "oauth": [ "benefits:write" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "config": { "type": "object", "properties": { "outcome_tracking": { "default": "assume_granted", "type": "string", "enum": [ "assume_granted", "report_outcome" ] }, "missing_outcome_behavior": { "default": "hold_eligibility", "type": "string", "enum": [ "hold_eligibility", "release_eligibility" ] }, "eligibility": { "default": { "kind": "once" }, "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "once" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "calendar" }, "period": { "type": "string", "enum": [ "day", "week", "month" ] }, "timezone": { "type": "string", "maxLength": 80 } }, "required": [ "kind", "period", "timezone" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "days": { "type": "integer", "minimum": 1, "maximum": 365 } }, "required": [ "kind", "days" ], "additionalProperties": false } ] }, "valuation": { "default": { "currency": "USD", "face_value": 0, "delivery_cost": 0 }, "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "face_value": { "type": "number", "minimum": 0, "maximum": 10000000000, "multipleOf": 0.01 }, "delivery_cost": { "type": "number", "minimum": 0, "maximum": 10000000000, "multipleOf": 0.01 } }, "required": [ "currency", "face_value", "delivery_cost" ], "additionalProperties": false } }, "required": [ "outcome_tracking", "missing_outcome_behavior", "eligibility", "valuation" ], "additionalProperties": false }, "policy_key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "enforcement_mode": { "type": "string", "enum": [ "enforce", "monitor" ] } }, "required": [ "name", "key", "config", "policy_key", "enforcement_mode" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "benefits:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_create_benefit" } }, "/v1/benefits/{id}": { "get": { "operationId": "benefits.get", "summary": "Read a benefit.", "tags": [ "benefits" ], "description": "Requires `benefits:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_benefit`.", "security": [ { "serverKey": [] }, { "oauth": [ "benefits:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "benefits:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_benefit" }, "patch": { "operationId": "benefits.update", "summary": "Update a benefit.", "tags": [ "benefits" ], "description": "Requires `benefits:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_update_benefit`.", "security": [ { "serverKey": [] }, { "oauth": [ "benefits:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "config": { "type": "object", "properties": { "outcome_tracking": { "default": "assume_granted", "type": "string", "enum": [ "assume_granted", "report_outcome" ] }, "missing_outcome_behavior": { "default": "hold_eligibility", "type": "string", "enum": [ "hold_eligibility", "release_eligibility" ] }, "eligibility": { "default": { "kind": "once" }, "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "once" } }, "required": [ "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "calendar" }, "period": { "type": "string", "enum": [ "day", "week", "month" ] }, "timezone": { "type": "string", "maxLength": 80 } }, "required": [ "kind", "period", "timezone" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rolling" }, "days": { "type": "integer", "minimum": 1, "maximum": 365 } }, "required": [ "kind", "days" ], "additionalProperties": false } ] }, "valuation": { "default": { "currency": "USD", "face_value": 0, "delivery_cost": 0 }, "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "face_value": { "type": "number", "minimum": 0, "maximum": 10000000000, "multipleOf": 0.01 }, "delivery_cost": { "type": "number", "minimum": 0, "maximum": 10000000000, "multipleOf": 0.01 } }, "required": [ "currency", "face_value", "delivery_cost" ], "additionalProperties": false } }, "required": [ "outcome_tracking", "missing_outcome_behavior", "eligibility", "valuation" ], "additionalProperties": false }, "policy_key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "enforcement_mode": { "type": "string", "enum": [ "enforce", "monitor" ] }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "name", "config", "policy_key", "enforcement_mode", "revision" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "benefits:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_update_benefit" }, "delete": { "operationId": "benefits.delete", "summary": "Permanently delete a benefit. This cannot be reversed.", "tags": [ "benefits" ], "description": "Requires `benefits:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_delete_benefit`.", "security": [ { "serverKey": [] }, { "oauth": [ "benefits:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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": [ "id" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "saved": { "type": "boolean" } }, "required": [ "saved" ], "additionalProperties": {} }, "example": { "saved": true } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "benefits:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_delete_benefit" } }, "/v1/policies": { "get": { "operationId": "policies.list", "summary": "List policies.", "tags": [ "policies" ], "description": "Requires `policies:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_policies`.", "security": [ { "serverKey": [] }, { "oauth": [ "policies:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "policies:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_policies" }, "post": { "operationId": "policies.create", "summary": "Create a policy.", "tags": [ "policies" ], "description": "Requires `policies:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_create_policy`.", "security": [ { "serverKey": [] }, { "oauth": [ "policies:write" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "definition": { "type": "object", "properties": { "default_result": { "type": "string", "enum": [ "allow", "deny" ] }, "rules": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "result": { "type": "string", "enum": [ "allow", "deny" ] }, "when": { "$ref": "#/definitions/__schema0" } }, "required": [ "id", "name", "result", "when" ], "additionalProperties": false } } }, "required": [ "default_result", "rules" ], "additionalProperties": false } }, "required": [ "name", "key", "definition" ], "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "object", "properties": { "fact": { "type": "string", "maxLength": 100 }, "operator": { "type": "string", "enum": [ "eq", "neq", "gte", "gt", "lte", "lt", "is_missing", "is_unknown", "is_unavailable" ] }, "value": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "fact", "operator" ], "additionalProperties": false }, { "type": "object", "properties": { "all": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "$ref": "#/definitions/__schema0" } } }, "required": [ "all" ], "additionalProperties": false }, { "type": "object", "properties": { "any": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "$ref": "#/definitions/__schema0" } } }, "required": [ "any" ], "additionalProperties": false } ] } } } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "policies:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_create_policy" } }, "/v1/policies/{id}": { "get": { "operationId": "policies.get", "summary": "Read a policy.", "tags": [ "policies" ], "description": "Requires `policies:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_policy`.", "security": [ { "serverKey": [] }, { "oauth": [ "policies:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "policies:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_policy" }, "patch": { "operationId": "policies.update", "summary": "Update a policy.", "tags": [ "policies" ], "description": "Requires `policies:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_update_policy`.", "security": [ { "serverKey": [] }, { "oauth": [ "policies:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "definition": { "type": "object", "properties": { "default_result": { "type": "string", "enum": [ "allow", "deny" ] }, "rules": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "result": { "type": "string", "enum": [ "allow", "deny" ] }, "when": { "$ref": "#/definitions/__schema0" } }, "required": [ "id", "name", "result", "when" ], "additionalProperties": false } } }, "required": [ "default_result", "rules" ], "additionalProperties": false }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "name", "definition", "revision" ], "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "object", "properties": { "fact": { "type": "string", "maxLength": 100 }, "operator": { "type": "string", "enum": [ "eq", "neq", "gte", "gt", "lte", "lt", "is_missing", "is_unknown", "is_unavailable" ] }, "value": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "fact", "operator" ], "additionalProperties": false }, { "type": "object", "properties": { "all": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "$ref": "#/definitions/__schema0" } } }, "required": [ "all" ], "additionalProperties": false }, { "type": "object", "properties": { "any": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "$ref": "#/definitions/__schema0" } } }, "required": [ "any" ], "additionalProperties": false } ] } } } } } }, "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "policies:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_update_policy" }, "delete": { "operationId": "policies.delete", "summary": "Permanently delete an unused custom policy. This cannot be reversed.", "tags": [ "policies" ], "description": "Requires `policies:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_delete_policy`.", "security": [ { "serverKey": [] }, { "oauth": [ "policies:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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": [ "id" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "saved": { "type": "boolean" } }, "required": [ "saved" ], "additionalProperties": {} }, "example": { "saved": true } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "policies:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_delete_policy" } }, "/v1/policies/{id}/duplicate": { "post": { "operationId": "policies.duplicate", "summary": "Duplicate a policy.", "tags": [ "policies" ], "description": "Requires `policies:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_duplicate_policy`.", "security": [ { "serverKey": [] }, { "oauth": [ "policies:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, "required": [ "id", "name", "key" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "policies:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_duplicate_policy" } }, "/v1/policies/{id}/versions": { "get": { "operationId": "policies.versions", "summary": "List saved policy versions.", "tags": [ "policies" ], "description": "Requires `policies:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_policy_versions`.", "security": [ { "serverKey": [] }, { "oauth": [ "policies:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "policies:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_policy_versions" } }, "/v1/policies/{id}/versions/{version}": { "get": { "operationId": "policies.version", "summary": "Read a saved policy version.", "tags": [ "policies" ], "description": "Requires `policies:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_policy_version`.", "security": [ { "serverKey": [] }, { "oauth": [ "policies:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "policies:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_policy_version" } }, "/v1/policy-facts": { "get": { "operationId": "policies.facts", "summary": "List facts available to policy rules.", "tags": [ "policies" ], "description": "Requires `policies:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_policy_facts`.", "security": [ { "serverKey": [] }, { "oauth": [ "policies:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "policies:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_policy_facts" } }, "/v1/exceptions": { "get": { "operationId": "exceptions.list", "summary": "List exceptions.", "tags": [ "identifiers" ], "description": "Requires `exceptions:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_exceptions`.", "security": [ { "serverKey": [] }, { "oauth": [ "exceptions:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "exceptions:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_exceptions" }, "post": { "operationId": "exceptions.create", "summary": "Create a exception.", "tags": [ "identifiers" ], "description": "Requires `exceptions:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_add_exception`.", "security": [ { "serverKey": [] }, { "oauth": [ "exceptions:write" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "kind": { "type": "string", "enum": [ "blocked", "trusted" ] }, "type": { "type": "string", "enum": [ "email", "email_exact", "domain", "ip", "recipient", "device_id" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 254 }, "benefit_id": { "default": null, "anyOf": [ { "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)$" }, { "type": "null" } ] }, "reason": { "type": "string", "minLength": 3, "maxLength": 500 }, "expires_at": { "default": null, "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))$" }, { "type": "null" } ] } }, "required": [ "kind", "type", "value", "benefit_id", "reason", "expires_at" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "exceptions:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_add_exception" } }, "/v1/exceptions/{id}": { "get": { "operationId": "exceptions.get", "summary": "Read a exception.", "tags": [ "identifiers" ], "description": "Requires `exceptions:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_exception`.", "security": [ { "serverKey": [] }, { "oauth": [ "exceptions:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "exceptions:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_exception" }, "delete": { "operationId": "exceptions.delete", "summary": "Permanently delete a exception. This cannot be reversed.", "tags": [ "identifiers" ], "description": "Requires `exceptions:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_delete_exception`.", "security": [ { "serverKey": [] }, { "oauth": [ "exceptions:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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": [ "id" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "saved": { "type": "boolean" } }, "required": [ "saved" ], "additionalProperties": {} }, "example": { "saved": true } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "exceptions:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_delete_exception" } }, "/v1/custom-identifiers": { "get": { "operationId": "custom-identifiers.list", "summary": "List custom identifiers.", "tags": [ "identifiers" ], "description": "Requires `custom_identifiers:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_custom_identifiers`.", "security": [ { "serverKey": [] }, { "oauth": [ "custom_identifiers:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "custom_identifiers:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_custom_identifiers" }, "post": { "operationId": "custom-identifiers.create", "summary": "Create a custom identifier.", "tags": [ "identifiers" ], "description": "Requires `custom_identifiers:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_register_custom_identifier`.", "security": [ { "serverKey": [] }, { "oauth": [ "custom_identifiers:write" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "key_version": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "description": { "type": "string", "minLength": 3, "maxLength": 200 } }, "required": [ "key", "key_version", "description" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "custom_identifiers:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_register_custom_identifier" } }, "/v1/custom-identifiers/{id}": { "get": { "operationId": "custom-identifiers.get", "summary": "Read a custom identifier.", "tags": [ "identifiers" ], "description": "Requires `custom_identifiers:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_custom_identifier`.", "security": [ { "serverKey": [] }, { "oauth": [ "custom_identifiers:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "custom_identifiers:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_custom_identifier" }, "delete": { "operationId": "custom-identifiers.delete", "summary": "Permanently delete a custom identifier. This cannot be reversed.", "tags": [ "identifiers" ], "description": "Requires `custom_identifiers:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_delete_custom_identifier`.", "security": [ { "serverKey": [] }, { "oauth": [ "custom_identifiers:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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": [ "id" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "saved": { "type": "boolean" } }, "required": [ "saved" ], "additionalProperties": {} }, "example": { "saved": true } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "custom_identifiers:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_delete_custom_identifier" } }, "/v1/imports": { "get": { "operationId": "imports.list", "summary": "List imports.", "tags": [ "transfer" ], "description": "Requires `imports:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_imports`.", "security": [ { "serverKey": [] }, { "oauth": [ "imports:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "imports:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_imports" }, "post": { "operationId": "imports.create", "summary": "Import structured granted outcomes.", "tags": [ "transfer" ], "description": "Requires `imports:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_create_outcome_import`.", "security": [ { "serverKey": [] }, { "oauth": [ "imports:write" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "outcomes": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "external_outcome_id": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "outcome": { "type": "string", "const": "granted" }, "benefit": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "subject": { "type": "object", "properties": { "external_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "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,}$" }, "email_verified": { "type": "boolean" } }, "required": [ "email" ], "additionalProperties": false }, "occurred_at": { "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)))$" }, "claim_id": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } }, "required": [ "outcome", "benefit", "subject", "occurred_at" ], "additionalProperties": false } } }, "required": [ "outcomes" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "state": "pending", "accepted": 1 } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "imports:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_create_outcome_import" } }, "/v1/imports/csv": { "post": { "operationId": "imports.csv", "summary": "Stage a CSV outcome import.", "tags": [ "transfer" ], "description": "Requires `imports:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_create_csv_import`.", "security": [ { "serverKey": [] }, { "oauth": [ "imports:write" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {}, "additionalProperties": false } } } }, "responses": { "202": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "pending", "status_url": "/v1/imports/00000000-0000-4000-8000-000000000001", "upload_url": "https://uploads.example.invalid/signed-upload" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "imports:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_create_csv_import" } }, "/v1/imports/{id}": { "get": { "operationId": "imports.get", "summary": "Read an import.", "tags": [ "transfer" ], "description": "Requires `imports:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_import`.", "security": [ { "serverKey": [] }, { "oauth": [ "imports:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "imports:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_import" } }, "/v1/imports/{id}/errors": { "get": { "operationId": "imports.errors", "summary": "Read import errors.", "tags": [ "transfer" ], "description": "Requires `imports:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_import_errors`.", "security": [ { "serverKey": [] }, { "oauth": [ "imports:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "imports:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_import_errors" } }, "/v1/imports/{id}/validate": { "post": { "operationId": "imports.validate", "summary": "Validate an import.", "tags": [ "transfer" ], "description": "Requires `imports:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_validate_import`.", "security": [ { "serverKey": [] }, { "oauth": [ "imports:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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": [ "id" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "imports:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_validate_import" } }, "/v1/imports/{id}/confirm": { "post": { "operationId": "imports.confirm", "summary": "Confirm an import.", "tags": [ "transfer" ], "description": "Requires `imports:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_confirm_import`.", "security": [ { "serverKey": [] }, { "oauth": [ "imports:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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": [ "id" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "imports:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_confirm_import" } }, "/v1/imports/{id}/cancel": { "post": { "operationId": "imports.cancel", "summary": "Cancel the import and permanently delete its uploaded file and unfinished rows. This cannot be reversed.", "tags": [ "transfer" ], "description": "Requires `imports:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_cancel_import`.", "security": [ { "serverKey": [] }, { "oauth": [ "imports:write" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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": [ "id" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "saved": { "type": "boolean" } }, "required": [ "saved" ], "additionalProperties": {} }, "example": { "saved": true } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "imports:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_cancel_import" } }, "/v1/exports": { "get": { "operationId": "exports.list", "summary": "List exports.", "tags": [ "transfer" ], "description": "Requires `exports:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_exports`.", "security": [ { "serverKey": [] }, { "oauth": [ "exports:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "exports:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_exports" }, "post": { "operationId": "exports.create", "summary": "Create an evaluation export.", "tags": [ "transfer" ], "description": "Requires `exports:create`. Available in Test and Live. Test accepts a maximum 30-day range; Live accepts up to 90 days. Requests above the Test limit return 422 TEST_RETENTION_RANGE. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_request_export`.", "security": [ { "serverKey": [] }, { "oauth": [ "exports:create" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "days": { "default": 30, "type": "integer", "minimum": 1, "maximum": 90, "description": "Date range in days. Test accepts 1-30; Live accepts 1-90." } }, "required": [ "days" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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)$" }, "status": { "type": "string" }, "status_url": { "type": "string" } }, "required": [ "id", "status", "status_url" ], "additionalProperties": false }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "pending", "status_url": "/v1/exports/00000000-0000-4000-8000-000000000001" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "exports:create", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_request_export" } }, "/v1/exports/{id}": { "get": { "operationId": "exports.get", "summary": "Read export status.", "tags": [ "transfer" ], "description": "Requires `exports:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_export`.", "security": [ { "serverKey": [] }, { "oauth": [ "exports:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "exports:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_export" } }, "/v1/exports/{id}/download": { "get": { "operationId": "exports.download", "summary": "Create a short-lived export download URL.", "tags": [ "transfer" ], "description": "Requires `exports:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_export_download`.", "security": [ { "serverKey": [] }, { "oauth": [ "exports:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "exports:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_export_download" } }, "/v1/data-deletions/preview": { "post": { "operationId": "deletions.preview", "summary": "Preview recipient-history deletion.", "tags": [ "deletion" ], "description": "Requires `data_deletions:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_preview_data_deletion`.", "security": [ { "serverKey": [] }, { "oauth": [ "data_deletions:write" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "selector": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "subject" }, "recipient": { "type": "string", "minLength": 1, "maxLength": 254 }, "email": { "type": "boolean" } }, "required": [ "kind", "recipient", "email" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "organization" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "selector" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "data_deletions:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_preview_data_deletion" } }, "/v1/data-deletions": { "get": { "operationId": "deletions.list", "summary": "List data deletions.", "tags": [ "deletion" ], "description": "Requires `data_deletions:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_data_deletions`.", "security": [ { "serverKey": [] }, { "oauth": [ "data_deletions:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "data_deletions:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_data_deletions" }, "post": { "operationId": "deletions.create", "summary": "Permanently delete recipient history. This cannot be reversed.", "tags": [ "deletion" ], "description": "Requires `data_deletions:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_request_data_deletion`.", "security": [ { "serverKey": [] }, { "oauth": [ "data_deletions:write" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "selector": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "subject" }, "recipient": { "type": "string", "minLength": 1, "maxLength": 254 }, "email": { "type": "boolean" } }, "required": [ "kind", "recipient", "email" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "organization" } }, "required": [ "kind" ], "additionalProperties": false } ] } }, "required": [ "selector" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "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)$" }, "status": { "type": "string" }, "status_url": { "type": "string" } }, "required": [ "id", "status", "status_url" ], "additionalProperties": false }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "pending", "status_url": "/v1/data-deletions/00000000-0000-4000-8000-000000000001" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "data_deletions:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_request_data_deletion" } }, "/v1/data-deletions/{id}": { "get": { "operationId": "deletions.get", "summary": "Read data-deletion status.", "tags": [ "deletion" ], "description": "Requires `data_deletions:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_data_deletion`.", "security": [ { "serverKey": [] }, { "oauth": [ "data_deletions:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "data_deletions:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_data_deletion" } }, "/v1/analytics": { "get": { "operationId": "analytics.list", "summary": "Read analytics.", "tags": [ "monitoring" ], "description": "Requires `analytics:read`. Available in Test and Live. Test accepts a maximum 30-day range; Live accepts up to 90 days. Requests above the Test limit return 422 TEST_RETENTION_RANGE. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_analytics`.", "security": [ { "serverKey": [] }, { "oauth": [ "analytics:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "analytics:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_analytics" } }, "/v1/request-logs": { "get": { "operationId": "request-logs.list", "summary": "Read request logs.", "tags": [ "monitoring" ], "description": "Requires `request_logs:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_request_logs`.", "security": [ { "serverKey": [] }, { "oauth": [ "request_logs:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "request_logs:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_request_logs" } }, "/v1/request-logs/{id}": { "get": { "operationId": "request-logs.get", "summary": "Read a request log.", "tags": [ "monitoring" ], "description": "Requires `request_logs:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_request_log`.", "security": [ { "serverKey": [] }, { "oauth": [ "request_logs:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "request_logs:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_request_log" } }, "/v1/audit-logs": { "get": { "operationId": "audit-logs.list", "summary": "Read audit logs.", "tags": [ "monitoring" ], "description": "Requires `audit_logs:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_audit_logs`.", "security": [ { "serverKey": [] }, { "oauth": [ "audit_logs:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "audit_logs:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_list_audit_logs" } }, "/v1/audit-logs/{id}": { "get": { "operationId": "audit-logs.get", "summary": "Read a audit log.", "tags": [ "monitoring" ], "description": "Requires `audit_logs:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_audit_log`.", "security": [ { "serverKey": [] }, { "oauth": [ "audit_logs:read" ] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "audit_logs:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_audit_log" } }, "/v1/browser-collection": { "get": { "operationId": "browser_collection.get", "summary": "Read browser-collection configuration.", "tags": [ "browser" ], "description": "Requires `browser_collection:read`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_browser_collection`.", "security": [ { "serverKey": [] }, { "oauth": [ "browser_collection:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "enabled": true, "origins": [ "https://app.example.com" ], "revision": 2 } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "browser_collection:read", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_get_browser_collection" }, "patch": { "operationId": "browser_collection.update", "summary": "Update browser-collection configuration.", "tags": [ "browser" ], "description": "Requires `browser_collection:write`. Available in Test and Live. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_update_browser_collection`.", "security": [ { "serverKey": [] }, { "oauth": [ "browser_collection:write" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "enabled": { "type": "boolean" }, "origins": { "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 256, "format": "uri" } }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "enabled", "origins" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "enabled": true, "origins": [ "https://app.example.com" ], "revision": 2 } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "browser_collection:write", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": "veltor_update_browser_collection" } }, "/v1/observations": { "post": { "operationId": "observations.create", "summary": "Create a browser-origin observation.", "tags": [ "observation" ], "description": "Requires `observations:create`. Available in Test and Live. The server deadline is 1.5 seconds. MCP exception: Remote agents cannot produce trustworthy browser-origin evidence.", "security": [ { "publishableKey": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "claim_id": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" }, "fingerprint": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "browser": { "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)$" }, "algorithm": { "type": "string", "maxLength": 32, "pattern": "^5\\." }, "nonce": { "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": [ "claim_id", "fingerprint", "browser", "algorithm", "nonce" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "token": { "type": "string" }, "expires_in": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "token", "expires_in" ], "additionalProperties": false }, "example": { "token": "signed-browser-observation", "expires_in": 300 } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "observations:create", "x-veltor-environments": [ "test", "live" ], "x-veltor-mcp-tool": null } }, "/v1/test-fixtures/ip": { "get": { "operationId": "fixtures.list", "summary": "List Test IP fixtures.", "tags": [ "test" ], "description": "Requires `test_fixtures:read`. Available in Test. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_list_ip_fixtures`.", "security": [ { "serverKey": [] }, { "oauth": [ "test_fixtures:read" ] } ], "parameters": [ { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": false }, "example": { "data": [], "next_cursor": null } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "test_fixtures:read", "x-veltor-environments": [ "test" ], "x-veltor-mcp-tool": "veltor_list_ip_fixtures" } }, "/v1/test-fixtures/ip/{address}": { "get": { "operationId": "fixtures.get", "summary": "Read a Test IP fixture.", "tags": [ "test" ], "description": "Requires `test_fixtures:read`. Available in Test. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_get_ip_fixture`.", "security": [ { "serverKey": [] }, { "oauth": [ "test_fixtures:read" ] } ], "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 45 } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "test_fixtures:read", "x-veltor-environments": [ "test" ], "x-veltor-mcp-tool": "veltor_get_ip_fixture" }, "put": { "operationId": "fixtures.update", "summary": "Update a configurable Test IP fixture.", "tags": [ "test" ], "description": "Requires `test_fixtures:write`. Available in Test. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_update_ip_fixture`.", "security": [ { "serverKey": [] }, { "oauth": [ "test_fixtures:write" ] } ], "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 45 } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "address": { "type": "string", "maxLength": 45 }, "fixture": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "available", "unavailable" ] }, "payload": { "anyOf": [ { "type": "object", "properties": { "schema_version": { "type": "number", "const": 1 }, "ip_version": { "anyOf": [ { "type": "number", "const": 4 }, { "type": "number", "const": 6 } ] }, "geography": { "type": "object", "properties": { "continent": { "type": "object", "properties": { "geoname_id": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "names": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "code": { "anyOf": [ { "type": "string", "maxLength": 2 }, { "type": "null" } ] } }, "required": [ "geoname_id", "names", "code" ], "additionalProperties": false }, "country": { "type": "object", "properties": { "geoname_id": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "names": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "iso_code": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 2 }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "is_in_european_union": { "type": "boolean" } }, "required": [ "geoname_id", "names", "iso_code", "confidence", "is_in_european_union" ], "additionalProperties": false }, "registered_country": { "type": "object", "properties": { "geoname_id": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "names": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "iso_code": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 2 }, { "type": "null" } ] }, "is_in_european_union": { "type": "boolean" } }, "required": [ "geoname_id", "names", "iso_code", "is_in_european_union" ], "additionalProperties": false }, "represented_country": { "type": "object", "properties": { "geoname_id": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "names": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "iso_code": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 2 }, { "type": "null" } ] }, "is_in_european_union": { "type": "boolean" }, "type": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] } }, "required": [ "geoname_id", "names", "iso_code", "is_in_european_union", "type" ], "additionalProperties": false }, "subdivisions": { "type": "array", "items": { "type": "object", "properties": { "geoname_id": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "names": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "iso_code": { "anyOf": [ { "type": "string", "maxLength": 3 }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] } }, "required": [ "geoname_id", "names", "iso_code", "confidence" ], "additionalProperties": false } }, "city": { "type": "object", "properties": { "geoname_id": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "names": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] } }, "required": [ "geoname_id", "names", "confidence" ], "additionalProperties": false }, "postal": { "type": "object", "properties": { "code": { "anyOf": [ { "type": "string", "maxLength": 32 }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] } }, "required": [ "code", "confidence" ], "additionalProperties": false }, "location": { "type": "object", "properties": { "latitude": { "anyOf": [ { "type": "number", "minimum": -90, "maximum": 90 }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "minimum": -180, "maximum": 180 }, { "type": "null" } ] }, "accuracy_radius_km": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "time_zone": { "anyOf": [ { "type": "string", "maxLength": 80 }, { "type": "null" } ] } }, "required": [ "latitude", "longitude", "accuracy_radius_km", "time_zone" ], "additionalProperties": false } }, "required": [ "continent", "country", "registered_country", "represented_country", "subdivisions", "city", "postal", "location" ], "additionalProperties": false }, "network": { "type": "object", "properties": { "cidr": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "asn": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 4294967295 }, { "type": "null" } ] }, "autonomous_system_organization": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "connection_type": { "anyOf": [ { "type": "string", "enum": [ "cable_dsl", "cellular", "corporate", "dialup", "satellite" ] }, { "type": "null" } ] }, "unrecognized_connection_type": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] }, "domain": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "isp": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "organization": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "is_anycast": { "type": "boolean" }, "mobile_country_code": { "anyOf": [ { "type": "string", "pattern": "^\\d{3}$" }, { "type": "null" } ] }, "mobile_network_code": { "anyOf": [ { "type": "string", "pattern": "^\\d{2,3}$" }, { "type": "null" } ] }, "user_count": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "user_type": { "anyOf": [ { "type": "string", "enum": [ "business", "cafe", "cellular", "college", "consumer_privacy_network", "content_delivery_network", "government", "hosting", "library", "military", "residential", "router", "school", "search_engine_spider", "traveler" ] }, { "type": "null" } ] }, "unrecognized_user_type": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "cidr", "asn", "autonomous_system_organization", "connection_type", "unrecognized_connection_type", "domain", "isp", "organization", "is_anycast", "mobile_country_code", "mobile_network_code", "user_count", "user_type", "unrecognized_user_type" ], "additionalProperties": false }, "risk": { "type": "object", "properties": { "ip_risk_snapshot": { "anyOf": [ { "type": "number", "minimum": 0.01, "maximum": 99 }, { "type": "null" } ] }, "static_ip_score": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 99.99 }, { "type": "null" } ] } }, "required": [ "ip_risk_snapshot", "static_ip_score" ], "additionalProperties": false }, "anonymizer": { "type": "object", "properties": { "confidence": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 99 }, { "type": "null" } ] }, "is_anonymous": { "type": "boolean" }, "is_anonymous_vpn": { "type": "boolean" }, "is_hosting_provider": { "type": "boolean" }, "is_public_proxy": { "type": "boolean" }, "is_residential_proxy": { "type": "boolean" }, "is_tor_exit_node": { "type": "boolean" }, "network_last_seen": { "anyOf": [ { "type": "string", "format": "date", "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])))$" }, { "type": "null" } ] }, "provider_name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "residential": { "type": "object", "properties": { "confidence": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 99 }, { "type": "null" } ] }, "network_last_seen": { "anyOf": [ { "type": "string", "format": "date", "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])))$" }, { "type": "null" } ] }, "provider_name": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] } }, "required": [ "confidence", "network_last_seen", "provider_name" ], "additionalProperties": false } }, "required": [ "confidence", "is_anonymous", "is_anonymous_vpn", "is_hosting_provider", "is_public_proxy", "is_residential_proxy", "is_tor_exit_node", "network_last_seen", "provider_name", "residential" ], "additionalProperties": false } }, "required": [ "schema_version", "ip_version", "geography", "network", "risk", "anonymizer" ], "additionalProperties": false }, { "type": "null" } ] }, "age_hours": { "type": "number", "minimum": 0, "maximum": 2160 }, "fact_overrides": { "type": "object", "properties": { "ip.attempts_1m": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "ip.attempts_1h": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "ip.attempts_24h": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "ip.prior_outcomes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "required": [ "status", "payload", "age_hours", "fact_overrides" ], "additionalProperties": false } }, "required": [ "address", "fixture" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "test_fixtures:write", "x-veltor-environments": [ "test" ], "x-veltor-mcp-tool": "veltor_update_ip_fixture" }, "delete": { "operationId": "fixtures.reset", "summary": "Reset a configurable Test IP fixture to its defaults. Its current settings cannot be restored.", "tags": [ "test" ], "description": "Requires `test_fixtures:write`. Available in Test. The server deadline is 5 seconds. Equivalent MCP tool: `veltor_reset_ip_fixture`.", "security": [ { "serverKey": [] }, { "oauth": [ "test_fixtures:write" ] } ], "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string", "maxLength": 45 } }, { "name": "Veltor-Organization", "in": "header", "required": false, "description": "Required for OAuth calls except organization discovery. API keys already bind an organization.", "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Reuse this value only when retrying the same mutation and payload.", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[\\x21-\\x7e]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "address": { "type": "string", "maxLength": 45 } }, "required": [ "address" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Canonical domain result. Evaluation and preview results can report skipped work without a policy decision.", "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "example": { "id": "00000000-0000-4000-8000-000000000001", "status": "available" } } } }, "400": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Structured technical error. A technical error is never a policy denial.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-veltor-scope": "test_fixtures:write", "x-veltor-environments": [ "test" ], "x-veltor-mcp-tool": "veltor_reset_ip_fixture" } } }, "components": { "securitySchemes": { "serverKey": { "type": "http", "scheme": "bearer", "description": "Restricted or full-access Veltor server API key." }, "publishableKey": { "type": "http", "scheme": "bearer", "description": "Publishable browser key. It grants only observations:create." }, "oauth": { "type": "oauth2", "description": "Veltor Better Auth authorization with Authorization Code and PKCE.", "flows": { "authorizationCode": { "authorizationUrl": "https://auth.veltor.dev/api/auth/oauth2/authorize", "tokenUrl": "https://auth.veltor.dev/api/auth/oauth2/token", "scopes": { "organizations:read": "Grant organizations:read access.", "evaluations:create": "Grant evaluations:create access.", "evaluations:read": "Grant evaluations:read access.", "evaluation_evidence:read": "Grant evaluation_evidence:read access.", "outcomes:read": "Grant outcomes:read access.", "outcomes:write": "Grant outcomes:write access.", "simulations:run": "Grant simulations:run access.", "benefits:read": "Grant benefits:read access.", "benefits:write": "Grant benefits:write access.", "policies:read": "Grant policies:read access.", "policies:write": "Grant policies:write access.", "exceptions:read": "Grant exceptions:read access.", "exceptions:write": "Grant exceptions:write access.", "custom_identifiers:read": "Grant custom_identifiers:read access.", "custom_identifiers:write": "Grant custom_identifiers:write access.", "imports:read": "Grant imports:read access.", "imports:write": "Grant imports:write access.", "exports:read": "Grant exports:read access.", "exports:create": "Grant exports:create access.", "data_deletions:read": "Grant data_deletions:read access.", "data_deletions:write": "Grant data_deletions:write access.", "analytics:read": "Grant analytics:read access.", "request_logs:read": "Grant request_logs:read access.", "audit_logs:read": "Grant audit_logs:read access.", "browser_collection:read": "Grant browser_collection:read access.", "browser_collection:write": "Grant browser_collection:write access.", "test_fixtures:read": "Grant test_fixtures:read access.", "test_fixtures:write": "Grant test_fixtures:write access." } } } } }, "schemas": { "Error": { "type": "object", "additionalProperties": false, "required": [ "error", "request_id" ], "properties": { "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message", "retryable" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": [ "string", "null" ] }, "retryable": { "type": "boolean" } } }, "request_id": { "type": "string", "format": "uuid" } } } } }, "x-veltor-scope-groups": [ { "id": "organization", "name": "Organization context", "scopes": [ "organizations:read" ] }, { "id": "evaluations", "name": "Evaluations and outcomes", "scopes": [ "evaluations:create", "evaluations:read", "evaluation_evidence:read", "outcomes:read", "outcomes:write", "simulations:run" ] }, { "id": "benefits", "name": "Benefits", "scopes": [ "benefits:read", "benefits:write" ] }, { "id": "policies", "name": "Policies", "scopes": [ "policies:read", "policies:write" ] }, { "id": "identifiers", "name": "Exceptions and identifiers", "scopes": [ "exceptions:read", "exceptions:write", "custom_identifiers:read", "custom_identifiers:write" ] }, { "id": "transfer", "name": "Imports and exports", "scopes": [ "imports:read", "imports:write", "exports:read", "exports:create" ] }, { "id": "deletion", "name": "Data deletion", "scopes": [ "data_deletions:read", "data_deletions:write" ] }, { "id": "monitoring", "name": "Monitoring", "scopes": [ "analytics:read", "request_logs:read", "audit_logs:read" ] }, { "id": "browser", "name": "Browser collection", "scopes": [ "browser_collection:read", "browser_collection:write" ] }, { "id": "test", "name": "Test tools", "scopes": [ "test_fixtures:read", "test_fixtures:write" ] }, { "id": "observation", "name": "Browser observation", "scopes": [ "observations:create" ] } ] }