{ "openapi": "3.1.1", "info": { "title": "Wincora API", "version": "1.0.0", "description": "Build visa intelligence, customer journeys, and connected operations into your application with one Wincora API across Visa Intelligence, Tenant, and Traveler surfaces.", "contact": { "name": "Wincora", "email": "hello@wincora.com" } }, "servers": [ { "url": "https://api.wincora.com/api/v1", "description": "Wincora API" } ], "tags": [ { "name": "authentication", "description": "Issue, renew, and revoke customer sessions through the appropriate authentication flow.", "x-surface": "authentication" }, { "name": "intelligence-reference", "description": "Country, intent, and held-authorization codes for visa intelligence requests.", "x-surface": "intelligence" }, { "name": "reference", "description": "Discover your integration capabilities and the reference values that power your forms.", "x-surface": "tenant" }, { "name": "visa-intelligence", "description": "Understand travel requirements, resolve trip purpose, and separate visa conclusions from service availability.", "x-surface": "intelligence" }, { "name": "products", "description": "Explore tenant offerings, service levels, and the information an application requires.", "x-surface": "tenant" }, { "name": "quotes-and-leads", "description": "Create a price snapshot for a trip, or capture an enquiry when a traveler needs further help.", "x-surface": "tenant" }, { "name": "customers-and-travelers", "description": "Connect your customer records to Wincora without requiring travelers to create a separate login.", "x-surface": "tenant" }, { "name": "orders", "description": "Turn an accepted quote into an order and its traveler cases. Keep commercial and case state separate.", "x-surface": "tenant" }, { "name": "cases", "description": "Build your own collection experience with structured requirements, readiness checks, and explicit submission.", "x-surface": "tenant" }, { "name": "documents", "description": "Upload evidence, follow durable processing operations, and reuse authorized traveler documents.", "x-surface": "tenant" }, { "name": "payments", "description": "Work with invoices, checkout, external settlements, credit notes, and refunds.", "x-surface": "tenant" }, { "name": "deliverables", "description": "Retrieve released application results through authorized, short-lived download grants.", "x-surface": "tenant" }, { "name": "messages-and-support", "description": "Keep customer-facing conversations and support requests inside your application.", "x-surface": "tenant" }, { "name": "webhooks", "description": "React to platform changes and recover missed updates through the same durable event log.", "x-surface": "tenant" }, { "name": "operations", "description": "Bring authorized review and fulfillment tasks into your staff system using explicit business actions.", "x-surface": "tenant" }, { "name": "reports", "description": "Read scoped financial and operational reports with currency-aware totals.", "x-surface": "tenant" }, { "name": "assistant", "description": "Add optional conversational assistance while retaining a complete form-based collection flow.", "x-surface": "tenant" }, { "name": "identities", "description": "Map signed-in people to explicitly authorized travelers and cases.", "x-surface": "tenant" }, { "name": "traveler-session", "description": "Inspect your current access and securely end your customer session.", "x-surface": "traveler" }, { "name": "traveler-cases", "description": "Complete assigned applications using typed requirements and explicit submission.", "x-surface": "traveler" }, { "name": "traveler-documents", "description": "Upload and retrieve evidence for your permitted cases and follow processing status.", "x-surface": "traveler" }, { "name": "traveler-orders", "description": "Read customer-safe order details and pay only where billing access is granted.", "x-surface": "traveler" }, { "name": "traveler-collaboration", "description": "Ask for help, respond to requests, and retrieve released results.", "x-surface": "traveler" } ], "paths": { "/tenant/integration": { "get": { "operationId": "get_integration", "tags": [ "reference" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Inspect your integration", "description": "Identity summary, effective capabilities, limits, environment, communication mode. ", "x-required-grants": [], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "int_example", "environment": "test", "grants": [ "visa:query", "orders:read" ], "communicationMode": "tenantManaged", "capabilities": [ "visaDetermination" ] } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/intelligence/reference/countries": { "get": { "operationId": "get_reference_countries", "tags": [ "intelligence-reference" ], "security": [ { "ApiKey": [] } ], "x-surface": "intelligence", "x-auth-mode": "apiKey", "summary": "List countries", "description": "Filtered/paginated ISO codes and names. ", "x-required-grants": [ "reference:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/intelligence/reference/intents": { "get": { "operationId": "get_reference_intents", "tags": [ "intelligence-reference" ], "security": [ { "ApiKey": [] } ], "x-surface": "intelligence", "x-auth-mode": "apiKey", "summary": "List intents", "description": "Allowed intent codes and labels. ", "x-required-grants": [ "reference:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/intelligence/reference/held-authorizations": { "get": { "operationId": "get_reference_held_authorizations", "tags": [ "intelligence-reference" ], "security": [ { "ApiKey": [] } ], "x-surface": "intelligence", "x-auth-mode": "apiKey", "summary": "List held authorizations", "description": "Allowed authorization codes, issuer/expiry input guidance. ", "x-required-grants": [ "reference:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/reference/document-types": { "get": { "operationId": "get_reference_document_types", "tags": [ "reference" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List document types", "description": "Public document type codes and supported processing capabilities. ", "x-required-grants": [ "reference:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/reference/lists/{key}": { "get": { "operationId": "get_reference_lists_key", "tags": [ "reference" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get lists", "description": "Allowlisted public field options; no unrestricted internal list access. ", "x-required-grants": [ "reference:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/intelligence/intent-resolutions": { "post": { "operationId": "post_visa_intent_resolutions", "tags": [ "visa-intelligence" ], "security": [ { "ApiKey": [] } ], "x-surface": "intelligence", "x-auth-mode": "apiKey", "summary": "Resolve travel intent", "description": "Corridor + statement + optional previous focus returns suggested intent/confidence/clarification. ", "x-required-grants": [ "visa:query" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntentInput" }, "example": { "passportCountry": "IN", "destinationCountry": "FR", "statement": "A ten-day holiday, with no work activities." } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/intelligence/determinations": { "post": { "operationId": "post_visa_determinations", "tags": [ "visa-intelligence" ], "security": [ { "ApiKey": [] } ], "x-surface": "intelligence", "x-auth-mode": "apiKey", "summary": "Determine visa requirements", "description": "Traveler facts + one dated entry leg returns persisted conclusion and availability. This endpoint accepts one dated entry leg with an ordinary passport. Unsupported trip shapes must be rejected, not simplified.", "x-required-grants": [ "visa:query" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeterminationInput" }, "example": { "traveler": { "passportCountry": "IN", "passportType": "ordinary", "residenceCountry": "US", "heldAuthorizations": [] }, "legs": [ { "reference": "outbound", "destinationCountry": "FR", "intent": "TOURISM", "arrivalDate": "2026-11-10", "departureDate": "2026-11-20", "transitContext": "entry" } ] } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "det_example", "evaluatedAt": "2026-09-23T15:00:00Z", "visaConclusion": { "kind": "undetermined", "conditions": [], "requiresClarification": false }, "serviceAvailability": { "kind": "undetermined", "offers": [] }, "knowledge": { "engineVersion": "example-version", "sourceAsOf": null, "authorityStatus": "unavailable", "warnings": [ "No authoritative determination is available for these inputs." ] } } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/intelligence/determinations/{id}": { "get": { "operationId": "get_visa_determinations_id", "tags": [ "visa-intelligence" ], "security": [ { "ApiKey": [] } ], "x-surface": "intelligence", "x-auth-mode": "apiKey", "summary": "Get determinations", "description": "Stored permitted query/result and metadata. This endpoint accepts one dated entry leg with an ordinary passport. Unsupported trip shapes must be rejected, not simplified.", "x-required-grants": [ "visa:query" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/products": { "get": { "operationId": "get_products", "tags": [ "products" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List products", "description": "Destination/intent/availability filters returns tenant offerings. ", "x-required-grants": [ "catalog:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/products/{id}": { "get": { "operationId": "get_products_id", "tags": [ "products" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get products", "description": "Offering, service levels, availability and prerequisites. ", "x-required-grants": [ "catalog:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/products/{id}/requirements": { "get": { "operationId": "get_products_id_requirements", "tags": [ "products" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get requirements", "description": "Product requirement schema, documents, conditions and source timestamps. ", "x-required-grants": [ "catalog:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/quotes": { "post": { "operationId": "post_quotes", "tags": [ "quotes-and-leads" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create a quote", "description": "Customer, traveler/product/service items, determination references returns frozen pricing snapshot. ", "x-required-grants": [ "quotes:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteInput" }, "example": { "customerId": "cus_example", "items": [ { "travelerId": "trav_example", "determinationId": "det_example", "productId": "prod_example", "serviceLevel": "standard" } ], "travelStartDate": "2026-11-10", "travelEndDate": "2026-11-20" } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/quotes/{id}": { "get": { "operationId": "get_quotes_id", "tags": [ "quotes-and-leads" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get quotes", "description": "Quote snapshot, expiry, accepted input binding. ", "x-required-grants": [ "quotes:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/leads": { "post": { "operationId": "post_leads", "tags": [ "quotes-and-leads" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create leads", "description": "Contact/trip facts, consent, optional determination reference. ", "x-required-grants": [ "leads:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "get_leads", "tags": [ "quotes-and-leads" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List leads", "description": "Integration-visible capture/status and conversion link. ", "x-required-grants": [ "leads:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/leads/{id}": { "get": { "operationId": "get_leads_id", "tags": [ "quotes-and-leads" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get leads", "description": "Integration-visible capture/status and conversion link. ", "x-required-grants": [ "leads:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/customers": { "post": { "operationId": "post_customers", "tags": [ "customers-and-travelers" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create a customer", "description": "Personal/corporate type, identity/contact facts, external reference. ", "x-required-grants": [ "customers:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerInput" }, "example": { "type": "corporate", "displayName": "Acme Travel", "externalReference": "customer-1042" } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "get_customers", "tags": [ "customers-and-travelers" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List customers", "description": "Scoped list/detail; external reference filter. ", "x-required-grants": [ "customers:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/customers/{id}": { "get": { "operationId": "get_customers_id", "tags": [ "customers-and-travelers" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get customers", "description": "Scoped list/detail; external reference filter. ", "x-required-grants": [ "customers:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "patch": { "operationId": "patch_customers_id", "tags": [ "customers-and-travelers" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Update customers", "description": "Allowlisted contact/display fields; ETag. ", "x-required-grants": [ "customers:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/travelers": { "post": { "operationId": "post_travelers", "tags": [ "customers-and-travelers" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create a traveler", "description": "Traveler identity/contact facts and permitted customer association. ", "x-required-grants": [ "travelers:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TravelerInput" }, "example": { "customerId": "cus_example", "firstName": "Alex", "lastName": "Morgan", "email": "alex@example.com", "externalReference": "traveler-218" } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "get_travelers", "tags": [ "customers-and-travelers" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List travelers", "description": "Scoped records; external reference filter. ", "x-required-grants": [ "travelers:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/travelers/{id}": { "get": { "operationId": "get_travelers_id", "tags": [ "customers-and-travelers" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get travelers", "description": "Scoped records; external reference filter. ", "x-required-grants": [ "travelers:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "patch": { "operationId": "patch_travelers_id", "tags": [ "customers-and-travelers" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Update travelers", "description": "Typed profile changes; ETag. ", "x-required-grants": [ "travelers:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/customers/{id}/travelers": { "post": { "operationId": "post_customers_id_travelers", "tags": [ "customers-and-travelers" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create travelers", "description": "Link a separately authorized traveler. ", "x-required-grants": [ "customers:write", "travelers:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/orders": { "post": { "operationId": "post_orders", "tags": [ "orders" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create an order", "description": "Quote ID, external reference, trip label returns order + all cases. The quote is revalidated before creation. Order creation commits the order and all cases together. Invoice preparation can continue asynchronously.", "x-required-grants": [ "orders:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderInput" }, "example": { "quoteId": "quote_example", "externalReference": "booking-4387", "tripName": "November trip" } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "ord_example", "externalReference": "booking-4387", "status": "open", "billingStatus": "preparing", "communicationMode": "tenantManaged", "cases": [ { "id": "case_example", "travelerId": "trav_example", "stage": "inCollection", "requirementsVersion": "rv_example", "nextActions": [ "provideData", "provideDocuments" ] } ] } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "get_orders", "tags": [ "orders" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List orders", "description": "Scoped list/detail, case references and financial summary. ", "x-required-grants": [ "orders:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/orders/{id}": { "get": { "operationId": "get_orders_id", "tags": [ "orders" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get orders", "description": "Scoped list/detail, case references and financial summary. ", "x-required-grants": [ "orders:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/orders/{id}/cases": { "get": { "operationId": "get_orders_id_cases", "tags": [ "orders" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List cases", "description": "Cases belonging to this authorized order. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/orders/{id}/cancellation-requests": { "post": { "operationId": "post_orders_id_cancellation_requests", "tags": [ "orders" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create cancellation requests", "description": "Reason + ETag returns applied cancellation or tracked request. ", "x-required-grants": [ "orders:cancel" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonInput" }, "example": { "reason": "The traveler’s plans have changed." } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/orders/{id}/cancellation-requests/{requestId}": { "get": { "operationId": "get_orders_id_cancellation_requests_requestId", "tags": [ "orders" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get cancellation requests", "description": "Status, affected cases, financial follow-up. ", "x-required-grants": [ "orders:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases": { "get": { "operationId": "get_cases", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List cases", "description": "Stage, separate fulfillment/payment/delivery state, next actions and ETag. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}": { "get": { "operationId": "get_cases_id", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get cases", "description": "Stage, separate fulfillment/payment/delivery state, next actions and ETag. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/requirements": { "get": { "operationId": "get_cases_id_requirements", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get requirements", "description": "Frozen typed form/document schema + requirements version. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/data": { "get": { "operationId": "get_cases_id_data", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get data", "description": "Permitted collected values and provenance + ETag. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "patch": { "operationId": "patch_cases_id_data", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Update case data", "description": "Versioned typed field/list changes + ETag. ", "x-required-grants": [ "cases:data:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataInput" }, "example": { "requirementsVersion": "rv_example", "changes": [ { "fieldId": "passport.expiryDate", "value": "2030-06-30" } ], "listChanges": [] } } } }, "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/readiness": { "get": { "operationId": "get_cases_id_readiness", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Check submission readiness", "description": "All submission blockers, canSubmit, next actions. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "caseId": "case_example", "canSubmit": false, "resubmissionRequired": false, "blockers": [ { "code": "document_missing", "requirementId": "passport.identityPage" } ], "nextActions": [ "uploadDocument" ] } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/submissions": { "post": { "operationId": "post_cases_id_submissions", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Submit a case", "description": "Explicit initial submit or resubmit intent + ETag. This submits collected information to Wincora. It does not record filing with a government authority. Initial submission and RFE resubmission use different readiness rules.", "x-required-grants": [ "cases:submit" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/collection-requests": { "get": { "operationId": "get_cases_id_collection_requests", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List collection requests", "description": "Public asks and items; resubmission requirement. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "operationId": "post_cases_id_collection_requests", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create collection requests", "description": "Structured field/document/question asks, public message. ", "x-required-grants": [ "operations:write" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/collection-items/{itemId}/answers": { "post": { "operationId": "post_cases_id_collection_items_itemId_answers", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create answers", "description": "Ad-hoc answer + case ETag. ", "x-required-grants": [ "cases:data:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerInput" }, "example": { "answer": "I will collect my passport in person." } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/cancellation-requests": { "post": { "operationId": "post_cases_id_cancellation_requests", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create cancellation requests", "description": "Reason + ETag returns applied/tracked cancellation. ", "x-required-grants": [ "cases:cancel" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonInput" }, "example": { "reason": "The traveler’s plans have changed." } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/cancellation-requests/{requestId}": { "get": { "operationId": "get_cases_id_cancellation_requests_requestId", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get cancellation requests", "description": "Status and financial follow-up. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/timeline": { "get": { "operationId": "get_cases_id_timeline", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List timeline", "description": "Customer-visible historical changes with pagination. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/fulfillment": { "get": { "operationId": "get_cases_id_fulfillment", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get fulfillment", "description": "Safe progress, blockers and next actions. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/appointments": { "get": { "operationId": "get_cases_id_appointments", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List appointments", "description": "Customer-safe appointment records/instructions. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/shipments": { "get": { "operationId": "get_cases_id_shipments", "tags": [ "cases" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List shipments", "description": "Permitted logistics records and tracking status. ", "x-required-grants": [ "cases:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/documents": { "post": { "operationId": "post_cases_id_documents", "tags": [ "documents" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Upload a case document", "description": "Multipart bytes + requirement ID returns 202 operation/document. Processing success and document review are separate. A warning or pending review does not automatically mean rejection. Poll the operation returned in Location.", "x-required-grants": [ "documents:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadInput" } } } }, "responses": { "202": { "description": "Accepted. Follow the durable operation in Location.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "operationId": "op_example", "documentId": "doc_example", "status": "queued" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "get_cases_id_documents", "tags": [ "documents" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List documents", "description": "Evidence/review/processing states. ", "x-required-grants": [ "documents:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/document-links": { "post": { "operationId": "post_cases_id_document_links", "tags": [ "documents" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create document links", "description": "Permitted vault document ID + requirement ID. ", "x-required-grants": [ "documents:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkInput" }, "example": { "documentId": "doc_example", "requirementId": "passport.identityPage" } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/travelers/{id}/documents": { "post": { "operationId": "post_travelers_id_documents", "tags": [ "documents" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create documents", "description": "Multipart bytes + type returns 202 operation/document. Processing success and document review are separate. A warning or pending review does not automatically mean rejection. Poll the operation returned in Location.", "x-required-grants": [ "documents:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadInput" } } } }, "responses": { "202": { "description": "Accepted. Follow the durable operation in Location.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "get_travelers_id_documents", "tags": [ "documents" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List documents", "description": "Permitted traveler vault records. ", "x-required-grants": [ "documents:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/documents/{id}": { "get": { "operationId": "get_documents_id", "tags": [ "documents" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get documents", "description": "Authorized metadata, processing/review outcome and warnings. ", "x-required-grants": [ "documents:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/documents/{id}/download-grants": { "post": { "operationId": "post_documents_id_download_grants", "tags": [ "documents" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create download grants", "description": "Purpose returns short-lived authorized download. Only authorized, released content can be downloaded. Grant URLs expire and must not be stored as permanent file locations.", "x-required-grants": [ "documents:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/documents/{documentId}/replacement": { "post": { "operationId": "post_cases_id_documents_documentId_replacement", "tags": [ "documents" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create replacement", "description": "Replacement bytes + ETag, preserve audit returns 202. Processing success and document review are separate. A warning or pending review does not automatically mean rejection. Poll the operation returned in Location.", "x-required-grants": [ "documents:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadInput" } } } }, "responses": { "202": { "description": "Accepted. Follow the durable operation in Location.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/operations/{id}": { "get": { "operationId": "get_operations_id", "tags": [ "documents" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get a processing operation", "description": "State, result reference, error and retry advice. ", "x-required-grants": [], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "op_example", "status": "succeeded", "result": { "type": "document", "id": "doc_example" } } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/operations/{id}/retry": { "post": { "operationId": "post_operations_id_retry", "tags": [ "documents" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create retry", "description": "Retry permitted failed work; same business object, new attempt. ", "x-required-grants": [], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted. Follow the durable operation in Location.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/orders/{id}/financials": { "get": { "operationId": "get_orders_id_financials", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get financials", "description": "Invoices, outstanding balance, payment/credit/refund summaries per currency. ", "x-required-grants": [ "billing:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/orders/{id}/checkout-sessions": { "post": { "operationId": "post_orders_id_checkout_sessions", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create checkout sessions", "description": "Supported checkout mode, validated return target returns scoped checkout configuration. ", "x-required-grants": [ "payments:checkout" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/invoices": { "get": { "operationId": "get_invoices", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List invoices", "description": "Permitted invoices/balance/status; customer/order filters. ", "x-required-grants": [ "billing:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/invoices/{id}": { "get": { "operationId": "get_invoices_id", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get invoices", "description": "Permitted invoices/balance/status; customer/order filters. ", "x-required-grants": [ "billing:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/invoices/{id}/download-grants": { "post": { "operationId": "post_invoices_id_download_grants", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create download grants", "description": "Short-lived invoice PDF access or preparation operation. Only authorized, released content can be downloaded. Grant URLs expire and must not be stored as permanent file locations.", "x-required-grants": [ "billing:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/invoices/{id}/external-payments": { "post": { "operationId": "post_invoices_id_external_payments", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create external payments", "description": "Amount, currency, supported method, external payment reference, settled time, evidence metadata. Requires a separately approved settlement grant. Validates the invoice balance and duplicate external payment references. Do not report a Stripe payment through this route.", "x-required-grants": [ "payments:record" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentInput" }, "example": { "amount": "125.00", "currency": "USD", "method": "bankTransfer", "externalPaymentReference": "payment-183", "settledAt": "2026-09-23T15:00:00Z" } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/credit-notes": { "get": { "operationId": "get_credit_notes", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List credit notes", "description": "Authorized correction facts and amounts. ", "x-required-grants": [ "billing:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/credit-notes/{id}": { "get": { "operationId": "get_credit_notes_id", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get credit notes", "description": "Authorized correction facts and amounts. ", "x-required-grants": [ "billing:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/credit-notes/{id}/download-grants": { "post": { "operationId": "post_credit_notes_id_download_grants", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create download grants", "description": "Short-lived PDF access. Only authorized, released content can be downloaded. Grant URLs expire and must not be stored as permanent file locations.", "x-required-grants": [ "billing:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/refunds": { "get": { "operationId": "get_refunds", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List refunds", "description": "Request/approval/execution/completion states. ", "x-required-grants": [ "billing:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "operationId": "post_refunds", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create refunds", "description": "Invoice/payment reference, reason and amount. ", "x-required-grants": [ "refunds:request" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/refunds/{id}": { "get": { "operationId": "get_refunds_id", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get refunds", "description": "Request/approval/execution/completion states. ", "x-required-grants": [ "billing:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/deliverables": { "get": { "operationId": "get_cases_id_deliverables", "tags": [ "deliverables" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List deliverables", "description": "Released files/inline values, type and availability. ", "x-required-grants": [ "deliverables:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/deliverables/{deliverableId}/download-grants": { "post": { "operationId": "post_cases_id_deliverables_deliverableId_download_grants", "tags": [ "deliverables" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create download grants", "description": "Authorized short-lived result download. Only authorized, released content can be downloaded. Grant URLs expire and must not be stored as permanent file locations.", "x-required-grants": [ "deliverables:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "deliverableId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/messages": { "get": { "operationId": "get_cases_id_messages", "tags": [ "messages-and-support" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List messages", "description": "Customer-visible conversation, paginated. ", "x-required-grants": [ "messages:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "operationId": "post_cases_id_messages", "tags": [ "messages-and-support" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create messages", "description": "Public message with authorized attachment references. ", "x-required-grants": [ "messages:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageInput" }, "example": { "body": "The updated document is now attached.", "attachments": [] } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/tickets": { "post": { "operationId": "post_tickets", "tags": [ "messages-and-support" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create tickets", "description": "Subject/body and permitted case/order reference. ", "x-required-grants": [ "tickets:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "get_tickets", "tags": [ "messages-and-support" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List tickets", "description": "Authorized public ticket thread/state. ", "x-required-grants": [ "tickets:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/tickets/{id}": { "get": { "operationId": "get_tickets_id", "tags": [ "messages-and-support" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get tickets", "description": "Authorized public ticket thread/state. ", "x-required-grants": [ "tickets:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/tickets/{id}/messages": { "post": { "operationId": "post_tickets_id_messages", "tags": [ "messages-and-support" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create messages", "description": "Public reply with permitted attachments. ", "x-required-grants": [ "tickets:write" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageInput" }, "example": { "body": "The updated document is now attached.", "attachments": [] } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/events": { "get": { "operationId": "get_events", "tags": [ "webhooks" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List integration events", "description": "Replay cursor, bounded type/resource filters. Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.", "x-required-grants": [ "events:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [ { "id": "evt_example", "type": "case.action_required", "schemaVersion": "1", "occurredAt": "2026-09-23T15:05:00Z", "resource": { "type": "case", "id": "case_example", "version": "17" }, "data": { "reason": "additional_information", "collectionRequestId": "cr_example" } } ], "nextCursor": "cursor_example", "hasMore": false } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/webhook-subscriptions": { "post": { "operationId": "post_webhook_subscriptions", "tags": [ "webhooks" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create a webhook subscription", "description": "Verified URL, allowed event types, permitted resource filters. Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.", "x-required-grants": [ "webhooks:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookInput" }, "example": { "url": "https://your-app.example/webhooks/wincora", "eventTypes": [ "case.action_required", "deliverable.available" ], "enabled": true } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "get_webhook_subscriptions", "tags": [ "webhooks" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List webhook subscriptions", "description": "Client-owned configuration/health. Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.", "x-required-grants": [ "webhooks:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/webhook-subscriptions/{id}": { "get": { "operationId": "get_webhook_subscriptions_id", "tags": [ "webhooks" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get webhook subscriptions", "description": "Client-owned configuration/health. Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.", "x-required-grants": [ "webhooks:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "patch": { "operationId": "patch_webhook_subscriptions_id", "tags": [ "webhooks" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Update webhook subscriptions", "description": "Allowed filter/URL/enablement changes + ETag; URL re-verification. Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.", "x-required-grants": [ "webhooks:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "delete": { "operationId": "delete_webhook_subscriptions_id", "tags": [ "webhooks" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Delete webhook subscriptions", "description": "Stop delivery and revoke subscription secret. Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.", "x-required-grants": [ "webhooks:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "204": { "description": "Deleted. No response body." }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/webhook-subscriptions/{id}/secret-rotations": { "post": { "operationId": "post_webhook_subscriptions_id_secret_rotations", "tags": [ "webhooks" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create secret rotations", "description": "Show new signing secret once; bounded overlap. Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.", "x-required-grants": [ "webhooks:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/webhook-subscriptions/{id}/deliveries": { "get": { "operationId": "get_webhook_subscriptions_id_deliveries", "tags": [ "webhooks" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List deliveries", "description": "Attempts, HTTP outcome, retry schedule; redacted bodies. Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.", "x-required-grants": [ "webhooks:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/webhook-subscriptions/{id}/deliveries/{deliveryId}/replays": { "post": { "operationId": "post_webhook_subscriptions_id_deliveries_deliveryId_replays", "tags": [ "webhooks" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create replays", "description": "New delivery attempt for still-authorized retained event. Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.", "x-required-grants": [ "webhooks:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/work-items": { "get": { "operationId": "get_work_items", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List work items", "description": "Current staff tasks, generation/version, allowed commands/outcomes. ", "x-required-grants": [ "operations:read" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/work-items/{id}": { "get": { "operationId": "get_work_items_id", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get work items", "description": "Current staff tasks, generation/version, allowed commands/outcomes. ", "x-required-grants": [ "operations:read" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/work-items/{id}/decisions": { "post": { "operationId": "post_work_items_id_decisions", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create decisions", "description": "Review/branch choice, reason/evidence, current version. ", "x-required-grants": [ "operations:write" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisionInput" }, "example": { "outcome": "approve", "reason": "All required evidence has been reviewed.", "actorReference": "agent-17" } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/work-items/{id}/completions": { "post": { "operationId": "post_work_items_id_completions", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create completions", "description": "Complete current manual task with required evidence. ", "x-required-grants": [ "operations:write" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/document-reviews": { "post": { "operationId": "post_cases_id_document_reviews", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create document reviews", "description": "Approve/reject specified evidence with review reason. ", "x-required-grants": [ "documents:review" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/collection-items/{itemId}/waivers": { "post": { "operationId": "post_cases_id_collection_items_itemId_waivers", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create waivers", "description": "Reasoned waiver with policy check. ", "x-required-grants": [ "fulfillment:control" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonInput" }, "example": { "reason": "The traveler’s plans have changed." } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/fulfillment/holds": { "post": { "operationId": "post_cases_id_fulfillment_holds", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create holds", "description": "Hold reason and current execution version. ", "x-required-grants": [ "fulfillment:control" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonInput" }, "example": { "reason": "The traveler’s plans have changed." } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/fulfillment/resumptions": { "post": { "operationId": "post_cases_id_fulfillment_resumptions", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create resumptions", "description": "Resume a permitted hold. ", "x-required-grants": [ "fulfillment:control" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/authority-submissions/{submissionId}/filing-records": { "post": { "operationId": "post_cases_id_authority_submissions_submissionId_filing_records", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create filing records", "description": "Authority receipt/reference/date and current work generation. ", "x-required-grants": [ "operations:write" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/authority-submissions/{submissionId}/supplements": { "post": { "operationId": "post_cases_id_authority_submissions_submissionId_supplements", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create supplements", "description": "Supplementation evidence/current generation. ", "x-required-grants": [ "operations:write" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/authority-submissions/{submissionId}/decisions": { "post": { "operationId": "post_cases_id_authority_submissions_submissionId_decisions", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create decisions", "description": "Authority decision and source evidence. ", "x-required-grants": [ "operations:write" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/appointments/{appointmentId}/scheduling-records": { "post": { "operationId": "post_cases_id_appointments_appointmentId_scheduling_records", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create scheduling records", "description": "Already obtained slot/venue/reference. ", "x-required-grants": [ "operations:write" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "appointmentId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/appointments/{appointmentId}/attendance-records": { "post": { "operationId": "post_cases_id_appointments_appointmentId_attendance_records", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create attendance records", "description": "Attendance/no-show evidence. ", "x-required-grants": [ "operations:write" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "appointmentId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/shipments/{id}/tracking-records": { "post": { "operationId": "post_shipments_id_tracking_records", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create tracking records", "description": "Allowed transition, carrier/tracking/date/evidence. ", "x-required-grants": [ "operations:write" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/physical-item-receipts": { "post": { "operationId": "post_cases_id_physical_item_receipts", "tags": [ "operations" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create physical item receipts", "description": "Custody receipt tied to a current check-in/handoff task. ", "x-required-grants": [ "operations:write" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/refunds/{id}/resolutions": { "post": { "operationId": "post_refunds_id_resolutions", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create resolutions", "description": "Authorized approval/rejection. ", "x-required-grants": [ "refunds:resolve" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/refunds/{id}/executions": { "post": { "operationId": "post_refunds_id_executions", "tags": [ "payments" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create executions", "description": "Provider refund initiation or separately authorized completion record. ", "x-required-grants": [ "refunds:resolve" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/reports/financial": { "get": { "operationId": "get_reports_financial", "tags": [ "reports" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List financial", "description": "Bounded period and permitted scope; versioned report resources. ", "x-required-grants": [ "reports:read" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/reports/operational": { "get": { "operationId": "get_reports_operational", "tags": [ "reports" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List operational", "description": "Bounded period and permitted scope; versioned report resources. ", "x-required-grants": [ "reports:read" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/cases/{id}/assistant-sessions": { "post": { "operationId": "post_cases_id_assistant_sessions", "tags": [ "assistant" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create assistant sessions", "description": "Scoped case assistance session. ", "x-required-grants": [ "assistant:use" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/assistant-sessions/{id}/messages": { "post": { "operationId": "post_assistant_sessions_id_messages", "tags": [ "assistant" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Create messages", "description": "Tenant-owned conversation UI, scoped tool actions. ", "x-required-grants": [ "assistant:use" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "get_assistant_sessions_id_messages", "tags": [ "assistant" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "List messages", "description": "Authorized history/resumption. ", "x-required-grants": [ "assistant:use" ], "x-required-scopes": [], "x-capability-tier": "extension", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases": { "get": { "operationId": "traveler_get_cases", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List cases", "description": "Stage, separate fulfillment/payment/delivery state, next actions and ETag within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}": { "get": { "operationId": "traveler_get_cases_id", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Get cases", "description": "Stage, separate fulfillment/payment/delivery state, next actions and ETag within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/requirements": { "get": { "operationId": "traveler_get_cases_id_requirements", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Get requirements", "description": "Frozen typed form/document schema + requirements version within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/data": { "get": { "operationId": "traveler_get_cases_id_data", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Get data", "description": "Permitted collected values and provenance + ETag within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "patch": { "operationId": "traveler_patch_cases_id_data", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Update case data", "description": "Versioned typed field/list changes + ETag within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:data:write" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataInput" }, "example": { "requirementsVersion": "rv_example", "changes": [ { "fieldId": "passport.expiryDate", "value": "2030-06-30" } ], "listChanges": [] } } } }, "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/readiness": { "get": { "operationId": "traveler_get_cases_id_readiness", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Check submission readiness", "description": "All submission blockers, canSubmit, next actions within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "caseId": "case_example", "canSubmit": false, "resubmissionRequired": false, "blockers": [ { "code": "document_missing", "requirementId": "passport.identityPage" } ], "nextActions": [ "uploadDocument" ] } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/submissions": { "post": { "operationId": "traveler_post_cases_id_submissions", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Submit a case", "description": "Explicit initial submit or resubmit intent + ETag within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints. This submits collected information to Wincora. It does not record filing with a government authority. Initial submission and RFE resubmission use different readiness rules.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:submit" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/collection-requests": { "get": { "operationId": "traveler_get_cases_id_collection_requests", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List collection requests", "description": "Public asks and items; resubmission requirement within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/collection-items/{itemId}/answers": { "post": { "operationId": "traveler_post_cases_id_collection_items_itemId_answers", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Create answers", "description": "Ad-hoc answer + case ETag within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:data:write" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerInput" }, "example": { "answer": "I will collect my passport in person." } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/cancellation-requests": { "post": { "operationId": "traveler_post_cases_id_cancellation_requests", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Create cancellation requests", "description": "Reason + ETag returns applied/tracked cancellation within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:cancel" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonInput" }, "example": { "reason": "The traveler’s plans have changed." } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/cancellation-requests/{requestId}": { "get": { "operationId": "traveler_get_cases_id_cancellation_requests_requestId", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Get cancellation requests", "description": "Status and financial follow-up within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/timeline": { "get": { "operationId": "traveler_get_cases_id_timeline", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List timeline", "description": "Customer-visible historical changes with pagination within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/appointments": { "get": { "operationId": "traveler_get_cases_id_appointments", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List appointments", "description": "Customer-safe appointment records/instructions within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/shipments": { "get": { "operationId": "traveler_get_cases_id_shipments", "tags": [ "traveler-cases" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List shipments", "description": "Permitted logistics records and tracking status within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/documents": { "post": { "operationId": "traveler_post_cases_id_documents", "tags": [ "traveler-documents" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Upload a case document", "description": "Multipart bytes + requirement ID returns 202 operation/document within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints. Processing success and document review are separate. A warning or pending review does not automatically mean rejection. Poll the operation returned in Location.", "x-required-grants": [], "x-required-scopes": [ "traveler:documents:write" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadInput" } } } }, "responses": { "202": { "description": "Accepted. Follow the durable operation in Location.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "operationId": "op_example", "documentId": "doc_example", "status": "queued" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "traveler_get_cases_id_documents", "tags": [ "traveler-documents" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List documents", "description": "Evidence/review/processing states within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:documents:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/documents/{id}": { "get": { "operationId": "traveler_get_documents_id", "tags": [ "traveler-documents" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Get documents", "description": "Authorized metadata, processing/review outcome and warnings within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:documents:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/documents/{id}/download-grants": { "post": { "operationId": "traveler_post_documents_id_download_grants", "tags": [ "traveler-documents" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Create download grants", "description": "Purpose returns short-lived authorized download within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints. Only authorized, released content can be downloaded. Grant URLs expire and must not be stored as permanent file locations.", "x-required-grants": [], "x-required-scopes": [ "traveler:documents:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/documents/{documentId}/replacement": { "post": { "operationId": "traveler_post_cases_id_documents_documentId_replacement", "tags": [ "traveler-documents" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Create replacement", "description": "Replacement bytes + ETag, preserve audit returns 202 within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints. Processing success and document review are separate. A warning or pending review does not automatically mean rejection. Poll the operation returned in Location.", "x-required-grants": [], "x-required-scopes": [ "traveler:documents:write" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadInput" } } } }, "responses": { "202": { "description": "Accepted. Follow the durable operation in Location.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/operations/{id}": { "get": { "operationId": "traveler_get_operations_id", "tags": [ "traveler-documents" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Get a processing operation", "description": "State, result reference, error and retry advice within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:documents:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "op_example", "status": "succeeded", "result": { "type": "document", "id": "doc_example" } } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/orders": { "get": { "operationId": "traveler_get_orders", "tags": [ "traveler-orders" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List orders", "description": "Scoped list/detail, case references and financial summary within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints. Order views omit other travelers and restricted fields. Financial details and checkout require a separate billing relationship; case access alone is insufficient.", "x-required-grants": [], "x-required-scopes": [ "traveler:orders:read" ], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/orders/{id}": { "get": { "operationId": "traveler_get_orders_id", "tags": [ "traveler-orders" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Get orders", "description": "Scoped list/detail, case references and financial summary within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints. Order views omit other travelers and restricted fields. Financial details and checkout require a separate billing relationship; case access alone is insufficient.", "x-required-grants": [], "x-required-scopes": [ "traveler:orders:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/orders/{id}/cases": { "get": { "operationId": "traveler_get_orders_id_cases", "tags": [ "traveler-orders" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List cases", "description": "Cases belonging to this authorized order within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints. Order views omit other travelers and restricted fields. Financial details and checkout require a separate billing relationship; case access alone is insufficient.", "x-required-grants": [], "x-required-scopes": [ "traveler:cases:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/orders/{id}/financials": { "get": { "operationId": "traveler_get_orders_id_financials", "tags": [ "traveler-orders" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Get financials", "description": "Invoices, outstanding balance, payment/credit/refund summaries per currency within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints. Order views omit other travelers and restricted fields. Financial details and checkout require a separate billing relationship; case access alone is insufficient.", "x-required-grants": [], "x-required-scopes": [ "traveler:billing:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/orders/{id}/checkout-sessions": { "post": { "operationId": "traveler_post_orders_id_checkout_sessions", "tags": [ "traveler-orders" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Create checkout sessions", "description": "Supported checkout mode, validated return target returns scoped checkout configuration within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints. Order views omit other travelers and restricted fields. Financial details and checkout require a separate billing relationship; case access alone is insufficient.", "x-required-grants": [], "x-required-scopes": [ "traveler:payments:checkout" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/messages": { "get": { "operationId": "traveler_get_cases_id_messages", "tags": [ "traveler-collaboration" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List messages", "description": "Customer-visible conversation, paginated within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:messages:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "post": { "operationId": "traveler_post_cases_id_messages", "tags": [ "traveler-collaboration" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Create messages", "description": "Public message with authorized attachment references within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:messages:write" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageInput" }, "example": { "body": "The updated document is now attached.", "attachments": [] } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/deliverables": { "get": { "operationId": "traveler_get_cases_id_deliverables", "tags": [ "traveler-collaboration" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List deliverables", "description": "Released files/inline values, type and availability within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:deliverables:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/deliverables/{deliverableId}/download-grants": { "post": { "operationId": "traveler_post_cases_id_deliverables_deliverableId_download_grants", "tags": [ "traveler-collaboration" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Create download grants", "description": "Authorized short-lived result download within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints. Only authorized, released content can be downloaded. Grant URLs expire and must not be stored as permanent file locations.", "x-required-grants": [], "x-required-scopes": [ "traveler:deliverables:read" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "deliverableId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/cases/{id}/assistant-sessions": { "post": { "operationId": "traveler_post_cases_id_assistant_sessions", "tags": [ "traveler-collaboration" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Create assistant sessions", "description": "Scoped case assistance session within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:assistant:use" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/assistant-sessions/{id}/messages": { "post": { "operationId": "traveler_post_assistant_sessions_id_messages", "tags": [ "traveler-collaboration" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Create messages", "description": "Tenant-owned conversation UI, scoped tool actions within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:assistant:use" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "traveler_get_assistant_sessions_id_messages", "tags": [ "traveler-collaboration" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "List messages", "description": "Authorized history/resumption within the signed-in identity’s authorized resources. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:assistant:use" ], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/customer-identities": { "post": { "operationId": "post_tenant_customer_identities", "tags": [ "identities" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Provision a customer identity", "description": "Provision a stable customer identity for tenant-owned or Wincora-managed authentication. Provisioning access is separate from issuing sessions. Requested resources must already lie within the integration’s administratively approved resource and delegation policy.", "x-required-grants": [ "identities:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityInput" }, "example": { "subject": "user_7821", "loginMode": "tenant" } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/customer-identities/{id}": { "get": { "operationId": "get_tenant_customer_identities_id", "tags": [ "identities" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Get a customer identity", "description": "Read an authorized customer identity and its login mode. Provisioning access is separate from issuing sessions. Requested resources must already lie within the integration’s administratively approved resource and delegation policy.", "x-required-grants": [ "identities:read" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/customer-identities/{id}/access": { "post": { "operationId": "post_tenant_customer_identities_id_access", "tags": [ "identities" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Grant resource access", "description": "Grant an identity explicitly scoped access to a traveler, case, or order. Provisioning access is separate from issuing sessions. Requested resources must already lie within the integration’s administratively approved resource and delegation policy.", "x-required-grants": [ "identities:access:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityAccessInput" }, "example": { "resource": { "type": "case", "id": "case_example" }, "scopes": [ "traveler:cases:read", "traveler:documents:write" ] } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/tenant/customer-identities/{id}/access/{accessId}": { "delete": { "operationId": "delete_tenant_customer_identities_id_access_accessId", "tags": [ "identities" ], "security": [ { "ApiKey": [] } ], "x-surface": "tenant", "x-auth-mode": "apiKey", "summary": "Revoke resource access", "description": "Revoke one identity resource relationship. Provisioning access is separate from issuing sessions. Requested resources must already lie within the integration’s administratively approved resource and delegation policy.", "x-required-grants": [ "identities:access:manage" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." }, { "name": "accessId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "204": { "description": "Deleted. No response body." }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/auth/customer-sessions": { "post": { "operationId": "post_auth_customer_sessions", "tags": [ "authentication" ], "security": [ { "ApiKey": [] } ], "x-surface": "authentication", "x-auth-mode": "apiKey", "summary": "Create a customer session", "description": "Issue a short-lived customer token for the authenticated tenant user. Derive subject from your authenticated server session. This endpoint cannot create identities or expand access. It requires customer-sessions:create and an explicit delegation policy. No renewal token is issued for tenant-owned login.", "x-required-grants": [ "customer-sessions:create" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSessionInput" }, "example": { "subject": "user_7821", "scopes": [ "traveler:profile:read", "traveler:cases:read", "traveler:documents:write" ] } } } }, "responses": { "201": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSessionResponse" }, "example": { "sessionId": "session_example", "accessToken": "CUSTOMER_ACCESS_TOKEN", "tokenType": "Bearer", "expiresIn": 300, "scopes": [ "traveler:profile:read", "traveler:cases:read" ] } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/auth/customer-sessions/{id}": { "delete": { "operationId": "delete_auth_customer_sessions_id", "tags": [ "authentication" ], "security": [ { "ApiKey": [] } ], "x-surface": "authentication", "x-auth-mode": "apiKey", "summary": "Revoke a customer session", "description": "Revoke a customer session issued by this integration. ", "x-required-grants": [ "customer-sessions:revoke" ], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "responses": { "204": { "description": "Deleted. No response body." }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/auth/challenges": { "post": { "operationId": "post_auth_challenges", "tags": [ "authentication" ], "security": [], "x-surface": "authentication", "x-auth-mode": "public", "summary": "Start a sign-in challenge", "description": "Start a passwordless sign-in challenge in a registered application. No API key is used. Application registration does not authenticate a person. Rate limits, proof-key binding, expiry, and single-use verification protect this flow. Return the same accepted response for known and unknown identities. Send a code only for an enrolled or invited managed identity. Email matching must not attach existing traveler records.", "x-required-grants": [], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChallengeInput" }, "example": { "applicationId": "app_example", "email": "alex@example.com", "codeChallenge": "BASE64URL_SHA256_OF_YOUR_VERIFIER", "codeChallengeMethod": "S256" } } } }, "responses": { "202": { "description": "Challenge accepted. Check the returned challenge ID and expiry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChallengeResponse" }, "example": { "challengeId": "challenge_example", "expiresIn": 600, "message": "If this identity is eligible, a sign-in code will be sent." } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/auth/challenges/{id}/verifications": { "post": { "operationId": "post_auth_challenges_id_verifications", "tags": [ "authentication" ], "security": [], "x-surface": "authentication", "x-auth-mode": "public", "summary": "Verify a sign-in challenge", "description": "Verify a one-time code and proof key to establish a customer session. No API key is used. Application registration does not authenticate a person. Rate limits, proof-key binding, expiry, and single-use verification protect this flow. Consume the challenge atomically. Bind the code and proof key to the same tenant, application, and identity. Establish only previously granted resource relationships.", "x-required-grants": [], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Opaque identifier in the authorized resource scope." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationInput" }, "example": { "applicationId": "app_example", "code": "123456", "codeVerifier": "YOUR_ORIGINAL_PROOF_KEY_VERIFIER" } } } }, "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSessionResponse" }, "example": { "sessionId": "session_example", "accessToken": "CUSTOMER_ACCESS_TOKEN", "tokenType": "Bearer", "expiresIn": 300, "scopes": [ "traveler:profile:read", "traveler:cases:read" ], "renewalToken": "SINGLE_USE_RENEWAL_TOKEN", "renewalExpiresIn": 28800 } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/auth/token-renewals": { "post": { "operationId": "post_auth_token_renewals", "tags": [ "authentication" ], "security": [], "x-surface": "authentication", "x-auth-mode": "renewalToken", "summary": "Renew a managed session", "description": "Rotate a managed customer session renewal token and issue a new access token. Managed sessions only. The renewal credential is presented in the request body, not in an Authorization header. Rotate once, revoke the family on reuse, and never log or persist tokens in browser storage.", "x-required-grants": [], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewalInput" }, "example": { "applicationId": "app_example", "renewalToken": "YOUR_SINGLE_USE_RENEWAL_TOKEN" } } } }, "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedSessionResponse" }, "example": { "sessionId": "session_example", "accessToken": "CUSTOMER_ACCESS_TOKEN", "tokenType": "Bearer", "expiresIn": 300, "scopes": [ "traveler:profile:read", "traveler:cases:read" ], "renewalToken": "REPLACEMENT_RENEWAL_TOKEN", "renewalExpiresIn": 28500 } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/me": { "get": { "operationId": "get_traveler_me", "tags": [ "traveler-session" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "Get the signed-in identity", "description": "Read the current identity, effective scopes, session expiry, and permitted traveler references. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [ "traveler:profile:read" ], "x-capability-tier": "core", "parameters": [], "responses": { "200": { "description": "Successful response. Returns the authorized resource or operation result.", "content": { "application/json": { "schema": { "type": "object" }, "example": { "identityId": "identity_example", "sessionId": "session_example", "scopes": [ "traveler:profile:read", "traveler:cases:read" ], "travelers": [ { "id": "trav_example" } ] } } } }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/traveler/session": { "delete": { "operationId": "delete_traveler_session", "tags": [ "traveler-session" ], "security": [ { "CustomerToken": [] } ], "x-surface": "traveler", "x-auth-mode": "customerToken", "summary": "End the current session", "description": "Sign out and revoke the current customer session and its renewal token family. Every resource is filtered by the signed-in identity’s current relationships. Customer-account membership alone grants no access. Tokens cannot call Tenant or Visa Intelligence endpoints.", "x-required-grants": [], "x-required-scopes": [], "x-capability-tier": "core", "parameters": [], "responses": { "204": { "description": "Deleted. No response body." }, "400": { "description": "Invalid input", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Invalid or missing credential", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Missing permission", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Resource not accessible", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Business or idempotency conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "Stale resource version", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "Precondition required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Dependency unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } } }, "components": { "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" }, "CustomerToken": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Wincora-issued customer token restricted to the Traveler API." } }, "schemas": { "IdentityInput": { "type": "object", "properties": { "subject": { "type": "string", "description": "Stable user ID in this integration. Never use an email address as the identity key." }, "loginMode": { "type": "string", "enum": [ "tenant", "managed" ] }, "email": { "type": "string", "description": "Invitation contact for managed sign-in. Verification alone does not grant resource access.", "format": "email" } }, "required": [ "subject", "loginMode" ], "additionalProperties": false }, "IdentityAccessInput": { "type": "object", "properties": { "resource": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "traveler", "case", "order" ] }, "id": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." } }, "required": [ "type", "id" ], "additionalProperties": false }, "scopes": { "type": "array", "items": { "type": "string", "description": "Allowed traveler scope, bounded by the integration delegation policy." } }, "customerId": { "type": "string", "description": "Required business context for a traveler relationship. For a case or order, the service derives it from the resource." }, "expiresAt": { "type": "string", "description": "Optional expiry of this access relationship.", "format": "date-time" } }, "required": [ "resource", "scopes" ], "additionalProperties": false }, "CustomerSessionInput": { "type": "object", "properties": { "subject": { "type": "string", "description": "Stable subject derived by your backend from its authenticated session." }, "scopes": { "type": "array", "items": { "type": "string", "description": "Requested traveler scope. Must be within the identity and integration delegation policy." } } }, "required": [ "subject", "scopes" ], "additionalProperties": false }, "ChallengeInput": { "type": "object", "properties": { "applicationId": { "type": "string", "description": "Public identifier for a registered tenant application. Not a secret." }, "email": { "type": "string", "description": "The enrolled or invited identity’s contact address.", "format": "email" }, "codeChallenge": { "type": "string", "description": "Base64url SHA-256 digest of a fresh random proof-key verifier." }, "codeChallengeMethod": { "type": "string", "enum": [ "S256" ] } }, "required": [ "applicationId", "email", "codeChallenge", "codeChallengeMethod" ], "additionalProperties": false }, "VerificationInput": { "type": "object", "properties": { "applicationId": { "type": "string", "description": "The same registered application that initiated the challenge." }, "code": { "type": "string", "description": "One-time code delivered to the enrolled identity." }, "codeVerifier": { "type": "string", "description": "Original secret proof-key verifier generated when starting this challenge." } }, "required": [ "applicationId", "code", "codeVerifier" ], "additionalProperties": false }, "RenewalInput": { "type": "object", "properties": { "applicationId": { "type": "string", "description": "Registered application bound to this managed session." }, "renewalToken": { "type": "string", "description": "Opaque single-use renewal token. Rotate atomically and replace it with the returned token." } }, "required": [ "applicationId", "renewalToken" ], "additionalProperties": false }, "DeterminationInput": { "type": "object", "properties": { "traveler": { "type": "object", "properties": { "passportCountry": { "type": "string", "description": "ISO 3166-1 alpha-2 passport country." }, "passportType": { "type": "string", "enum": [ "ordinary" ], "description": "Supports ordinary passports." }, "residenceCountry": { "type": "string", "description": "ISO country of residence." }, "heldAuthorizations": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Code from the held-authorization reference list." }, "issuingCountry": { "type": "string", "description": "ISO issuing country." }, "expiresOn": { "type": "string", "description": "Calendar date in YYYY-MM-DD format.", "format": "date" } }, "required": [ "code" ], "additionalProperties": false } } }, "required": [ "passportCountry", "passportType" ], "additionalProperties": false }, "legs": { "type": "array", "items": { "type": "object", "properties": { "reference": { "type": "string", "description": "Your identifier for this leg." }, "destinationCountry": { "type": "string", "description": "ISO destination country." }, "intent": { "type": "string", "description": "Confirmed intent code from the reference list." }, "arrivalDate": { "type": "string", "description": "Calendar date in YYYY-MM-DD format.", "format": "date" }, "departureDate": { "type": "string", "description": "Calendar date in YYYY-MM-DD format.", "format": "date" }, "transitContext": { "type": "string", "enum": [ "entry" ] } }, "required": [ "destinationCountry", "intent", "arrivalDate", "departureDate", "transitContext" ], "additionalProperties": false }, "description": "Exactly one entry leg per determination." } }, "required": [ "traveler", "legs" ], "additionalProperties": false }, "IntentInput": { "type": "object", "properties": { "passportCountry": { "type": "string", "description": "ISO passport country." }, "destinationCountry": { "type": "string", "description": "ISO destination country." }, "statement": { "type": "string", "description": "Trip purpose in plain language. Omit personal details." }, "priorFocus": { "type": "string", "description": "Clarification focus returned by a previous call." } }, "required": [ "passportCountry", "destinationCountry", "statement" ], "additionalProperties": false }, "QuoteInput": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "items": { "type": "array", "items": { "type": "object", "properties": { "travelerId": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "determinationId": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "productId": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "serviceLevel": { "type": "string", "description": "An available service level for the selected product." } }, "required": [ "travelerId", "determinationId", "productId", "serviceLevel" ], "additionalProperties": false } }, "travelStartDate": { "type": "string", "description": "Calendar date in YYYY-MM-DD format.", "format": "date" }, "travelEndDate": { "type": "string", "description": "Calendar date in YYYY-MM-DD format.", "format": "date" } }, "required": [ "customerId", "items", "travelStartDate", "travelEndDate" ], "additionalProperties": false }, "OrderInput": { "type": "object", "properties": { "quoteId": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "externalReference": { "type": "string", "description": "Your stable reference, unique to this integration and resource type." }, "tripName": { "type": "string", "description": "A display label for this trip. Does not change its travel intent." } }, "required": [ "quoteId" ], "additionalProperties": false }, "CustomerInput": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "personal", "corporate" ] }, "displayName": { "type": "string", "description": "Customer display name." }, "email": { "type": "string", "description": "Contact email address.", "format": "email" }, "externalReference": { "type": "string", "description": "Your stable reference, unique to this integration and resource type." } }, "required": [ "type", "displayName" ], "additionalProperties": false }, "TravelerInput": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "firstName": { "type": "string", "description": "Given name." }, "lastName": { "type": "string", "description": "Family name." }, "email": { "type": "string", "description": "Contact email address. Not a deduplication key.", "format": "email" }, "nationalityCountry": { "type": "string", "description": "ISO nationality country." }, "externalReference": { "type": "string", "description": "Your stable reference, unique to this integration and resource type." } }, "required": [ "customerId", "firstName", "lastName" ], "additionalProperties": false }, "DataInput": { "type": "object", "properties": { "requirementsVersion": { "type": "string", "description": "Version from this case’s frozen requirements." }, "changes": { "type": "array", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "Writable public field ID from the requirements schema." }, "value": { "description": "A typed value conforming to the field definition. Null clears a field only when allowed." } }, "required": [ "fieldId", "value" ], "additionalProperties": false } }, "listChanges": { "type": "array", "items": { "type": "object", "description": "An explicit add, update, or remove operation for a repeatable group. Item schema is provided by case requirements." } } }, "required": [ "requirementsVersion", "changes" ], "additionalProperties": false }, "AnswerInput": { "type": "object", "properties": { "answer": { "type": "string", "description": "The traveler’s answer to an ad-hoc question." } }, "required": [ "answer" ], "additionalProperties": false }, "ReasonInput": { "type": "object", "properties": { "reason": { "type": "string", "description": "A clear reason for this action, retained in the audit history." } }, "required": [ "reason" ], "additionalProperties": false }, "LinkInput": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "requirementId": { "type": "string", "description": "Document requirement on the target case." } }, "required": [ "documentId", "requirementId" ], "additionalProperties": false }, "UploadInput": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Document bytes. File limits are supplied by the enabled processing capability." }, "requirementId": { "type": "string", "description": "Case document requirement ID, when uploading to a case." }, "documentType": { "type": "string", "description": "Document type code, when uploading to a traveler vault." } }, "required": [ "file" ], "additionalProperties": false }, "MessageInput": { "type": "object", "properties": { "body": { "type": "string", "description": "Customer-visible message text." }, "attachments": { "type": "array", "items": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "description": "Previously authorized attachment references." } }, "required": [ "body" ], "additionalProperties": false }, "WebhookInput": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTPS receiver. Ownership verification is required.", "format": "uri" }, "eventTypes": { "type": "array", "items": { "type": "string", "description": "An enabled event type." } }, "enabled": { "type": "boolean", "description": "Whether the verified subscription should receive events." } }, "required": [ "url", "eventTypes" ], "additionalProperties": false }, "PaymentInput": { "type": "object", "properties": { "amount": { "type": "string", "description": "Decimal amount, never a floating-point total." }, "currency": { "type": "string", "description": "ISO currency matching the invoice." }, "method": { "type": "string", "description": "A supported external settlement method. Cannot be Stripe." }, "externalPaymentReference": { "type": "string", "description": "Stable reference used to deduplicate settlement." }, "settledAt": { "type": "string", "description": "Timestamp of the external settlement.", "format": "date-time" } }, "required": [ "amount", "currency", "method", "externalPaymentReference", "settledAt" ], "additionalProperties": false }, "DecisionInput": { "type": "object", "properties": { "outcome": { "type": "string", "description": "An allowed outcome on the current work item." }, "reason": { "type": "string", "description": "A clear reason for this action, retained in the audit history." }, "actorReference": { "type": "string", "description": "Your staff-user reference. Audit metadata, not an authorization grant." } }, "required": [ "outcome", "reason" ], "additionalProperties": false }, "CustomerSessionResponse": { "type": "object", "properties": { "sessionId": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "accessToken": { "type": "string", "description": "Short-lived Wincora customer access token." }, "tokenType": { "type": "string", "enum": [ "Bearer" ] }, "expiresIn": { "type": "integer", "description": "Remaining access-token lifetime in seconds." }, "scopes": { "type": "array", "items": { "type": "string", "description": "Effective traveler scope." } } }, "required": [ "sessionId", "accessToken", "tokenType", "expiresIn", "scopes" ], "additionalProperties": false }, "ManagedSessionResponse": { "type": "object", "properties": { "sessionId": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "accessToken": { "type": "string", "description": "Short-lived Wincora customer access token." }, "tokenType": { "type": "string", "enum": [ "Bearer" ] }, "expiresIn": { "type": "integer" }, "scopes": { "type": "array", "items": { "type": "string", "description": "Effective traveler scope." } }, "renewalToken": { "type": "string", "description": "Single-use replacement renewal credential." }, "renewalExpiresIn": { "type": "integer", "description": "Seconds remaining until the original absolute session expiry." } }, "required": [ "sessionId", "accessToken", "tokenType", "expiresIn", "scopes", "renewalToken", "renewalExpiresIn" ], "additionalProperties": false }, "ChallengeResponse": { "type": "object", "properties": { "challengeId": { "type": "string", "description": "Opaque resource identifier. Treat this value as a string." }, "expiresIn": { "type": "integer" }, "message": { "type": "string", "description": "The same neutral message for every submitted contact." } }, "required": [ "challengeId", "expiresIn", "message" ], "additionalProperties": false }, "Problem": { "type": "object", "properties": { "type": { "type": "string", "description": "Problem type URI.", "format": "uri" }, "title": { "type": "string", "description": "Short description." }, "status": { "type": "integer" }, "code": { "type": "string", "description": "Stable machine-readable problem code." }, "requestId": { "type": "string", "description": "Correlation identifier for support." } }, "required": [ "type", "title", "status", "code", "requestId" ], "additionalProperties": false } } } }