{ "openapi": "3.1.1", "info": { "title": "Scanverion API", "description": "OCR-first document processing and workspace operations for Scanverion.", "version": "v1" }, "servers": [ { "url": "http://api.scanverion.com/" } ], "paths": { "/api/v1/account": { "get": { "tags": [ "Account" ], "operationId": "Account_GetCurrentAccount", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountProfileResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountProfileResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountProfileResponse" } } } } }, "security": [ { "JwtAuth": [ ] } ] }, "put": { "tags": [ "Account" ], "operationId": "Account_UpdateCurrentAccount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountProfileResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountProfileResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountProfileResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "JwtAuth": [ ] } ] }, "delete": { "tags": [ "Account" ], "operationId": "Account_RequestAccountDeletion", "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } } } } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/account/email-change": { "post": { "tags": [ "Account" ], "operationId": "Account_RequestEmailChange", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EmailChangeRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EmailChangeResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EmailChangeResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailChangeResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/account/email-change/verification": { "post": { "tags": [ "Account" ], "operationId": "Account_VerifyEmailChange", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailChangeVerificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailChangeVerificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EmailChangeVerificationRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/ai/document-processing/previews": { "post": { "tags": [ "AiProcessing" ], "operationId": "AiProcessing_ProcessDocumentPreview", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "$ref": "#/components/schemas/IFormFile" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisOperation" } }, "DisableObjectSegmentation": { "type": "boolean" }, "ScannerFields": { "type": "array", "items": { "type": "string" } }, "CheckboxDefinitions": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" } } } }, "402": { "description": "Payment Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "502": { "description": "Bad Gateway" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/ai/document-processing": { "post": { "tags": [ "AiProcessing" ], "operationId": "AiProcessing_ProcessDocument", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "$ref": "#/components/schemas/IFormFile" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisOperation" } }, "DisableObjectSegmentation": { "type": "boolean" }, "ScannerFields": { "type": "array", "items": { "type": "string" } }, "CheckboxDefinitions": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" } } } }, "402": { "description": "Payment Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "502": { "description": "Bad Gateway" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/ai/vehicle-processing": { "post": { "tags": [ "AiProcessing" ], "operationId": "AiProcessing_ProcessVehicle", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "$ref": "#/components/schemas/IFormFile" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisOperation" } }, "DisableObjectSegmentation": { "type": "boolean" }, "ScannerFields": { "type": "array", "items": { "type": "string" } }, "CheckboxDefinitions": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" } } } }, "402": { "description": "Payment Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "502": { "description": "Bad Gateway" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/ai/document-processing/batches": { "post": { "tags": [ "AiProcessing" ], "operationId": "AiProcessing_ProcessDocumentBatch", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Files": { "type": "array", "items": { "$ref": "#/components/schemas/IFormFile" } }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisOperation" } }, "DisableObjectSegmentation": { "type": "boolean" }, "ScannerFields": { "type": "array", "items": { "type": "string" } }, "CheckboxDefinitions": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisBatchResponse" } } } }, "402": { "description": "Payment Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "502": { "description": "Bad Gateway" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/ai/vehicle-processing/batches": { "post": { "tags": [ "AiProcessing" ], "operationId": "AiProcessing_ProcessVehicleBatch", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Files": { "type": "array", "items": { "$ref": "#/components/schemas/IFormFile" } }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisOperation" } }, "DisableObjectSegmentation": { "type": "boolean" }, "ScannerFields": { "type": "array", "items": { "type": "string" } }, "CheckboxDefinitions": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RealtimeAnalysisBatchResponse" } } } }, "402": { "description": "Payment Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" }, "502": { "description": "Bad Gateway" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/ai/capabilities": { "get": { "tags": [ "AiProcessing" ], "operationId": "AiProcessing_GetCapabilities", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AiCapabilityResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AiCapabilityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AiCapabilityResponse" } } } } }, "503": { "description": "Service Unavailable" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/api-keys": { "get": { "tags": [ "ApiKeys" ], "operationId": "ApiKeys_GetKeys", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeysResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeysResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeysResponse" } } } } }, "security": [ { "JwtAuth": [ ] } ] }, "post": { "tags": [ "ApiKeys" ], "operationId": "ApiKeys_CreateKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreatedApiKeyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatedApiKeyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatedApiKeyResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/api-keys/{keyId}": { "get": { "tags": [ "ApiKeys" ], "operationId": "ApiKeys_GetKey", "parameters": [ { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "JwtAuth": [ ] } ] }, "put": { "tags": [ "ApiKeys" ], "operationId": "ApiKeys_UpdateKey", "parameters": [ { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/api-keys/{keyId}/revocation": { "post": { "tags": [ "ApiKeys" ], "operationId": "ApiKeys_RevokeKey", "parameters": [ { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/api-keys/{keyId}/rotations": { "post": { "tags": [ "ApiKeys" ], "operationId": "ApiKeys_RotateKey", "parameters": [ { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreatedApiKeyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatedApiKeyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatedApiKeyResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/api-keys/{keyId}/audit-events": { "get": { "tags": [ "ApiKeys" ], "operationId": "ApiKeys_GetAuditEvents", "parameters": [ { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeyAuditEventsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyAuditEventsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeyAuditEventsResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/auth/registrations": { "post": { "tags": [ "Auth" ], "operationId": "Auth_Register", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RegistrationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegistrationResponse" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } } } }, "/api/v1/auth/registrations/email-verifications": { "post": { "tags": [ "Auth" ], "operationId": "Auth_VerifyRegistrationEmail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationEmailVerificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegistrationEmailVerificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegistrationEmailVerificationRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } } } }, "/api/v1/auth/registrations/email-verification-requests": { "post": { "tags": [ "Auth" ], "operationId": "Auth_ResendRegistrationEmail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistrationEmailVerificationResendRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegistrationEmailVerificationResendRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegistrationEmailVerificationResendRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } } } } } } }, "/api/v1/auth/sessions": { "post": { "tags": [ "Auth" ], "operationId": "Auth_Login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentRequiredResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentRequiredResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentRequiredResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } } } }, "/api/v1/auth/mfa/enrollment": { "post": { "tags": [ "Auth" ], "operationId": "Auth_BeginMandatoryMfaEnrollment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentChallengeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentChallengeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentChallengeRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MandatoryMfaEnrollmentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MandatoryMfaEnrollmentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MandatoryMfaEnrollmentResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } } } }, "/api/v1/auth/mfa/enrollment/confirmation": { "post": { "tags": [ "Auth" ], "operationId": "Auth_CompleteMandatoryMfaEnrollment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentChallengeConfirmationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentChallengeConfirmationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentChallengeConfirmationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MandatoryMfaEnrollmentCompletionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MandatoryMfaEnrollmentCompletionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MandatoryMfaEnrollmentCompletionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } } } }, "/api/v1/auth/sessions/mfa": { "post": { "tags": [ "Auth" ], "operationId": "Auth_CompleteMfaLogin", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaLoginCompletionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MfaLoginCompletionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MfaLoginCompletionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } } } }, "/api/v1/auth/sessions/current": { "delete": { "tags": [ "Auth" ], "operationId": "Auth_Logout", "responses": { "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/auth/password-recovery/requests": { "post": { "tags": [ "Auth" ], "operationId": "Auth_RequestPasswordRecovery", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } } } } } } }, "/api/v1/auth/password-recovery/verifications": { "post": { "tags": [ "Auth" ], "operationId": "Auth_VerifyPasswordRecovery", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryVerificationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryVerificationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryVerificationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryVerificationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryVerificationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordRecoveryVerificationResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } } } }, "/api/v1/auth/password-recovery/resets": { "post": { "tags": [ "Auth" ], "operationId": "Auth_ResetPassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordResetRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasswordResetRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PasswordResetRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } } } }, "/api/v1/auth/external-logins/{provider}/authorization-url": { "get": { "tags": [ "Auth" ], "operationId": "Auth_GetExternalLoginAuthorizationUrl", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExternalLoginAuthorizationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginAuthorizationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginAuthorizationResponse" } } } }, "503": { "description": "Service Unavailable" } } } }, "/api/v1/auth/external-logins/callbacks": { "post": { "tags": [ "Auth" ], "operationId": "Auth_CompleteExternalLogin", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginCallbackRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginCallbackRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalLoginCallbackRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentRequiredResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentRequiredResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MfaEnrollmentRequiredResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } } } }, "/api/v1/billing/subscription-change-preview": { "post": { "tags": [ "Billing" ], "operationId": "Billing_PreviewSubscriptionChange", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionChangePreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscriptionChangePreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubscriptionChangePreviewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubscriptionChangePreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionChangePreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscriptionChangePreviewResponse" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/subscription-changes/current": { "delete": { "tags": [ "Billing" ], "operationId": "Billing_CancelScheduledChange", "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/subscription": { "get": { "tags": [ "Billing" ], "operationId": "Billing_GetSubscription", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CurrentBillingSubscriptionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CurrentBillingSubscriptionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CurrentBillingSubscriptionResponse" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/payment-methods": { "get": { "tags": [ "Billing" ], "operationId": "Billing_GetPaymentMethods", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentMethodsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodsResponse" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/payment-methods/default": { "put": { "tags": [ "Billing" ], "operationId": "Billing_SetDefaultPaymentMethod", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDefaultPaymentMethodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetDefaultPaymentMethodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetDefaultPaymentMethodRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentMethodsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodsResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/invoices": { "get": { "tags": [ "Billing" ], "operationId": "Billing_GetInvoices", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvoicesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoicesResponse" } } } }, "503": { "description": "Service Unavailable" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/invoices/{invoiceId}": { "get": { "tags": [ "Billing" ], "operationId": "Billing_GetInvoice", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/invoices/{invoiceId}/download": { "get": { "tags": [ "Billing" ], "operationId": "Billing_DownloadInvoice", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/invoices/generate": { "post": { "tags": [ "Billing" ], "operationId": "Billing_GenerateInvoice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateInvoiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenerateInvoiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateInvoiceRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/information": { "get": { "tags": [ "Billing" ], "operationId": "Billing_GetBillingInformation", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingInformationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingInformationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingInformationResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] }, "put": { "tags": [ "Billing" ], "operationId": "Billing_SaveBillingInformation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingInformationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingInformationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BillingInformationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingInformationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingInformationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingInformationResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/checkout-session": { "post": { "tags": [ "Billing" ], "operationId": "Billing_CreateCheckoutSession", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CheckoutSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CheckoutSessionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StripeSessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StripeSessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StripeSessionResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/subscription-purchases": { "post": { "tags": [ "Billing" ], "operationId": "Billing_PurchaseSubscription", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PurchaseSubscriptionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubscriptionPurchaseResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionPurchaseResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscriptionPurchaseResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/subscription-purchases/{attemptId}": { "get": { "tags": [ "Billing" ], "operationId": "Billing_GetPurchaseAttempt", "parameters": [ { "name": "attemptId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PurchaseAttemptResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseAttemptResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseAttemptResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/payment-methods/setup-session": { "post": { "tags": [ "Billing" ], "operationId": "Billing_CreatePaymentMethodSetupSession", "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StripeSetupIntentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StripeSetupIntentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StripeSetupIntentResponse" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/portal-session": { "post": { "tags": [ "Billing" ], "operationId": "Billing_CreatePortalSession", "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StripeSessionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StripeSessionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StripeSessionResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/billing/payment-methods/{paymentMethodId}": { "delete": { "tags": [ "Billing" ], "operationId": "Billing_RemovePaymentMethod", "parameters": [ { "name": "paymentMethodId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/health": { "get": { "tags": [ "Health" ], "operationId": "Health_Get", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HealthResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } } } } }, "/api/v1/account/mfa": { "get": { "tags": [ "Mfa" ], "operationId": "Mfa_GetStatus", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MfaStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MfaStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MfaStatus" } } } } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/catalog/capabilities": { "get": { "tags": [ "ProductCatalog" ], "operationId": "ProductCatalog_GetCapabilities", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CapabilityCatalogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CapabilityCatalogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CapabilityCatalogResponse" } } } }, "503": { "description": "Service Unavailable" } } } }, "/api/v1/catalog/capabilities/{capabilityKey}/usage": { "get": { "tags": [ "ProductCatalog" ], "operationId": "ProductCatalog_GetCapabilityUsage", "parameters": [ { "name": "capabilityKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CapabilityUsageDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CapabilityUsageDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CapabilityUsageDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } } } }, "/api/v1/public/plans": { "get": { "tags": [ "Public" ], "operationId": "Public_GetPlans", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicPlansResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublicPlansResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicPlansResponse" } } } } } } }, "/api/v1/public/cost-estimate": { "post": { "tags": [ "Public" ], "operationId": "Public_GetCostEstimate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCostEstimateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicCostEstimateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PublicCostEstimateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicCostEstimateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublicCostEstimateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicCostEstimateResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } } } }, "/api/v1/public/contact-requests": { "post": { "tags": [ "Public" ], "operationId": "Public_CreateContactRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContactRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContactRequestResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequestResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactRequestResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } } } }, "/api/v1/public/ai/document-processing-trial-policy": { "get": { "tags": [ "Public" ], "operationId": "Public_GetDocumentTrialPolicy", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AnonymousDocumentTrialPolicyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnonymousDocumentTrialPolicyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnonymousDocumentTrialPolicyResponse" } } } } } } }, "/api/v1/public/ai/document-processing-trials": { "post": { "tags": [ "Public" ], "operationId": "Public_ProcessDocumentTrial", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "$ref": "#/components/schemas/IFormFile" }, "BotVerificationToken": { "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AnonymousDocumentTrialResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AnonymousDocumentTrialResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AnonymousDocumentTrialResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } } } }, "/api/v1/webhooks/stripe": { "post": { "tags": [ "StripeWebhook" ], "operationId": "StripeWebhook_Receive", "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OperationAcceptedResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } } } }, "/api/v1/subscriptions/current": { "get": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_GetCurrentSubscription", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CurrentSubscriptionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CurrentSubscriptionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CurrentSubscriptionResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/subscriptions/plans": { "get": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_GetPlans", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlansResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlansResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlansResponse" } } } }, "503": { "description": "Service Unavailable" } } } }, "/api/v1/subscriptions/plan-selections": { "post": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_SelectPlan", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SelectPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SelectPlanRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlanSelectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlanSelectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanSelectionResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/subscriptions/current/budget-limit": { "put": { "tags": [ "Subscriptions" ], "operationId": "Subscriptions_UpdateBudgetLimit", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBudgetLimitRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBudgetLimitRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBudgetLimitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CurrentSubscriptionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CurrentSubscriptionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CurrentSubscriptionResponse" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/tax/vat-validation": { "post": { "tags": [ "Tax" ], "operationId": "Tax_ValidateVat", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViesVatValidationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViesVatValidationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ViesVatValidationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ViesVatValidationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ViesVatValidationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ViesVatValidationResult" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/tax/readiness": { "get": { "tags": [ "Tax" ], "operationId": "Tax_GetReadiness", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaxActivationGateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxActivationGateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxActivationGateResult" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/tax/quotes": { "post": { "tags": [ "Tax" ], "operationId": "Tax_CreateQuote", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaxQuote" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxQuote" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxQuote" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationResult" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/tax/billing-preview": { "get": { "tags": [ "Tax" ], "operationId": "Tax_GetBillingPreview", "parameters": [ { "name": "planKey", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationResult" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxQuoteCreationResult" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/tax/invoices/finalize": { "post": { "tags": [ "Tax" ], "operationId": "Tax_FinalizeInvoice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxInvoiceFinalizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxInvoiceFinalizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TaxInvoiceFinalizationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaxInvoiceFinalizationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxInvoiceFinalizationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxInvoiceFinalizationResult" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TaxInvoiceFinalizationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxInvoiceFinalizationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaxInvoiceFinalizationResult" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/usage/summary": { "get": { "tags": [ "Usage" ], "operationId": "Usage_GetSummary", "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UsageSummaryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UsageSummaryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsageSummaryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/usage/daily": { "get": { "tags": [ "Usage" ], "operationId": "Usage_GetDailyUsage", "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DailyUsageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DailyUsageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DailyUsageResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/usage/by-capability": { "get": { "tags": [ "Usage" ], "operationId": "Usage_GetUsageByCapability", "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CapabilityUsageResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CapabilityUsageResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CapabilityUsageResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/usage/price-preview": { "get": { "tags": [ "Usage" ], "operationId": "Usage_GetPricePreview", "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UsagePricePreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UsagePricePreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsagePricePreviewResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "503": { "description": "Service Unavailable" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/validation/id-cards/lost-or-stolen": { "post": { "tags": [ "Validation" ], "operationId": "Validation_CheckLostOrStolenCard", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LostOrStolenCardCheckRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LostOrStolenCardCheckRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LostOrStolenCardCheckRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LostOrStolenCardResultResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LostOrStolenCardResultResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LostOrStolenCardResultResponse" } } } } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/validation/postal-codes": { "get": { "tags": [ "Validation" ], "operationId": "Validation_FindPostalCode", "parameters": [ { "name": "Address", "in": "query", "schema": { "type": "string" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PostalCodeLookupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostalCodeLookupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostalCodeLookupResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScanverionProblemDetails" } } } }, "502": { "description": "Bad Gateway" } }, "security": [ { "ApiKeyAuth": [ ] }, { "JwtAuth": [ ] } ] } }, "/api/v1/workspace/members": { "get": { "tags": [ "WorkspaceMembers" ], "operationId": "WorkspaceMembers_GetMembers", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkspaceMembersResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMembersResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMembersResponse" } } } } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/workspace/members/invitations": { "get": { "tags": [ "WorkspaceMembers" ], "operationId": "WorkspaceMembers_GetInvitations", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkspaceInvitationsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceInvitationsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceInvitationsResponse" } } } } }, "security": [ { "JwtAuth": [ ] } ] }, "post": { "tags": [ "WorkspaceMembers" ], "operationId": "WorkspaceMembers_InviteMember", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteWorkspaceMemberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InviteWorkspaceMemberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InviteWorkspaceMemberRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkspaceInvitationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceInvitationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceInvitationResponse" } } } } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/workspace/members/{memberId}": { "put": { "tags": [ "WorkspaceMembers" ], "operationId": "WorkspaceMembers_UpdateMember", "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceMemberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceMemberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceMemberRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } } } } }, "security": [ { "JwtAuth": [ ] } ] }, "delete": { "tags": [ "WorkspaceMembers" ], "operationId": "WorkspaceMembers_RemoveMember", "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "JwtAuth": [ ] } ] } }, "/api/v1/workspace/members/{memberId}/suspension": { "post": { "tags": [ "WorkspaceMembers" ], "operationId": "WorkspaceMembers_SuspendMember", "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } } } } }, "security": [ { "JwtAuth": [ ] } ] }, "delete": { "tags": [ "WorkspaceMembers" ], "operationId": "WorkspaceMembers_ReactivateMember", "parameters": [ { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } } } } }, "security": [ { "JwtAuth": [ ] } ] } } }, "components": { "schemas": { "AccountProfileResponse": { "required": [ "userId", "email", "firstName", "surname", "language", "workspaceId", "workspaceName", "role" ], "type": "object", "properties": { "userId": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": [ "null", "string" ] }, "surname": { "type": [ "null", "string" ] }, "language": { "type": "string" }, "workspaceId": { "type": "string" }, "workspaceName": { "type": "string" }, "role": { "type": "string" } } }, "AiCapabilityResponse": { "required": [ "key", "name", "model", "supportedOperations", "supportedInputMimeTypes", "maximumFileSizeBytes" ], "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "model": { "$ref": "#/components/schemas/AiModel" }, "supportedOperations": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisOperation" } }, "supportedInputMimeTypes": { "type": "array", "items": { "type": "string" } }, "maximumFileSizeBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "AiModel": { "type": "integer" }, "AnalysisOperation": { "type": "integer" }, "AnonymousDocumentTrialPolicyResponse": { "required": [ "dailyRequestLimit", "maximumFileSizeBytes", "supportedInputMimeTypes", "includedOperations", "botVerificationProvider" ], "type": "object", "properties": { "dailyRequestLimit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximumFileSizeBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "supportedInputMimeTypes": { "type": "array", "items": { "type": "string" } }, "includedOperations": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisOperation" } }, "botVerificationProvider": { "type": "string" } } }, "AnonymousDocumentTrialResponse": { "required": [ "analysis", "quota" ], "type": "object", "properties": { "analysis": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" }, "quota": { "$ref": "#/components/schemas/AnonymousTrialQuotaResponse" } } }, "AnonymousTrialQuotaResponse": { "required": [ "limit", "remaining", "resetsAt" ], "type": "object", "properties": { "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "remaining": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "resetsAt": { "type": "string", "format": "date-time" } } }, "ApiKeyAuditEventResponse": { "required": [ "occurredAt", "type", "description", "ipAddress" ], "type": "object", "properties": { "occurredAt": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "description": { "type": "string" }, "ipAddress": { "type": [ "null", "string" ] } } }, "ApiKeyAuditEventsResponse": { "required": [ "events" ], "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyAuditEventResponse" } } } }, "ApiKeyResponse": { "required": [ "keyId", "name", "keyPrefix", "scopes", "status", "createdAt", "lastUsedAt", "expiresAt", "requestsLast30Days" ], "type": "object", "properties": { "keyId": { "type": "string" }, "name": { "type": "string" }, "keyPrefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUsedAt": { "type": [ "null", "string" ], "format": "date-time" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "requestsLast30Days": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "ApiKeysResponse": { "required": [ "keys" ], "type": "object", "properties": { "keys": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyResponse" } } } }, "BarcodeResultResponse": { "required": [ "format", "value", "bounds" ], "type": "object", "properties": { "format": { "type": "string" }, "value": { "type": "string" }, "bounds": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BoundingBoxResponse" } ] } } }, "BillingEngineVersion": { "type": "integer" }, "BillingInformationRequest": { "required": [ "firstName", "title", "surname", "billingEmail", "billingAddress", "city", "postalCode", "country", "isCompany", "companyName", "companyRegistrationNumber", "taxIdentificationNumber", "vatId" ], "type": "object", "properties": { "firstName": { "type": "string" }, "title": { "type": "string" }, "surname": { "type": "string" }, "billingEmail": { "type": "string" }, "billingAddress": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "isCompany": { "type": "boolean" }, "companyName": { "type": [ "null", "string" ] }, "companyRegistrationNumber": { "type": [ "null", "string" ] }, "taxIdentificationNumber": { "type": [ "null", "string" ] }, "vatId": { "type": [ "null", "string" ] } } }, "BillingInformationResponse": { "required": [ "firstName", "title", "surname", "billingEmail", "billingAddress", "city", "postalCode", "country", "isCompany", "companyName", "companyRegistrationNumber", "taxIdentificationNumber", "vatId", "vatValidationStatus" ], "type": "object", "properties": { "firstName": { "type": "string" }, "title": { "type": "string" }, "surname": { "type": "string" }, "billingEmail": { "type": "string" }, "billingAddress": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "isCompany": { "type": "boolean" }, "companyName": { "type": [ "null", "string" ] }, "companyRegistrationNumber": { "type": [ "null", "string" ] }, "taxIdentificationNumber": { "type": [ "null", "string" ] }, "vatId": { "type": [ "null", "string" ] }, "vatValidationStatus": { "type": [ "null", "string" ] } } }, "BlurResultResponse": { "required": [ "isBlurred" ], "type": "object", "properties": { "isBlurred": { "type": "boolean" } } }, "BoundingBoxResponse": { "required": [ "left", "top", "right", "bottom" ], "type": "object", "properties": { "left": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "top": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "right": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "bottom": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "CapabilityCatalogItemResponse": { "required": [ "key", "name", "description", "route", "method", "isEnabled", "creditMultiplier" ], "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "route": { "type": "string" }, "method": { "type": "string" }, "isEnabled": { "type": "boolean" }, "creditMultiplier": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "CapabilityCatalogResponse": { "required": [ "capabilities" ], "type": "object", "properties": { "capabilities": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityCatalogItemResponse" } } } }, "CapabilityUsageDetailResponse": { "required": [ "capabilityKey", "from", "to", "calls", "credits" ], "type": "object", "properties": { "capabilityKey": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "calls": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "credits": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "CapabilityUsageItemResponse": { "required": [ "capabilityKey", "label", "calls", "units", "estimatedCostEur" ], "type": "object", "properties": { "capabilityKey": { "type": "string" }, "label": { "type": "string" }, "calls": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "units": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "estimatedCostEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "CapabilityUsageResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CapabilityUsageItemResponse" } } } }, "ChargeType": { "type": "integer" }, "CheckboxResultResponse": { "required": [ "id", "isChecked", "confidence" ], "type": "object", "properties": { "id": { "type": "string" }, "isChecked": { "type": [ "null", "boolean" ] }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "CheckoutSessionRequest": { "required": [ "priceKey" ], "type": "object", "properties": { "priceKey": { "type": "string" } } }, "ContactRequest": { "required": [ "name", "email", "inquiryType", "message" ], "type": "object", "properties": { "name": { "maxLength": 120, "minLength": 2, "type": "string" }, "email": { "maxLength": 240, "minLength": 0, "type": "string" }, "company": { "maxLength": 160, "minLength": 0, "type": "string" }, "inquiryType": { "maxLength": 80, "minLength": 0, "type": "string" }, "monthlyVolume": { "maxLength": 80, "minLength": 0, "type": "string" }, "message": { "maxLength": 4000, "minLength": 20, "type": "string" }, "website": { "type": "string" } } }, "ContactRequestResponse": { "required": [ "contactRequestId", "status" ], "type": "object", "properties": { "contactRequestId": { "type": "string" }, "status": { "type": "string" } } }, "CreateApiKeyRequest": { "required": [ "name", "scopes", "expiresAt" ], "type": "object", "properties": { "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "CreatedApiKeyResponse": { "required": [ "key", "secret" ], "type": "object", "properties": { "key": { "$ref": "#/components/schemas/ApiKeyResponse" }, "secret": { "type": "string" } } }, "CurrentBillingSubscriptionResponse": { "required": [ "subscriptionId", "status", "planKey", "currentPeriodEnd" ], "type": "object", "properties": { "subscriptionId": { "type": "string" }, "status": { "type": "string" }, "planKey": { "type": "string" }, "currentPeriodEnd": { "type": [ "null", "string" ], "format": "date" } } }, "CurrentSubscriptionResponse": { "required": [ "subscriptionId", "planKey", "planName", "status", "includedCredits", "usedCredits", "overageUnitPrice", "monthlyBudgetLimitEur", "currentPeriodStart", "currentPeriodEnd", "includedCreditsUsed", "includedCreditsRemaining", "overageCreditsUsed", "overageAccruedEur", "overageInvoicedEur", "overagePaidEur", "maximumOverageBudgetEur", "remainingOverageAuthorizationEur", "paymentStatus", "overageEnabled", "pendingPlanKey", "pendingPlanEffectiveOn", "nextBillingAmountEur" ], "type": "object", "properties": { "subscriptionId": { "type": "string" }, "planKey": { "type": "string" }, "planName": { "type": "string" }, "status": { "type": "string" }, "includedCredits": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "usedCredits": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overageUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "monthlyBudgetLimitEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "currentPeriodStart": { "type": [ "null", "string" ], "format": "date" }, "currentPeriodEnd": { "type": [ "null", "string" ], "format": "date" }, "includedCreditsUsed": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "includedCreditsRemaining": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overageCreditsUsed": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overageAccruedEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overageInvoicedEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overagePaidEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "maximumOverageBudgetEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "remainingOverageAuthorizationEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "paymentStatus": { "type": "string" }, "overageEnabled": { "type": "boolean" }, "pendingPlanKey": { "type": [ "null", "string" ] }, "pendingPlanEffectiveOn": { "type": [ "null", "string" ], "format": "date" }, "nextBillingAmountEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "priceTaxBehavior": { "type": "string", "default": "Legacy" } } }, "DailyUsagePointResponse": { "required": [ "date", "calls" ], "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "calls": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "DailyUsageResponse": { "required": [ "points" ], "type": "object", "properties": { "points": { "type": "array", "items": { "$ref": "#/components/schemas/DailyUsagePointResponse" } } } }, "DetectedLanguageResponse": { "required": [ "code", "confidence" ], "type": "object", "properties": { "code": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "DetectedObjectResponse": { "required": [ "objectId", "category", "confidence", "bounds", "results" ], "type": "object", "properties": { "objectId": { "type": "string" }, "category": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "bounds": { "$ref": "#/components/schemas/BoundingBoxResponse" }, "results": { "$ref": "#/components/schemas/ObjectProcessingResultsResponse" }, "pageNumber": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } } }, "DetectedWritingSystemResponse": { "required": [ "code", "name", "confidence" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "EmailChangeRequest": { "required": [ "newEmail", "password", "mfaCode" ], "type": "object", "properties": { "newEmail": { "type": "string" }, "password": { "type": [ "null", "string" ] }, "mfaCode": { "type": [ "null", "string" ] } } }, "EmailChangeResponse": { "required": [ "status", "expiresAt" ], "type": "object", "properties": { "status": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "EmailChangeVerificationRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } } }, "ExternalLoginAuthorizationResponse": { "required": [ "authorizationUrl" ], "type": "object", "properties": { "authorizationUrl": { "type": "string" } } }, "ExternalLoginCallbackRequest": { "required": [ "provider", "authorizationCode", "redirectUri", "state" ], "type": "object", "properties": { "provider": { "type": "string" }, "authorizationCode": { "type": "string" }, "redirectUri": { "type": "string" }, "state": { "type": "string" } } }, "FaceResultResponse": { "required": [ "bounds", "landmarks", "extractedImageBase64" ], "type": "object", "properties": { "bounds": { "$ref": "#/components/schemas/BoundingBoxResponse" }, "landmarks": { "type": "object", "additionalProperties": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } }, "extractedImageBase64": { "type": [ "null", "string" ] } } }, "GenerateInvoiceRequest": { "required": [ "periodStart", "periodEnd" ], "type": "object", "properties": { "periodStart": { "type": "string", "format": "date" }, "periodEnd": { "type": "string", "format": "date" } } }, "HealthResponse": { "required": [ "status", "service" ], "type": "object", "properties": { "status": { "type": "string" }, "service": { "type": "string" } } }, "IFormFile": { "type": "string", "format": "binary" }, "InviteWorkspaceMemberRequest": { "required": [ "email", "role", "team" ], "type": "object", "properties": { "email": { "type": "string" }, "role": { "type": "string" }, "team": { "type": [ "null", "string" ] } } }, "Invoice": { "required": [ "currency" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "supplierLegalEntityId": { "type": "string", "format": "uuid" }, "documentSeriesId": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/InvoiceStatus" }, "finalizationIdempotencyKey": { "type": "string" }, "currency": { "type": "string" }, "invoiceIssuedAt": { "type": [ "null", "string" ], "format": "date-time" }, "taxPointDate": { "type": [ "null", "string" ], "format": "date" }, "paymentReceivedAt": { "type": [ "null", "string" ], "format": "date-time" }, "servicePeriodStart": { "type": "string", "format": "date-time" }, "servicePeriodEnd": { "type": "string", "format": "date-time" }, "taxPointRuleCode": { "type": [ "null", "string" ] }, "taxPointRuleVersion": { "type": [ "null", "string" ] }, "netTotalMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "vatTotalMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "grossTotalMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "primaryTaxDecisionId": { "type": [ "null", "string" ], "format": "uuid" }, "supplierSnapshotId": { "type": "string", "format": "uuid" }, "customerBillingSnapshotId": { "type": "string", "format": "uuid" }, "billingEngineVersion": { "$ref": "#/components/schemas/BillingEngineVersion" }, "createdAt": { "type": "string", "format": "date-time" }, "finalizedAt": { "type": [ "null", "string" ], "format": "date-time" }, "lines": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceLine" } }, "taxSummaries": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/InvoiceTaxSummary" } }, "payments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PaymentAllocation" } } } }, "InvoiceLine": { "required": [ "lineType", "description", "taxPointRuleCode", "taxPointRuleVersion", "currency", "legalTextVersion" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "format": "uuid" }, "lineType": { "type": "string" }, "description": { "type": "string" }, "originalPlanKey": { "type": [ "null", "string" ] }, "newPlanKey": { "type": [ "null", "string" ] }, "servicePeriodStart": { "type": "string", "format": "date-time" }, "servicePeriodEnd": { "type": "string", "format": "date-time" }, "taxPointDate": { "type": "string", "format": "date" }, "taxPointRuleCode": { "type": "string" }, "taxPointRuleVersion": { "type": "string" }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unroundedNetAmount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "netAmountMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "vatAmountMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "grossAmountMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "currency": { "type": "string" }, "taxDecisionSnapshotId": { "type": "string", "format": "uuid" }, "taxCategoryVersionId": { "type": "string", "format": "uuid" }, "taxJurisdictionId": { "type": "string", "format": "uuid" }, "taxSchemeId": { "type": "string", "format": "uuid" }, "taxReportingSchemeId": { "type": "string", "format": "uuid" }, "taxTreatment": { "$ref": "#/components/schemas/TaxTreatmentCode" }, "vatRateBasisPoints": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "legalTextVersion": { "type": "string" } } }, "InvoiceResponse": { "required": [ "invoiceId", "issuedOn", "dueOn", "status", "amount", "currency", "downloadUrl" ], "type": "object", "properties": { "invoiceId": { "type": "string" }, "issuedOn": { "type": "string", "format": "date" }, "dueOn": { "type": [ "null", "string" ], "format": "date" }, "status": { "type": "string" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currency": { "type": "string" }, "downloadUrl": { "type": "string" }, "invoiceNumber": { "type": [ "null", "string" ] } } }, "InvoicesResponse": { "required": [ "invoices" ], "type": "object", "properties": { "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceResponse" } } } }, "InvoiceStatus": { "type": "integer" }, "InvoiceTaxSummary": { "required": [ "currency" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "format": "uuid" }, "taxJurisdictionId": { "type": "string", "format": "uuid" }, "taxSchemeId": { "type": "string", "format": "uuid" }, "taxTreatment": { "$ref": "#/components/schemas/TaxTreatmentCode" }, "vatRateBasisPoints": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "currency": { "type": "string" }, "netAmountMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "vatAmountMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "grossAmountMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "IssuingCountryResponse": { "required": [ "alpha2", "alpha3", "name", "confidence", "source" ], "type": "object", "properties": { "alpha2": { "type": "string" }, "alpha3": { "type": "string" }, "name": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "source": { "type": "string" } } }, "LoginRequest": { "required": [ "email", "password", "rememberDevice" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "rememberDevice": { "type": "boolean" } } }, "LostOrStolenCardCheckRequest": { "required": [ "cardNumber", "cardType" ], "type": "object", "properties": { "cardNumber": { "type": "string" }, "cardType": { "type": "string" } } }, "LostOrStolenCardResultResponse": { "required": [ "isLostOrStolen", "cardType" ], "type": "object", "properties": { "isLostOrStolen": { "type": "boolean" }, "cardType": { "type": "string" } } }, "MandatoryMfaEnrollmentCompletionResponse": { "required": [ "session", "recoveryCodes" ], "type": "object", "properties": { "session": { "$ref": "#/components/schemas/SessionResponse" }, "recoveryCodes": { "type": "array", "items": { "type": "string" } } } }, "MandatoryMfaEnrollmentResponse": { "required": [ "sharedKey", "authenticatorUri" ], "type": "object", "properties": { "sharedKey": { "type": "string" }, "authenticatorUri": { "type": "string" } } }, "MfaEnrollmentChallengeConfirmationRequest": { "required": [ "challengeToken", "code" ], "type": "object", "properties": { "challengeToken": { "type": "string" }, "code": { "type": "string" } } }, "MfaEnrollmentChallengeRequest": { "required": [ "challengeToken" ], "type": "object", "properties": { "challengeToken": { "type": "string" } } }, "MfaEnrollmentRequiredResponse": { "required": [ "status", "challengeToken", "expiresAt" ], "type": "object", "properties": { "status": { "type": "string" }, "challengeToken": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "MfaLoginCompletionRequest": { "required": [ "challengeToken", "code" ], "type": "object", "properties": { "challengeToken": { "type": "string" }, "code": { "type": "string" } } }, "MfaStatus": { "required": [ "enabled", "enabledAt" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "enabledAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "ObjectProcessingResultsResponse": { "required": [ "scanner", "rotation", "blur", "faces", "barcodes", "checkboxes", "signature", "lostOrStolenCard" ], "type": "object", "properties": { "scanner": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ScannerResultResponse" } ] }, "rotation": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RotationResultResponse" } ] }, "blur": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BlurResultResponse" } ] }, "faces": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FaceResultResponse" } }, "barcodes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BarcodeResultResponse" } }, "checkboxes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CheckboxResultResponse" } }, "signature": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SignatureResultResponse" } ] }, "lostOrStolenCard": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LostOrStolenCardResultResponse" } ] } } }, "OperationAcceptedResponse": { "required": [ "id", "status" ], "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" } } }, "OperationStatus": { "type": "integer" }, "OperationSummaryResponse": { "required": [ "operation", "status", "message" ], "type": "object", "properties": { "operation": { "$ref": "#/components/schemas/AnalysisOperation" }, "status": { "$ref": "#/components/schemas/OperationStatus" }, "message": { "type": [ "null", "string" ] } } }, "PasswordRecoveryRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "PasswordRecoveryVerificationRequest": { "required": [ "email", "code" ], "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "string" } } }, "PasswordRecoveryVerificationResponse": { "required": [ "recoveryToken", "expiresAt" ], "type": "object", "properties": { "recoveryToken": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "PasswordResetRequest": { "required": [ "email", "code", "newPassword" ], "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "string" }, "newPassword": { "type": "string" } } }, "PaymentAllocation": { "required": [ "provider", "providerPaymentId", "currency" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "format": "uuid" }, "provider": { "type": "string" }, "providerPaymentId": { "type": "string" }, "amountMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "currency": { "type": "string" }, "succeededAt": { "type": [ "null", "string" ], "format": "date-time" }, "refundedAmountMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "chargebackAmountMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "PaymentMethodResponse": { "required": [ "paymentMethodId", "type", "brand", "accountEmail", "lastFour", "expiryMonth", "expiryYear", "isDefault" ], "type": "object", "properties": { "paymentMethodId": { "type": "string" }, "type": { "type": "string" }, "brand": { "type": "string" }, "accountEmail": { "type": [ "null", "string" ] }, "lastFour": { "type": [ "null", "string" ] }, "expiryMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "expiryYear": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "isDefault": { "type": "boolean" }, "isAuthorizedForOverage": { "type": "boolean", "default": false } } }, "PaymentMethodsResponse": { "required": [ "paymentMethods" ], "type": "object", "properties": { "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodResponse" } } } }, "PersonNameResponse": { "required": [ "displayName", "titleBefore", "firstName", "middleName", "lastName", "titleAfter", "givenNames", "surnameParts", "original", "latin", "source", "componentsDerived" ], "type": "object", "properties": { "displayName": { "type": [ "null", "string" ] }, "titleBefore": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "middleName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "titleAfter": { "type": [ "null", "string" ] }, "givenNames": { "type": "array", "items": { "type": "string" } }, "surnameParts": { "type": "array", "items": { "type": "string" } }, "original": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PersonNameVariantResponse" } ] }, "latin": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PersonNameVariantResponse" } ] }, "source": { "type": "string" }, "componentsDerived": { "type": "boolean" } } }, "PersonNameVariantResponse": { "required": [ "displayName", "firstName", "middleName", "lastName", "givenNames", "surnameParts" ], "type": "object", "properties": { "displayName": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "middleName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "givenNames": { "type": "array", "items": { "type": "string" } }, "surnameParts": { "type": "array", "items": { "type": "string" } } } }, "PlanResponse": { "required": [ "key", "name", "includedCredits", "monthlyPriceEur", "overageUnitPrice", "maximumOverageBudgetEur", "overageChargeThresholdEur", "currency", "isPublic", "netMonthlyPriceEur", "vatAmountEur", "vatRatePercent", "priceIncludesVat" ], "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "includedCredits": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "monthlyPriceEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overageUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "maximumOverageBudgetEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overageChargeThresholdEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "currency": { "type": "string" }, "isPublic": { "type": "boolean" }, "netMonthlyPriceEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatAmountEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatRatePercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "priceIncludesVat": { "type": "boolean" }, "priceTaxBehavior": { "type": "string", "default": "Legacy" }, "netOverageUnitPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "PlanSelectionResponse": { "required": [ "selectionId", "status", "checkoutUrl" ], "type": "object", "properties": { "selectionId": { "type": "string" }, "status": { "type": "string" }, "checkoutUrl": { "type": [ "null", "string" ] } } }, "PlansResponse": { "required": [ "plans" ], "type": "object", "properties": { "plans": { "type": "array", "items": { "$ref": "#/components/schemas/PlanResponse" } } } }, "PostalCodeLookupResponse": { "required": [ "postalCode", "city", "countryCode" ], "type": "object", "properties": { "postalCode": { "type": "string" }, "city": { "type": [ "null", "string" ] }, "countryCode": { "type": "string" } } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } }, "PublicCostEstimateItemRequest": { "required": [ "capabilityKey", "monthlyCalls" ], "type": "object", "properties": { "capabilityKey": { "type": "string" }, "monthlyCalls": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PublicCostEstimateItemResponse": { "required": [ "capabilityKey", "capabilityName", "monthlyCalls", "creditMultiplier", "estimatedCredits" ], "type": "object", "properties": { "capabilityKey": { "type": "string" }, "capabilityName": { "type": "string" }, "monthlyCalls": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "creditMultiplier": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "estimatedCredits": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "PublicCostEstimateRequest": { "required": [ "planKey", "items" ], "type": "object", "properties": { "planKey": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCostEstimateItemRequest" } } } }, "PublicCostEstimateResponse": { "required": [ "planKey", "planName", "requestedCredits", "includedCredits", "overageCredits", "monthlyPriceEur", "overageCostEur", "totalEstimatedCostEur", "currency", "items" ], "type": "object", "properties": { "planKey": { "type": "string" }, "planName": { "type": "string" }, "requestedCredits": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "includedCredits": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "overageCredits": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "monthlyPriceEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overageCostEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalEstimatedCostEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currency": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCostEstimateItemResponse" } }, "priceTaxBehavior": { "type": "string", "default": "Legacy" }, "netMonthlyPriceEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "netOverageCostEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "netTotalEstimatedCostEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "PublicPlansResponse": { "required": [ "plans" ], "type": "object", "properties": { "plans": { "type": "array", "items": { "$ref": "#/components/schemas/PlanResponse" } } } }, "PurchaseAttemptResponse": { "required": [ "attemptId", "status", "failureReason", "invoiceId" ], "type": "object", "properties": { "attemptId": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "failureReason": { "type": [ "null", "string" ] }, "invoiceId": { "type": [ "null", "string" ], "format": "uuid" } } }, "PurchaseSubscriptionRequest": { "required": [ "priceKey", "paymentMethodId", "idempotencyToken", "termsAccepted", "termsVersion" ], "type": "object", "properties": { "priceKey": { "type": "string" }, "paymentMethodId": { "type": "string" }, "idempotencyToken": { "type": "string", "format": "uuid" }, "termsAccepted": { "type": "boolean" }, "termsVersion": { "type": "string" } } }, "RealtimeAnalysisBatchResponse": { "required": [ "results", "usage" ], "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/RealtimeAnalysisResponse" } }, "usage": { "$ref": "#/components/schemas/UsageChargeResponse" } } }, "RealtimeAnalysisResponse": { "required": [ "requestId", "model", "processingTimeMs", "objects", "operations", "usage" ], "type": "object", "properties": { "requestId": { "type": "string" }, "model": { "$ref": "#/components/schemas/AiModel" }, "processingTimeMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/DetectedObjectResponse" } }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/OperationSummaryResponse" } }, "usage": { "$ref": "#/components/schemas/UsageChargeResponse" } } }, "RegisterRequest": { "required": [ "email", "password", "acceptTerms" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "acceptTerms": { "type": "boolean" }, "invitationToken": { "type": [ "null", "string" ] } } }, "RegistrationEmailVerificationRequest": { "required": [ "email", "code" ], "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "string" } } }, "RegistrationEmailVerificationResendRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "RegistrationResponse": { "required": [ "userId", "workspaceId", "planKey", "status" ], "type": "object", "properties": { "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "planKey": { "type": "string" }, "status": { "type": "string" }, "verificationExpiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "RotationResultResponse": { "required": [ "degrees" ], "type": "object", "properties": { "degrees": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ScannerFieldCandidateResponse": { "required": [ "source", "value" ], "type": "object", "properties": { "source": { "type": "string" }, "value": { "type": "string" } } }, "ScannerFieldIssueResponse": { "required": [ "code", "field", "candidates" ], "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": [ "null", "string" ] }, "candidates": { "type": "array", "items": { "$ref": "#/components/schemas/ScannerFieldCandidateResponse" } } } }, "ScannerFieldValuesResponse": { "type": "object", "properties": { "name": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PersonNameResponse" } ] } }, "additionalProperties": { "type": [ "null", "string" ] } }, "ScannerResultResponse": { "required": [ "fields" ], "type": "object", "properties": { "fields": { "$ref": "#/components/schemas/ScannerFieldValuesResponse" }, "issuingCountry": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IssuingCountryResponse" } ] }, "detectedLanguages": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DetectedLanguageResponse" } }, "detectedWritingSystems": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DetectedWritingSystemResponse" } }, "fieldIssues": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ScannerFieldIssueResponse" } } } }, "ScanverionProblemDetails": { "required": [ "title", "status", "code", "requestId", "retryable" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "traceId": { "type": "string" }, "retryable": { "type": "boolean" }, "retryAfter": { "type": "string" }, "docsUrl": { "type": "string", "format": "uri" }, "errors": { "type": "array", "items": { "type": "object" } } }, "description": "Stable Scanverion error envelope. Clients should use code and requestId rather than localized message text." }, "SelectPlanRequest": { "required": [ "planKey" ], "type": "object", "properties": { "planKey": { "type": "string" } } }, "ServiceTaxCategory": { "type": "integer" }, "SessionResponse": { "required": [ "accessToken", "expiresAt", "account" ], "type": "object", "properties": { "accessToken": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "account": { "$ref": "#/components/schemas/AccountProfileResponse" } } }, "SetDefaultPaymentMethodRequest": { "required": [ "paymentMethodId" ], "type": "object", "properties": { "paymentMethodId": { "type": "string" } } }, "SignatureResultResponse": { "required": [ "isPresent", "confidence" ], "type": "object", "properties": { "isPresent": { "type": "boolean" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "StripeSessionResponse": { "required": [ "sessionId", "redirectUrl", "expiresAt" ], "type": "object", "properties": { "sessionId": { "type": "string" }, "redirectUrl": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "StripeSetupIntentResponse": { "required": [ "setupIntentId", "clientSecret", "publishableKey" ], "type": "object", "properties": { "setupIntentId": { "type": "string" }, "clientSecret": { "type": "string" }, "publishableKey": { "type": "string" } } }, "SubscriptionChangePreviewRequest": { "required": [ "priceKey", "paymentMethodId" ], "type": "object", "properties": { "priceKey": { "type": "string" }, "paymentMethodId": { "type": "string" }, "idempotencyToken": { "type": [ "null", "string" ], "format": "uuid" } } }, "SubscriptionChangePreviewResponse": { "required": [ "changeType", "currentPlanKey", "currentPlanName", "newPlanKey", "newPlanName", "amountDueNow", "additionalCreditsGrantedNow", "nextMonthlyPrice", "effectiveOn", "paymentMethodId", "resultingMaximumOverageBudget", "overageBudgetWillBeReduced", "currency" ], "type": "object", "properties": { "changeType": { "type": "string" }, "currentPlanKey": { "type": "string" }, "currentPlanName": { "type": "string" }, "newPlanKey": { "type": "string" }, "newPlanName": { "type": "string" }, "amountDueNow": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "additionalCreditsGrantedNow": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "nextMonthlyPrice": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "effectiveOn": { "type": "string", "format": "date" }, "paymentMethodId": { "type": "string" }, "resultingMaximumOverageBudget": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overageBudgetWillBeReduced": { "type": "boolean" }, "currency": { "type": "string" }, "priceTaxBehavior": { "type": "string", "default": "Legacy" }, "netAmountDueNow": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "vatAmountDueNow": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "vatRatePercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "quoteExpiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "SubscriptionPurchaseResponse": { "required": [ "subscriptionId", "status", "paymentIntentClientSecret", "publishableKey", "changeType", "effectiveOn" ], "type": "object", "properties": { "subscriptionId": { "type": "string" }, "status": { "type": "string" }, "paymentIntentClientSecret": { "type": [ "null", "string" ] }, "publishableKey": { "type": "string" }, "changeType": { "type": "string" }, "effectiveOn": { "type": "string", "format": "date" }, "billingAttemptId": { "type": [ "null", "string" ], "format": "uuid" } } }, "TaxActivationGateResult": { "required": [ "canCreateQuote", "canFinalizeInvoice", "blockingReasons" ], "type": "object", "properties": { "canCreateQuote": { "type": "boolean" }, "canFinalizeInvoice": { "type": "boolean" }, "blockingReasons": { "type": "array", "items": { "type": "string" } } } }, "TaxAmounts": { "type": "object", "properties": { "netMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "vatMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "grossMinor": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "currency": { "type": [ "null", "string" ] } } }, "TaxDeterminationResult": { "required": [ "vatJurisdiction", "taxScheme", "taxTreatment", "reportingScheme", "ruleCode", "ruleVersion", "serviceTaxCategory", "vatRateBasisPoints", "legalTextVersion" ], "type": "object", "properties": { "vatJurisdiction": { "$ref": "#/components/schemas/TaxJurisdictionCode" }, "taxScheme": { "$ref": "#/components/schemas/TaxSchemeCode" }, "taxTreatment": { "$ref": "#/components/schemas/TaxTreatmentCode" }, "reportingScheme": { "$ref": "#/components/schemas/TaxReportingSchemeCode" }, "ruleCode": { "type": "string" }, "ruleVersion": { "type": "string" }, "serviceTaxCategory": { "$ref": "#/components/schemas/ServiceTaxCategory" }, "vatRateBasisPoints": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "legalTextVersion": { "type": "string" } } }, "TaxInvoiceFinalizationRequest": { "required": [ "workspaceId", "quoteId", "documentSeriesId", "idempotencyKey" ], "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid" }, "quoteId": { "type": "string", "format": "uuid" }, "documentSeriesId": { "type": "string", "format": "uuid" }, "idempotencyKey": { "type": "string" } } }, "TaxInvoiceFinalizationResult": { "required": [ "succeeded", "blockingReasons" ], "type": "object", "properties": { "succeeded": { "type": "boolean" }, "created": { "type": "boolean" }, "invoice": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Invoice" } ] }, "blockingReasons": { "type": "array", "items": { "type": "string" } } } }, "TaxJurisdictionCode": { "type": "integer" }, "TaxQuote": { "required": [ "id", "workspaceId", "customerTaxProfileVersion", "customerEvidenceVersion", "packagePriceVersionId", "taxRuleVersion", "taxRateVersion", "taxDetermination", "amounts", "currency", "servicePeriodStart", "servicePeriodEnd", "expectedTaxPointDate", "createdAt", "expiresAt", "calculationVersion", "integrityHash" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "workspaceId": { "type": "string", "format": "uuid" }, "customerTaxProfileVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "customerEvidenceVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "packagePriceVersionId": { "type": "string", "format": "uuid" }, "taxRuleVersion": { "type": "string" }, "taxRateVersion": { "type": "string" }, "taxDetermination": { "$ref": "#/components/schemas/TaxDeterminationResult" }, "amounts": { "$ref": "#/components/schemas/TaxAmounts" }, "currency": { "type": "string" }, "servicePeriodStart": { "type": "string", "format": "date-time" }, "servicePeriodEnd": { "type": "string", "format": "date-time" }, "expectedTaxPointDate": { "type": "string", "format": "date" }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "calculationVersion": { "type": "string" }, "integrityHash": { "type": "string" }, "status": { "$ref": "#/components/schemas/TaxQuoteStatus" } } }, "TaxQuoteCreationRequest": { "required": [ "workspaceId", "packagePriceVersionId", "chargeType", "servicePeriodStart", "servicePeriodEnd", "taxRuleVersion", "idempotencyKey" ], "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid" }, "packagePriceVersionId": { "type": "string", "format": "uuid" }, "chargeType": { "$ref": "#/components/schemas/ChargeType" }, "servicePeriodStart": { "type": "string", "format": "date-time" }, "servicePeriodEnd": { "type": "string", "format": "date-time" }, "paymentSucceededAt": { "type": [ "null", "string" ], "format": "date-time" }, "usageSegmentClosedAt": { "type": [ "null", "string" ], "format": "date-time" }, "taxRuleVersion": { "type": "string" }, "idempotencyKey": { "type": "string" } } }, "TaxQuoteCreationResult": { "required": [ "succeeded", "blockingReasons" ], "type": "object", "properties": { "succeeded": { "type": "boolean" }, "quote": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TaxQuote" } ] }, "blockingReasons": { "type": "array", "items": { "type": "string" } } } }, "TaxQuoteStatus": { "type": "integer" }, "TaxReportingSchemeCode": { "type": "integer" }, "TaxSchemeCode": { "type": "integer" }, "TaxTreatmentCode": { "type": "integer" }, "TaxValidationStatus": { "type": "integer" }, "UpdateApiKeyRequest": { "required": [ "name", "scopes", "expiresAt" ], "type": "object", "properties": { "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "UpdateBudgetLimitRequest": { "required": [ "monthlyLimitEur" ], "type": "object", "properties": { "monthlyLimitEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "UpdateProfileRequest": { "required": [ "firstName", "surname", "language", "workspaceName" ], "type": "object", "properties": { "firstName": { "type": [ "null", "string" ] }, "surname": { "type": [ "null", "string" ] }, "language": { "type": "string" }, "workspaceName": { "type": [ "null", "string" ] } } }, "UpdateWorkspaceMemberRequest": { "required": [ "role", "team", "mfaPolicy" ], "type": "object", "properties": { "role": { "type": "string" }, "team": { "type": [ "null", "string" ] }, "mfaPolicy": { "type": "string" } } }, "UsageChargeResponse": { "required": [ "units", "unitsByOperation" ], "type": "object", "properties": { "units": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "unitsByOperation": { "type": "object", "additionalProperties": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } }, "UsagePricePreviewResponse": { "required": [ "includedCostEur", "overageCostEur", "totalEstimatedCostEur", "currency" ], "type": "object", "properties": { "includedCostEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "overageCostEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalEstimatedCostEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "currency": { "type": "string" } } }, "UsageSummaryResponse": { "required": [ "from", "to", "totalCalls", "estimatedCostEur", "includedCredits", "usedCredits" ], "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "totalCalls": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "estimatedCostEur": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "includedCredits": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "usedCredits": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ViesVatValidationRequest": { "required": [ "countryCode", "vatNumber" ], "type": "object", "properties": { "countryCode": { "type": "string" }, "vatNumber": { "type": "string" } } }, "ViesVatValidationResult": { "required": [ "status", "providerCode", "countryCode", "normalizedVatNumber" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/TaxValidationStatus" }, "providerCode": { "type": "string" }, "countryCode": { "type": "string" }, "normalizedVatNumber": { "type": "string" }, "legalName": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "requestIdentifier": { "type": [ "null", "string" ] }, "failureCategory": { "type": [ "null", "string" ] }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "WorkspaceInvitationResponse": { "required": [ "invitationId", "email", "role", "team", "status", "createdAt", "expiresAt" ], "type": "object", "properties": { "invitationId": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "team": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "WorkspaceInvitationsResponse": { "required": [ "invitations" ], "type": "object", "properties": { "invitations": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceInvitationResponse" } } } }, "WorkspaceMemberResponse": { "required": [ "userId", "name", "email", "role", "status", "team", "mfaPolicy", "createdAt", "lastActiveAt" ], "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "team": { "type": [ "null", "string" ] }, "mfaPolicy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastActiveAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "WorkspaceMembersResponse": { "required": [ "members" ], "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceMemberResponse" } } } } }, "examples": { "ValidationProblem": { "summary": "Validation error", "description": "The request was syntactically valid but failed a documented input rule.", "value": { "type": "https://scanverion.com/problems/validation_failed", "title": "Validation error", "status": 422, "detail": "The request was syntactically valid but failed a documented input rule.", "code": "validation_failed", "requestId": "req_example_01", "retryable": false } }, "AuthenticationProblem": { "summary": "Authentication required", "description": "Provide a valid Scanverion API key or dashboard access token.", "value": { "type": "https://scanverion.com/problems/authentication_required", "title": "Authentication required", "status": 401, "detail": "Provide a valid Scanverion API key or dashboard access token.", "code": "authentication_required", "requestId": "req_example_01", "retryable": false } }, "QuotaProblem": { "summary": "Quota exceeded", "description": "The workspace has no remaining entitlement for this operation.", "value": { "type": "https://scanverion.com/problems/quota_exceeded", "title": "Quota exceeded", "status": 429, "detail": "The workspace has no remaining entitlement for this operation.", "code": "quota_exceeded", "requestId": "req_example_01", "retryable": false } }, "TransientProblem": { "summary": "Temporary service failure", "description": "The request may be retried according to the Retry-After response header.", "value": { "type": "https://scanverion.com/problems/service_unavailable", "title": "Temporary service failure", "status": 503, "detail": "The request may be retried according to the Retry-After response header.", "code": "service_unavailable", "requestId": "req_example_01", "retryable": true } } }, "securitySchemes": { "ApiKeyAuth": { "type": "http", "description": "Use a Scanverion API key as a bearer token: skv_...", "scheme": "bearer", "bearerFormat": "API key" }, "JwtAuth": { "type": "http", "description": "Use a dashboard session access token as a bearer token.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "Account" }, { "name": "AiProcessing" }, { "name": "ApiKeys" }, { "name": "Auth" }, { "name": "Billing" }, { "name": "Health" }, { "name": "Mfa" }, { "name": "ProductCatalog" }, { "name": "Public" }, { "name": "StripeWebhook" }, { "name": "Subscriptions" }, { "name": "Tax" }, { "name": "Usage" }, { "name": "Validation" }, { "name": "WorkspaceMembers" } ] }