{ "openapi": "3.1.0", "info": { "title": "ScreenVeritAI API", "description": "ScreenVeritAI external API. Quick Check performs deterministic sanctions, PEP/RCA and criminal-watchlist screening. Full Search adds AI review and adverse media. Crypto Address Check is a separate prepaid product. API requests use X-API-Key; key management uses an account Bearer token. Request-rate limits and paid screening allowances are separate. See the public reference for product scope, billing and retry rules.", "version": "1.0.0" }, "paths": { "/keys": { "post": { "tags": [ "API Keys" ], "summary": "Create Api Key", "description": "Create a new API key.\n\n**Important**: The API key is only shown once in this response. Make sure to save it!", "operationId": "create_api_key_keys_post", "parameters": [ { "name": "Authorization", "in": "header", "required": false, "schema": { "type": "string", "title": "Authorization" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPIKeyRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPIKeyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "AccountBearer": [] } ] }, "get": { "tags": [ "API Keys" ], "summary": "List Api Keys", "description": "List all API keys for the authenticated user.", "operationId": "list_api_keys_keys_get", "parameters": [ { "name": "Authorization", "in": "header", "required": false, "schema": { "type": "string", "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIKeyListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "AccountBearer": [] } ] } }, "/keys/{key_id}": { "delete": { "tags": [ "API Keys" ], "summary": "Revoke Api Key", "description": "Revoke (deactivate) an API key.\n\nThe key will no longer be usable for authentication.", "operationId": "revoke_api_key_keys__key_id__delete", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "type": "string", "title": "Authorization" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "AccountBearer": [] } ] } }, "/keys/{key_id}/usage": { "get": { "tags": [ "API Keys" ], "summary": "Get Api Key Usage", "description": "Get usage statistics for an API key.", "operationId": "get_api_key_usage_keys__key_id__usage_get", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "type": "string", "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIKeyUsageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "AccountBearer": [] } ] } }, "/keys/{key_id}/logs": { "get": { "tags": [ "API Keys" ], "summary": "Get Api Key Logs", "description": "Get recent non-secret usage logs for an API key owned by the user.", "operationId": "get_api_key_logs_keys__key_id__logs_get", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "title": "Limit" } }, { "name": "Authorization", "in": "header", "required": false, "schema": { "type": "string", "title": "Authorization" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIKeyUsageLogListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "AccountBearer": [] } ] } }, "/search": { "post": { "tags": [ "Search" ], "summary": "Create Search", "description": "Create a new search screening.\n\nThis endpoint queues the search for processing. Results can be retrieved\nvia the GET endpoint once the status is 'completed'.\n\n**Rate Limits**: Based on your subscription tier.", "operationId": "create_search_search_post", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 16, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "get": { "tags": [ "Search" ], "summary": "List Searches", "description": "List all searches for the authenticated user.\n\nSupports pagination and filtering by status.", "operationId": "list_searches_search_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by status", "title": "Status" }, "description": "Filter by status" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Items per page", "default": 20, "title": "Page Size" }, "description": "Items per page" }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/search/{search_id}": { "get": { "tags": [ "Search" ], "summary": "Get Search", "description": "Get search results by ID.\n\nReturns the full search results if the search is completed.", "operationId": "get_search_search__search_id__get", "parameters": [ { "name": "search_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Search Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResult" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "delete": { "tags": [ "Search" ], "summary": "Delete Search", "description": "Delete a search record.", "operationId": "delete_search_search__search_id__delete", "parameters": [ { "name": "search_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Search Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/batch": { "post": { "tags": [ "Batch" ], "summary": "Create Batch", "description": "Create a new batch screening job.\n\nUpload a CSV or XLSX file with a 'name' column (required), optional 'country',\nand optional 'search_type'. All rows must use the same search type.\n\n**Limits**:\n- Maximum file size: 2 MB\n- Maximum rows: 100", "operationId": "create_batch_batch_post", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_batch_batch_post" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBatchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] }, "get": { "tags": [ "Batch" ], "summary": "List Batches", "description": "List all batch jobs for the authenticated user.", "operationId": "list_batches_batch_get", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by status", "title": "Status" }, "description": "Filter by status" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/batch/{job_id}": { "get": { "tags": [ "Batch" ], "summary": "Get Batch", "description": "Get batch job status and details.", "operationId": "get_batch_batch__job_id__get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchJobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/batch/{job_id}/rows": { "get": { "tags": [ "Batch" ], "summary": "List Batch Rows", "description": "List rows within a batch job.", "operationId": "list_batch_rows_batch__job_id__rows_get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/batch/{job_id}/export": { "get": { "tags": [ "Batch" ], "summary": "Export Batch", "description": "Export batch results as CSV.", "operationId": "export_batch_batch__job_id__export_get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Job Id" } }, { "name": "errors_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Errors Only" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/account": { "get": { "tags": [ "Account" ], "summary": "Get Account", "description": "Get account information for the authenticated API key owner.\n\nReturns subscription tier, credits used/remaining, and rate limits.", "operationId": "get_account_account_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/account/credits": { "get": { "tags": [ "Account" ], "summary": "Get Credits", "description": "Get remaining credit balance for the authenticated API key owner.", "operationId": "get_credits_account_credits_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/coverage": { "get": { "tags": [ "Coverage" ], "summary": "Get Coverage", "description": "Return currently available screening-data coverage for API clients.", "operationId": "get_coverage_coverage_get", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoverageResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/health": { "get": { "tags": [ "Health" ], "summary": "Get Health", "description": "Return lightweight public API health and build metadata.", "operationId": "get_health_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } } } } }, "/business-verification/vies": { "post": { "tags": [ "Business Verification" ], "summary": "Vies", "description": "Validate an EU VAT number. Requires `search:write`; consumes no screening credits.", "operationId": "vies_business_verification_vies_post", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViesRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/business-verification/peppol": { "post": { "tags": [ "Business Verification" ], "summary": "Peppol", "description": "Query voluntary Peppol Directory publication. Requires `search:write`; consumes no screening credits.", "operationId": "peppol_business_verification_peppol_post", "parameters": [ { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeppolRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/crypto-address/checks": { "post": { "tags": [ "Crypto Address Screening" ], "summary": "Check a crypto address (\u20ac0.39 PAYG)", "description": "Requires `search:write`, Idempotency-Key and max_prepaid_cents. No subscription credits.\n\nSource failures are unpaid. Repeat the same key/input to retrieve the original\nresult without a new charge. OFAC currency labels are not network coverage;\n`network=ethereum` additionally requires a native-USDC issuer-state check.", "operationId": "create_check_crypto_address_checks_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128, "title": "Idempotency-Key" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CryptoAddressInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/crypto-address/checks/{check_id}": { "get": { "tags": [ "Crypto Address Screening" ], "summary": "Retrieve your crypto address check (no charge)", "operationId": "get_check_crypto_address_checks__check_id__get", "parameters": [ { "name": "check_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Check Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } } }, "components": { "schemas": { "APIKeyListResponse": { "properties": { "keys": { "items": { "$ref": "#/components/schemas/APIKeyResponse" }, "type": "array", "title": "Keys" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "keys", "total" ], "title": "APIKeyListResponse", "description": "Response containing list of API keys." }, "APIKeyResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "key_prefix": { "type": "string", "title": "Key Prefix" }, "permissions": { "items": { "type": "string" }, "type": "array", "title": "Permissions" }, "rate_limit_tier": { "type": "string", "title": "Rate Limit Tier" }, "rate_limit_per_minute": { "type": "integer", "title": "Rate Limit Per Minute" }, "rate_limit_per_day": { "type": "integer", "title": "Rate Limit Per Day" }, "is_active": { "type": "boolean", "title": "Is Active" }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "created_at": { "type": "string", "title": "Created At" } }, "type": "object", "required": [ "id", "name", "key_prefix", "permissions", "rate_limit_tier", "rate_limit_per_minute", "rate_limit_per_day", "is_active", "last_used_at", "expires_at", "created_at" ], "title": "APIKeyResponse", "description": "Response containing API key details (without the actual key)." }, "APIKeyUsageLogListResponse": { "properties": { "key_id": { "type": "string", "title": "Key Id" }, "logs": { "items": { "$ref": "#/components/schemas/APIKeyUsageLogResponse" }, "type": "array", "title": "Logs" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "key_id", "logs", "total" ], "title": "APIKeyUsageLogListResponse", "description": "Recent usage log rows for an API key." }, "APIKeyUsageLogResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "endpoint": { "type": "string", "title": "Endpoint" }, "method": { "type": "string", "title": "Method" }, "status_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Status Code" }, "response_time_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Response Time Ms" }, "credits_charged": { "type": "number", "title": "Credits Charged" }, "search_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search Id" }, "batch_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Batch Job Id" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "created_at": { "type": "string", "title": "Created At" } }, "type": "object", "required": [ "id", "endpoint", "method", "status_code", "response_time_ms", "credits_charged", "search_id", "batch_job_id", "metadata", "created_at" ], "title": "APIKeyUsageLogResponse", "description": "Single API key usage log row for dashboard display." }, "APIKeyUsageResponse": { "properties": { "key_id": { "type": "string", "title": "Key Id" }, "total_requests": { "type": "integer", "title": "Total Requests" }, "requests_today": { "type": "integer", "title": "Requests Today" }, "requests_this_hour": { "type": "integer", "title": "Requests This Hour" }, "total_credits_charged": { "type": "number", "title": "Total Credits Charged" }, "credits_charged_today": { "type": "number", "title": "Credits Charged Today" }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Used At" } }, "type": "object", "required": [ "key_id", "total_requests", "requests_today", "requests_this_hour", "total_credits_charged", "credits_charged_today", "last_used_at" ], "title": "APIKeyUsageResponse", "description": "Response containing API key usage statistics." }, "AccountResponse": { "properties": { "subscription_tier": { "type": "string", "title": "Subscription Tier" }, "credits_used": { "type": "number", "title": "Credits Used" }, "credits_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Credits Limit" }, "credits_remaining": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credits Remaining" }, "rate_limit_tier": { "type": "string", "title": "Rate Limit Tier" }, "rate_limit_per_minute": { "type": "integer", "title": "Rate Limit Per Minute" }, "rate_limit_per_day": { "type": "integer", "title": "Rate Limit Per Day" }, "api_key_id": { "type": "string", "title": "Api Key Id" }, "credit_pools": { "additionalProperties": { "$ref": "#/components/schemas/CreditPoolResponse" }, "type": "object", "title": "Credit Pools" }, "prepaid_balance_cents": { "type": "integer", "title": "Prepaid Balance Cents" }, "prepaid_currency": { "type": "string", "title": "Prepaid Currency", "default": "eur" } }, "type": "object", "required": [ "subscription_tier", "credits_used", "credits_limit", "credits_remaining", "rate_limit_tier", "rate_limit_per_minute", "rate_limit_per_day", "api_key_id", "credit_pools", "prepaid_balance_cents" ], "title": "AccountResponse", "description": "Account information for the API key owner." }, "BatchJobResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "status": { "type": "string", "title": "Status" }, "total_rows": { "type": "integer", "title": "Total Rows" }, "processed_rows": { "type": "integer", "title": "Processed Rows" }, "success_rows": { "type": "integer", "title": "Success Rows" }, "error_rows": { "type": "integer", "title": "Error Rows" }, "credits_charged": { "type": "integer", "title": "Credits Charged" }, "source_filename": { "type": "string", "title": "Source Filename" }, "search_type": { "type": "string", "title": "Search Type" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" } }, "type": "object", "required": [ "id", "status", "total_rows", "processed_rows", "success_rows", "error_rows", "credits_charged", "source_filename", "search_type", "created_at", "completed_at" ], "title": "BatchJobResponse", "description": "Response containing batch job details." }, "BatchListResponse": { "properties": { "jobs": { "items": { "$ref": "#/components/schemas/BatchJobResponse" }, "type": "array", "title": "Jobs" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "jobs", "total" ], "title": "BatchListResponse", "description": "Response containing list of batch jobs." }, "Body_create_batch_batch_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_create_batch_batch_post" }, "CoverageDomain": { "properties": { "domain": { "type": "string", "title": "Domain" }, "expected_tables": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expected Tables" }, "available_tables": { "type": "integer", "title": "Available Tables" }, "tables": { "items": { "type": "string" }, "type": "array", "title": "Tables" }, "latest_updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Latest Updated At" } }, "type": "object", "required": [ "domain", "available_tables" ], "title": "CoverageDomain" }, "CoverageResponse": { "properties": { "status": { "type": "string", "title": "Status" }, "checkedAt": { "type": "string", "title": "Checkedat" }, "domains": { "additionalProperties": { "$ref": "#/components/schemas/CoverageDomain" }, "type": "object", "title": "Domains" } }, "type": "object", "required": [ "status", "checkedAt", "domains" ], "title": "CoverageResponse" }, "CreateAPIKeyRequest": { "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Name", "description": "Friendly name for the API key" }, "permissions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Permissions", "description": "List of permissions for the key", "default": [ "search:read", "search:write", "batch:read", "batch:write" ] }, "expires_in_days": { "anyOf": [ { "type": "integer", "maximum": 365.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Expires In Days", "description": "Number of days until the key expires (null = never expires)" } }, "type": "object", "required": [ "name" ], "title": "CreateAPIKeyRequest", "description": "Request to create a new API key." }, "CreateAPIKeyResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "key_prefix": { "type": "string", "title": "Key Prefix" }, "permissions": { "items": { "type": "string" }, "type": "array", "title": "Permissions" }, "rate_limit_tier": { "type": "string", "title": "Rate Limit Tier" }, "rate_limit_per_minute": { "type": "integer", "title": "Rate Limit Per Minute" }, "rate_limit_per_day": { "type": "integer", "title": "Rate Limit Per Day" }, "is_active": { "type": "boolean", "title": "Is Active" }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "expires_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "created_at": { "type": "string", "title": "Created At" }, "api_key": { "type": "string", "title": "Api Key", "description": "The API key - save this now, it won't be shown again!" } }, "type": "object", "required": [ "id", "name", "key_prefix", "permissions", "rate_limit_tier", "rate_limit_per_minute", "rate_limit_per_day", "is_active", "last_used_at", "expires_at", "created_at", "api_key" ], "title": "CreateAPIKeyResponse", "description": "Response when creating a new API key (includes the actual key - shown only once!)." }, "CreateBatchResponse": { "properties": { "job_id": { "type": "string", "title": "Job Id" }, "total_rows": { "type": "integer", "title": "Total Rows" }, "credits_charged": { "type": "integer", "title": "Credits Charged" }, "search_type": { "type": "string", "title": "Search Type" }, "status": { "type": "string", "title": "Status" }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "job_id", "total_rows", "credits_charged", "search_type", "status", "message" ], "title": "CreateBatchResponse", "description": "Response when creating a new batch job." }, "CreateSearchResponse": { "properties": { "search_id": { "type": "string", "title": "Search Id" }, "status": { "type": "string", "title": "Status" }, "message": { "type": "string", "title": "Message" }, "estimated_time_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Estimated Time Seconds" } }, "type": "object", "required": [ "search_id", "status", "message", "estimated_time_seconds" ], "title": "CreateSearchResponse", "description": "Response when creating a new search." }, "CreditPoolResponse": { "properties": { "used": { "type": "number", "title": "Used" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "remaining": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Remaining" } }, "type": "object", "required": [ "used", "limit", "remaining" ], "title": "CreditPoolResponse" }, "CreditsResponse": { "properties": { "subscription_tier": { "type": "string", "title": "Subscription Tier" }, "credits_used": { "type": "number", "title": "Credits Used" }, "credits_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Credits Limit" }, "credits_remaining": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Credits Remaining" }, "credit_pools": { "additionalProperties": { "$ref": "#/components/schemas/CreditPoolResponse" }, "type": "object", "title": "Credit Pools" }, "prepaid_balance_cents": { "type": "integer", "title": "Prepaid Balance Cents" }, "prepaid_currency": { "type": "string", "title": "Prepaid Currency", "default": "eur" } }, "type": "object", "required": [ "subscription_tier", "credits_used", "credits_limit", "credits_remaining", "credit_pools", "prepaid_balance_cents" ], "title": "CreditsResponse", "description": "Credit balance for the API key owner." }, "CryptoAddressInput": { "properties": { "address": { "type": "string", "maxLength": 240, "minLength": 8, "title": "Address" }, "currency": { "type": "string", "maxLength": 12, "minLength": 2, "title": "Currency", "description": "OFAC published asset label, e.g. ETH, XBT, TRX, USDT. Not a chain ID." }, "network": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Network", "description": "Set 'ethereum' to also require the native-USDC issuer-block check; omitted means OFAC only." }, "max_prepaid_cents": { "type": "integer", "minimum": 0.0, "title": "Max Prepaid Cents", "description": "Maximum approved PAYG cost in EUR cents. Current unit price is 39." } }, "additionalProperties": false, "type": "object", "required": [ "address", "currency", "max_prepaid_cents" ], "title": "CryptoAddressInput" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HealthResponse": { "properties": { "status": { "type": "string", "title": "Status" }, "service": { "type": "string", "title": "Service" }, "environment": { "type": "string", "title": "Environment" }, "version": { "type": "string", "title": "Version" }, "gitSha": { "type": "string", "title": "Gitsha" }, "imageTag": { "type": "string", "title": "Imagetag" }, "builtAt": { "type": "string", "title": "Builtat" }, "checkedAt": { "type": "string", "title": "Checkedat" } }, "type": "object", "required": [ "status", "service", "environment", "version", "gitSha", "imageTag", "builtAt", "checkedAt" ], "title": "HealthResponse" }, "PeppolRequest": { "properties": { "participant_id": { "type": "string", "maxLength": 160, "minLength": 6, "title": "Participant Id" } }, "type": "object", "required": [ "participant_id" ], "title": "PeppolRequest" }, "SearchListResponse": { "properties": { "searches": { "items": { "$ref": "#/components/schemas/SearchResult" }, "type": "array", "title": "Searches" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" } }, "type": "object", "required": [ "searches", "total", "page", "page_size" ], "title": "SearchListResponse", "description": "Response containing list of searches." }, "SearchRequest": { "properties": { "max_prepaid_cents": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Max Prepaid Cents", "description": "Maximum EUR cents allowed from the prepaid wallet for this request; 0 permits subscription only." }, "entity_name": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Entity Name", "description": "Name of entity to search" }, "entity_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Type", "description": "Type of entity: 'person', 'company', or 'any'", "default": "any" }, "search_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search Type", "description": "'full_search', 'sanctions_check', 'adverse_media', 'deep_research_report', or 'soft_research'", "default": "full_search" }, "country": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Country", "description": "Jurisdiction hint; sharpens Deep Research identity resolution", "default": "" }, "identifier": { "anyOf": [ { "type": "string", "maxLength": 240 }, { "type": "null" } ], "title": "Identifier", "description": "Registration number or other public identifier", "default": "" }, "website": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Website", "description": "Public website of the subject. A bare domain is accepted and normalized to HTTPS for deep_research_report.", "default": "" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Language for the report (e.g., 'en', 'pl')", "default": "en" } }, "type": "object", "required": [ "entity_name" ], "title": "SearchRequest", "description": "Request to create a new search." }, "SearchResult": { "properties": { "id": { "type": "string", "title": "Id" }, "entity_name": { "type": "string", "title": "Entity Name" }, "entity_type": { "type": "string", "title": "Entity Type" }, "status": { "type": "string", "title": "Status" }, "search_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search Type" }, "final_report": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Final Report" }, "news_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "News Summary" }, "ofac_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ofac Sanctions" }, "eu_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Eu Sanctions" }, "fr_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fr Sanctions" }, "pl_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pl Sanctions" }, "uk_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uk Sanctions" }, "un_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Un Sanctions" }, "canada_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Canada Sanctions" }, "australia_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Australia Sanctions" }, "switzerland_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Switzerland Sanctions" }, "south_africa_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "South Africa Sanctions" }, "new_zealand_sanctions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "New Zealand Sanctions" }, "sanctions_sources": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Sanctions Sources" }, "additional_sanctions_sources": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Additional Sanctions Sources" }, "criminal_watchlists": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Criminal Watchlists" }, "pep": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pep" }, "relationships": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relationships" }, "created_at": { "type": "string", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Completed At" } }, "type": "object", "required": [ "id", "entity_name", "entity_type", "status", "search_type", "final_report", "news_summary", "ofac_sanctions", "eu_sanctions", "fr_sanctions", "pl_sanctions", "uk_sanctions", "un_sanctions", "relationships", "created_at", "completed_at" ], "title": "SearchResult", "description": "Search result data." }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "ViesRequest": { "properties": { "country_code": { "anyOf": [ { "type": "string", "maxLength": 2 }, { "type": "null" } ], "title": "Country Code" }, "vat_number": { "type": "string", "maxLength": 32, "minLength": 2, "title": "Vat Number" } }, "type": "object", "required": [ "vat_number" ], "title": "ViesRequest" } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key" }, "AccountBearer": { "type": "http", "scheme": "bearer" } } }, "servers": [ { "url": "https://screenveritai.com/api/v1" } ], "externalDocs": { "description": "Public API reference and integration guides", "url": "https://screenveritai.com/en/developers/reference" } }