{ "components": { "schemas": { "AcceptInviteResult": { "properties": { "company_id": { "type": "string" }, "percentage": { "type": "number" }, "success": { "type": "boolean" } }, "required": [ "success", "company_id", "percentage" ], "title": "AcceptInviteResult", "type": "object" }, "ActivateResult": { "properties": { "activated": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "activated", "message" ], "title": "ActivateResult", "type": "object" }, "Address": { "description": "─────────────────────────────────────────────────────────────────────────────── EMBEDDED TYPES - Nested structures (no sid field) ─────────────────────────────────────────────────────────────────────────────── Physical address", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "postal_code": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } }, "required": [ "street", "city", "state", "postal_code", "country" ], "title": "Address", "type": "object" }, "AdminAction": { "description": "Admin audit log entry [rootobject]", "properties": { "action": { "type": "string" }, "admin_email": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "details": { "type": "string" }, "sid": { "type": "string" }, "target_id": { "type": "string" }, "target_type": { "type": "string" } }, "required": [ "sid", "admin_email", "action", "target_type", "target_id", "details", "created_at" ], "title": "AdminAction", "type": "object" }, "AllPricingConfig": { "description": "All pricing configurations", "properties": { "company_types": { "items": { "$ref": "#/components/schemas/CompanyPricingConfig" }, "type": "array" }, "early_bird_discount": { "type": "number" }, "one_year_discount": { "type": "number" }, "resident_monthly_fee": { "type": "number" }, "two_year_discount": { "type": "number" } }, "required": [ "company_types", "resident_monthly_fee", "early_bird_discount", "one_year_discount", "two_year_discount" ], "title": "AllPricingConfig", "type": "object" }, "ApiKey": { "description": "API key for reseller access [rootobject]", "properties": { "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "is_active": { "type": "boolean" }, "key_hash": { "type": "string" }, "last_used_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "name": { "type": "string" }, "sid": { "type": "string" }, "user_id": { "type": "string" } }, "required": [ "sid", "key_hash", "name", "is_active", "created_at" ], "title": "ApiKey", "type": "object" }, "ApiKeyError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "ApiKeyError", "type": "object" }, "ApiKeyResult": { "description": "API key service types", "properties": { "api_key": { "type": "string" }, "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "api_key", "expires_at" ], "title": "ApiKeyResult", "type": "object" }, "ApiKeysListResult": { "description": "═══════════════════════════════════════════════════════════════════════════════ ADDITIONAL RESULT AND DATA TYPES Added to support generated RPC handlers ═══════════════════════════════════════════════════════════════════════════════ API Key service types", "properties": { "api_keys": { "items": { "$ref": "#/components/schemas/ApiKey" }, "type": "array" } }, "required": [ "api_keys" ], "title": "ApiKeysListResult", "type": "object" }, "AuthError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "AuthError", "type": "object" }, "AuthResult": { "description": "─────────────────────────────────────────────────────────────────────────────── SERVICE REQUEST/RESPONSE TYPES ─────────────────────────────────────────────────────────────────────────────── Auth service types", "properties": { "expires_in": { "type": "integer" }, "refresh_token": { "type": "string" }, "token": { "type": "string" }, "token_type": { "type": "string" }, "user": { "$ref": "#/components/schemas/UserInfo" } }, "required": [ "token", "refresh_token", "token_type", "expires_in", "user" ], "title": "AuthResult", "type": "object" }, "BalanceResult": { "properties": { "account_id": { "type": "string" }, "balance": { "type": "string" }, "currency": { "type": "string" } }, "required": [ "account_id", "balance", "currency" ], "title": "BalanceResult", "type": "object" }, "BusinessDocument": { "description": "─────────────────────────────────────────────────────────────────────────────── BUSINESS DOCUMENTS ─────────────────────────────────────────────────────────────────────────────── Uploaded or generated business document [rootobject]", "properties": { "company_id": { "type": "string" }, "content": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "description": { "type": "string" }, "document_type": { "$ref": "#/components/schemas/BusinessDocumentType" }, "expiry_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "file_url": { "type": "string" }, "is_official": { "type": "boolean" }, "issued_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "name": { "type": "string" }, "sid": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "uploaded_by": { "type": "string" } }, "required": [ "sid", "company_id", "document_type", "name", "is_official", "created_at", "updated_at" ], "title": "BusinessDocument", "type": "object" }, "BusinessDocumentDetailResult": { "properties": { "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "description": { "type": "string" }, "document_id": { "type": "string" }, "document_type": { "$ref": "#/components/schemas/BusinessDocumentType" }, "expiry_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "file_url": { "type": "string" }, "is_official": { "type": "boolean" }, "issued_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "name": { "type": "string" } }, "required": [ "document_id", "company_id", "document_type", "name", "is_official", "created_at" ], "title": "BusinessDocumentDetailResult", "type": "object" }, "BusinessDocumentError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "BusinessDocumentError", "type": "object" }, "BusinessDocumentListResult": { "properties": { "documents": { "items": { "$ref": "#/components/schemas/BusinessDocumentDetailResult" }, "type": "array" } }, "required": [ "documents" ], "title": "BusinessDocumentListResult", "type": "object" }, "BusinessDocumentResult": { "description": "Business document service types", "properties": { "document_id": { "type": "string" }, "document_type": { "$ref": "#/components/schemas/BusinessDocumentType" } }, "required": [ "document_id", "document_type" ], "title": "BusinessDocumentResult", "type": "object" }, "BusinessDocumentType": { "description": "Business document type", "enum": [ "certificate_of_incorporation", "business_license", "memorandum", "articles", "resolution", "other" ], "title": "BusinessDocumentType", "type": "string" }, "ChangePasswordResult": { "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message" ], "title": "ChangePasswordResult", "type": "object" }, "ClickPesaResult": { "properties": { "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "order_id": { "type": "string" }, "payment_id": { "type": "string" }, "payment_url": { "type": "string" }, "status": { "$ref": "#/components/schemas/PaymentStatus" } }, "required": [ "payment_id", "order_id", "payment_url", "status", "expires_at" ], "title": "ClickPesaResult", "type": "object" }, "ClickPesaWebhookData": { "properties": { "amount": { "type": "number" }, "checksum": { "type": "string" }, "currency": { "type": "string" }, "event": { "type": "string" }, "order_id": { "type": "string" }, "paid_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "payment_method": { "type": "string" }, "reference": { "type": "string" }, "status": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "event", "order_id", "reference", "amount", "currency", "status" ], "title": "ClickPesaWebhookData", "type": "object" }, "CompaniesListResult": { "description": "Company service types", "properties": { "companies": { "items": { "$ref": "#/components/schemas/FreeZoneCompany" }, "type": "array" }, "page": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "page_size": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "total": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, "required": [ "companies", "total", "page", "page_size" ], "title": "CompaniesListResult", "type": "object" }, "CompanyCardResult": { "properties": { "company_id": { "type": "string" }, "company_type": { "$ref": "#/components/schemas/CompanyType" }, "established": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "name": { "type": "string" }, "public_key": { "type": "string" }, "status": { "$ref": "#/components/schemas/CompanyStatus" } }, "required": [ "company_id", "name", "company_type", "status", "established" ], "title": "CompanyCardResult", "type": "object" }, "CompanyCreateData": { "description": "Company service types", "properties": { "company_type": { "$ref": "#/components/schemas/CompanyType" }, "description": { "type": "string" }, "name": { "type": "string" }, "resident_id": { "type": "string" }, "trading_name": { "type": "string" } }, "required": [ "name", "company_type", "resident_id" ], "title": "CompanyCreateData", "type": "object" }, "CompanyError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "CompanyError", "type": "object" }, "CompanyMessage": { "description": "Company message entity [rootobject]", "properties": { "action_label": { "type": "string" }, "action_url": { "type": "string" }, "body": { "type": "string" }, "category": { "$ref": "#/components/schemas/MessageCategory" }, "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "is_read": { "type": "boolean" }, "message_type": { "$ref": "#/components/schemas/MessageType" }, "sid": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "company_id", "title", "body", "message_type", "is_read", "created_at", "updated_at" ], "title": "CompanyMessage", "type": "object" }, "CompanyPricingConfig": { "description": "Company pricing configuration (for display)", "properties": { "company_type": { "$ref": "#/components/schemas/CompanyType" }, "has_shareholder_fee": { "type": "boolean" }, "max_shareholders": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "monthly_fee": { "type": "number" }, "setup_fee": { "type": "number" }, "shareholder_tiers": { "items": { "$ref": "#/components/schemas/ShareholderFeeTier" }, "type": "array" } }, "required": [ "company_type", "setup_fee", "monthly_fee", "max_shareholders", "has_shareholder_fee", "shareholder_tiers" ], "title": "CompanyPricingConfig", "type": "object" }, "CompanyPricingResult": { "properties": { "annual_fee": { "type": "number" }, "company_type": { "$ref": "#/components/schemas/CompanyType" }, "currency": { "type": "string" }, "registration_fee": { "type": "number" } }, "required": [ "registration_fee", "annual_fee", "currency", "company_type" ], "title": "CompanyPricingResult", "type": "object" }, "CompanyResult": { "properties": { "company": { "$ref": "#/components/schemas/FreeZoneCompany" } }, "required": [ "company" ], "title": "CompanyResult", "type": "object" }, "CompanyStatus": { "description": "Free Zone Company status", "enum": [ "active", "inactive", "suspended" ], "title": "CompanyStatus", "type": "string" }, "CompanySubscriptionPlan": { "description": "Company subscription plan for recurring fees", "enum": [ "monthly", "one_year", "two_years" ], "title": "CompanySubscriptionPlan", "type": "string" }, "CompanyType": { "description": "Company types available in the freezone", "enum": [ "single_fzc", "startup_fzc", "growth_fzc", "global_fzc", "coop_standard_fzc" ], "title": "CompanyType", "type": "string" }, "CompanyUpdateData": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/CompanyStatus" }, "trading_name": { "type": "string" } }, "title": "CompanyUpdateData", "type": "object" }, "CompanyVerificationResult": { "properties": { "company_id": { "type": "string" }, "company_type": { "$ref": "#/components/schemas/CompanyType" }, "established": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "has_full_access": { "type": "boolean" }, "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "name": { "type": "string" }, "public_key": { "type": "string" }, "status": { "$ref": "#/components/schemas/CompanyStatus" }, "valid": { "type": "boolean" }, "verified_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "verified_by": { "type": "string" } }, "required": [ "valid", "company_id", "status", "verified_at", "has_full_access" ], "title": "CompanyVerificationResult", "type": "object" }, "ConfirmResetResult": { "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "title": "ConfirmResetResult", "type": "object" }, "Contract": { "description": "Business Contract entity [rootobject]", "properties": { "contract_type": { "type": "string" }, "counterparty": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "end_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "fzc_id": { "type": "string" }, "name": { "type": "string" }, "sid": { "type": "string" }, "start_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "status": { "$ref": "#/components/schemas/ContractStatus" }, "total_value": { "type": "number" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "fzc_id", "name", "contract_type", "counterparty", "status", "start_date", "created_at", "updated_at" ], "title": "Contract", "type": "object" }, "ContractCreateData": { "description": "Contract service types", "properties": { "content": { "type": "string" }, "contract_type": { "type": "string" }, "parties": { "items": { "type": "string" }, "type": "array" }, "title": { "type": "string" } }, "required": [ "title", "content", "contract_type", "parties" ], "title": "ContractCreateData", "type": "object" }, "ContractError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "ContractError", "type": "object" }, "ContractResult": { "properties": { "contract": { "$ref": "#/components/schemas/Contract" } }, "required": [ "contract" ], "title": "ContractResult", "type": "object" }, "ContractSignature": { "description": "Contract Signature entity [rootobject]", "properties": { "contract_id": { "type": "string" }, "contract_version": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "ip_address": { "type": "string" }, "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "public_key_id": { "type": "string" }, "sid": { "type": "string" }, "signature": { "type": "string" }, "signed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "user_id": { "type": "string" } }, "required": [ "sid", "user_id", "contract_id", "contract_version", "signature", "public_key_id", "keypair_version", "signed_at", "created_at" ], "title": "ContractSignature", "type": "object" }, "ContractStatus": { "description": "Contract status", "enum": [ "draft", "pending_signature", "active", "expired", "archived" ], "title": "ContractStatus", "type": "string" }, "ContractTemplate": { "description": "Contract Template entity [rootobject]", "properties": { "category": { "type": "string" }, "content": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "sid": { "type": "string" } }, "required": [ "sid", "name", "description", "category", "content", "created_at" ], "title": "ContractTemplate", "type": "object" }, "ContractsListResult": { "description": "Contract service types", "properties": { "contracts": { "items": { "$ref": "#/components/schemas/Contract" }, "type": "array" } }, "required": [ "contracts" ], "title": "ContractsListResult", "type": "object" }, "CreateCompanyData": { "properties": { "address": { "$ref": "#/components/schemas/Address" }, "apply_early_bird": { "type": "boolean" }, "auto_renewal": { "type": "boolean" }, "company_type": { "$ref": "#/components/schemas/CompanyType" }, "description": { "type": "string" }, "email": { "type": "string" }, "industry": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" }, "phone": { "type": "string" }, "shareholders": { "items": { "$ref": "#/components/schemas/ShareholderData" }, "type": "array" }, "subscription_plan": { "$ref": "#/components/schemas/CompanySubscriptionPlan" }, "website": { "type": "string" } }, "required": [ "name", "company_type", "description", "address", "shareholders", "subscription_plan", "auto_renewal", "apply_early_bird", "password" ], "title": "CreateCompanyData", "type": "object" }, "CreateContractData": { "properties": { "contract_type": { "type": "string" }, "counterparty": { "type": "string" }, "end_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "name": { "type": "string" }, "start_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "total_value": { "type": "number" } }, "required": [ "name", "contract_type", "counterparty", "start_date" ], "title": "CreateContractData", "type": "object" }, "CreateExpenseData": { "properties": { "amount": { "type": "number" }, "category": { "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "expense_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "receipt_number": { "type": "string" }, "receipt_url": { "type": "string" }, "vendor_name": { "type": "string" } }, "required": [ "receipt_number", "vendor_name", "description", "amount", "currency", "category", "expense_date" ], "title": "CreateExpenseData", "type": "object" }, "CreateInvoiceData": { "properties": { "amount": { "type": "number" }, "currency": { "type": "string" }, "description": { "type": "string" }, "due_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "invoice_number": { "type": "string" }, "issue_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "line_items": { "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array" }, "tax_amount": { "type": "number" } }, "required": [ "invoice_number", "amount", "currency", "tax_amount", "description", "line_items", "issue_date", "due_date" ], "title": "CreateInvoiceData", "type": "object" }, "CreateLinkResult": { "properties": { "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "link_id": { "type": "string" }, "single_use": { "type": "boolean" }, "token": { "type": "string" }, "verification_url": { "type": "string" } }, "required": [ "link_id", "token", "verification_url", "expires_at", "single_use" ], "title": "CreateLinkResult", "type": "object" }, "CreateResidentData": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "kyc_provider_id": { "type": "string" }, "last_name": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "email", "first_name", "last_name", "phone" ], "title": "CreateResidentData", "type": "object" }, "CreateTreasuryAccountData": { "properties": { "account_number": { "type": "string" }, "bank_name": { "type": "string" }, "bic": { "type": "string" }, "currency": { "type": "string" }, "iban": { "type": "string" }, "kind": { "$ref": "#/components/schemas/TreasuryAccountKind" }, "name": { "type": "string" }, "network": { "type": "string" }, "wallet_address": { "type": "string" } }, "required": [ "name", "kind", "currency" ], "title": "CreateTreasuryAccountData", "type": "object" }, "CreditBalance": { "description": "Credit balance per user [rootobject]", "properties": { "balance": { "type": "number" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "last_top_up_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "lifetime_earned": { "type": "number" }, "lifetime_spent": { "type": "number" }, "sid": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "user_id": { "type": "string" } }, "required": [ "sid", "user_id", "balance", "lifetime_earned", "lifetime_spent", "created_at", "updated_at" ], "title": "CreditBalance", "type": "object" }, "CreditBalanceListResult": { "description": "Credit service types (aliases for generator compatibility)", "properties": { "balances": { "items": { "$ref": "#/components/schemas/CreditBalance" }, "type": "array" } }, "required": [ "balances" ], "title": "CreditBalanceListResult", "type": "object" }, "CreditBalanceResult": { "description": "Credit service types", "properties": { "balance": { "type": "number" }, "last_top_up_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "lifetime_earned": { "type": "number" }, "lifetime_spent": { "type": "number" }, "user_id": { "type": "string" } }, "required": [ "user_id", "balance", "lifetime_earned", "lifetime_spent" ], "title": "CreditBalanceResult", "type": "object" }, "CreditError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "CreditError", "type": "object" }, "CreditPlanInfo": { "properties": { "code": { "type": "string" }, "discount_percent": { "type": "number" }, "label": { "type": "string" }, "monthly_effective": { "type": "number" }, "months": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "total_cost": { "type": "number" } }, "required": [ "code", "label", "months", "total_cost", "monthly_effective", "discount_percent" ], "title": "CreditPlanInfo", "type": "object" }, "CreditPricingResult": { "properties": { "currency": { "type": "string" }, "kyc_cost": { "type": "number" }, "monthly_subscription": { "type": "number" }, "plans": { "items": { "$ref": "#/components/schemas/CreditPlanInfo" }, "type": "array" }, "welcome_bonus": { "type": "number" } }, "required": [ "kyc_cost", "monthly_subscription", "welcome_bonus", "currency", "plans" ], "title": "CreditPricingResult", "type": "object" }, "CreditTransaction": { "description": "Credit transaction ledger entry [rootobject]", "properties": { "amount": { "type": "number" }, "balance_after": { "type": "number" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "reference_id": { "type": "string" }, "reference_type": { "type": "string" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/CreditTransactionStatus" }, "tx_type": { "$ref": "#/components/schemas/CreditTransactionType" }, "user_id": { "type": "string" } }, "required": [ "sid", "user_id", "tx_type", "amount", "balance_after", "currency", "description", "status", "created_at" ], "title": "CreditTransaction", "type": "object" }, "CreditTransactionDetail": { "properties": { "amount": { "type": "number" }, "balance_after": { "type": "number" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "reference_id": { "type": "string" }, "reference_type": { "type": "string" }, "status": { "$ref": "#/components/schemas/CreditTransactionStatus" }, "transaction_id": { "type": "string" }, "tx_type": { "$ref": "#/components/schemas/CreditTransactionType" } }, "required": [ "transaction_id", "tx_type", "amount", "balance_after", "currency", "description", "status", "created_at" ], "title": "CreditTransactionDetail", "type": "object" }, "CreditTransactionListResult": { "properties": { "transactions": { "items": { "$ref": "#/components/schemas/CreditTransaction" }, "type": "array" } }, "required": [ "transactions" ], "title": "CreditTransactionListResult", "type": "object" }, "CreditTransactionResult": { "properties": { "amount": { "type": "number" }, "balance_after": { "type": "number" }, "status": { "$ref": "#/components/schemas/CreditTransactionStatus" }, "transaction_id": { "type": "string" }, "tx_type": { "$ref": "#/components/schemas/CreditTransactionType" } }, "required": [ "transaction_id", "tx_type", "amount", "balance_after", "status" ], "title": "CreditTransactionResult", "type": "object" }, "CreditTransactionStatus": { "description": "Credit transaction status", "enum": [ "pending", "completed", "failed" ], "title": "CreditTransactionStatus", "type": "string" }, "CreditTransactionType": { "description": "Credit transaction type", "enum": [ "top_up", "deduction", "refund", "bonus", "expiry" ], "title": "CreditTransactionType", "type": "string" }, "CreditTransactionsListResult": { "properties": { "page": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "page_size": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "total": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "transactions": { "items": { "$ref": "#/components/schemas/CreditTransactionDetail" }, "type": "array" } }, "required": [ "transactions", "total", "page", "page_size" ], "title": "CreditTransactionsListResult", "type": "object" }, "CryptoWallet": { "description": "Crypto wallet for companies", "properties": { "chain": { "type": "string" }, "label": { "type": "string" }, "public_key": { "type": "string" } }, "required": [ "public_key", "chain", "label" ], "title": "CryptoWallet", "type": "object" }, "DeleteBusinessDocumentResult": { "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "title": "DeleteBusinessDocumentResult", "type": "object" }, "DeleteLinksResult": { "properties": { "deleted_count": { "type": "integer" } }, "required": [ "deleted_count" ], "title": "DeleteLinksResult", "type": "object" }, "DeleteResult": { "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message" ], "title": "DeleteResult", "type": "object" }, "DigitalResident": { "description": "Digital Resident entity [rootobject]", "properties": { "auto_renewal": { "type": "boolean" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "email": { "type": "string" }, "encrypted_private_key": { "type": "string" }, "first_name": { "type": "string" }, "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "kyc_provider_id": { "type": "string" }, "last_name": { "type": "string" }, "phone": { "type": "string" }, "public_key": { "type": "string" }, "resident_id": { "type": "string" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/ResidentStatus" }, "subscription_end_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "subscription_plan": { "type": "string" }, "subscription_start_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "user_id": { "type": "string" } }, "required": [ "sid", "resident_id", "user_id", "email", "first_name", "last_name", "kyc_provider_id", "phone", "status", "keypair_version", "auto_renewal", "created_at", "updated_at" ], "title": "DigitalResident", "type": "object" }, "DirectorData": { "properties": { "appointed_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "position": { "type": "string" }, "resident_id": { "type": "string" } }, "required": [ "resident_id", "position" ], "title": "DirectorData", "type": "object" }, "DividendDetailResult": { "properties": { "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "distribution_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "dividend_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/DividendStatus" }, "total_amount": { "type": "number" } }, "required": [ "dividend_id", "company_id", "total_amount", "currency", "distribution_date", "status", "created_at" ], "title": "DividendDetailResult", "type": "object" }, "DividendDistribution": { "description": "Dividend distribution [rootobject]", "properties": { "approved_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "company_id": { "type": "string" }, "completed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "distribution_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "initiated_by": { "type": "string" }, "proposal_id": { "type": "string" }, "requires_vote": { "type": "boolean" }, "sid": { "type": "string" }, "source_account_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/DividendStatus" }, "total_amount": { "type": "number" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "company_id", "total_amount", "currency", "source_account_id", "distribution_date", "status", "requires_vote", "initiated_by", "created_at", "updated_at" ], "title": "DividendDistribution", "type": "object" }, "DividendDistributionListResult": { "properties": { "distributions": { "items": { "$ref": "#/components/schemas/DividendDistribution" }, "type": "array" } }, "required": [ "distributions" ], "title": "DividendDistributionListResult", "type": "object" }, "DividendDistributionResult": { "description": "Treasury operations types (aliases for generator compatibility)", "properties": { "distribution": { "$ref": "#/components/schemas/DividendDistribution" } }, "required": [ "distribution" ], "title": "DividendDistributionResult", "type": "object" }, "DividendListResult": { "properties": { "dividends": { "items": { "$ref": "#/components/schemas/DividendDetailResult" }, "type": "array" } }, "required": [ "dividends" ], "title": "DividendListResult", "type": "object" }, "DividendPayment": { "description": "Individual dividend payment [rootobject]", "properties": { "amount": { "type": "number" }, "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "destination_account_id": { "type": "string" }, "distribution_id": { "type": "string" }, "ownership_percentage": { "type": "number" }, "paid_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "recipient_id": { "type": "string" }, "sid": { "type": "string" }, "transaction_id": { "type": "string" } }, "required": [ "sid", "distribution_id", "company_id", "recipient_id", "ownership_percentage", "amount", "currency", "created_at" ], "title": "DividendPayment", "type": "object" }, "DividendPaymentListResult": { "properties": { "payments": { "items": { "$ref": "#/components/schemas/DividendPayment" }, "type": "array" } }, "required": [ "payments" ], "title": "DividendPaymentListResult", "type": "object" }, "DividendPaymentResult": { "properties": { "payment": { "$ref": "#/components/schemas/DividendPayment" } }, "required": [ "payment" ], "title": "DividendPaymentResult", "type": "object" }, "DividendResult": { "properties": { "dividend_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/DividendStatus" } }, "required": [ "dividend_id", "status" ], "title": "DividendResult", "type": "object" }, "DividendStatus": { "description": "Dividend distribution status", "enum": [ "proposed", "approved", "processing", "completed", "cancelled" ], "title": "DividendStatus", "type": "string" }, "DocumentType": { "description": "Document types for signing", "enum": [ "contract", "agreement", "invoice", "certificate", "other" ], "title": "DocumentType", "type": "string" }, "EmailError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "EmailError", "type": "object" }, "EmailVerificationToken": { "description": "Email verification token [rootobject]", "properties": { "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "sid": { "type": "string" }, "token": { "type": "string" }, "used": { "type": "boolean" }, "user_id": { "type": "string" } }, "required": [ "sid", "user_id", "token", "expires_at", "used", "created_at" ], "title": "EmailVerificationToken", "type": "object" }, "EntityType": { "description": "═══════════════════════════════════════════════════════════════════════════════ ZANZIBAR DIGITAL FREEZONE - OSIS Schema v2.0 ═══════════════════════════════════════════════════════════════════════════════ A complete schema-driven system for digital residency and company management. Features: - Type-safe enums for all categorical data - Full-text search on relevant fields - Declarative business rules - Cryptographic identity with key versioning ═══════════════════════════════════════════════════════════════════════════════ ─────────────────────────────────────────────────────────────────────────────── ENUMS - Type-safe categorical values ─────────────────────────────────────────────────────────────────────────────── Entity type for polymorphic references (resident or company)", "enum": [ "resident", "company" ], "title": "EntityType", "type": "string" }, "ExchangeDetailResult": { "properties": { "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "exchange_id": { "type": "string" }, "exchange_rate": { "type": "number" }, "from_amount": { "type": "number" }, "from_currency": { "type": "string" }, "status": { "$ref": "#/components/schemas/ExchangeStatus" }, "to_amount": { "type": "number" }, "to_currency": { "type": "string" } }, "required": [ "exchange_id", "from_amount", "from_currency", "to_amount", "to_currency", "exchange_rate", "status", "created_at" ], "title": "ExchangeDetailResult", "type": "object" }, "ExchangeListResult": { "properties": { "exchanges": { "items": { "$ref": "#/components/schemas/ExchangeDetailResult" }, "type": "array" } }, "required": [ "exchanges" ], "title": "ExchangeListResult", "type": "object" }, "ExchangeQuoteResult": { "properties": { "exchange_rate": { "type": "number" }, "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "fee_amount": { "type": "number" }, "fee_percentage": { "type": "number" }, "from_amount": { "type": "number" }, "from_currency": { "type": "string" }, "to_amount": { "type": "number" }, "to_currency": { "type": "string" } }, "required": [ "from_currency", "to_currency", "from_amount", "to_amount", "exchange_rate", "fee_percentage", "fee_amount", "expires_at" ], "title": "ExchangeQuoteResult", "type": "object" }, "ExchangeResult": { "properties": { "exchange_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/ExchangeStatus" } }, "required": [ "exchange_id", "status" ], "title": "ExchangeResult", "type": "object" }, "ExchangeStatus": { "description": "Exchange transaction status", "enum": [ "pending", "processing", "completed", "failed", "expired" ], "title": "ExchangeStatus", "type": "string" }, "ExchangeTransaction": { "description": "Crypto exchange transaction [rootobject]", "properties": { "completed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "exchange_rate": { "type": "number" }, "fee_amount": { "type": "number" }, "fee_percentage": { "type": "number" }, "from_account_id": { "type": "string" }, "from_amount": { "type": "number" }, "from_currency": { "type": "string" }, "initiated_by": { "type": "string" }, "owner_id": { "type": "string" }, "owner_type": { "$ref": "#/components/schemas/EntityType" }, "rate_expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/ExchangeStatus" }, "to_account_id": { "type": "string" }, "to_amount": { "type": "number" }, "to_currency": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "owner_type", "owner_id", "from_account_id", "to_account_id", "from_amount", "from_currency", "to_amount", "to_currency", "exchange_rate", "fee_percentage", "fee_amount", "status", "rate_expires_at", "initiated_by", "created_at", "updated_at" ], "title": "ExchangeTransaction", "type": "object" }, "ExchangeTransactionListResult": { "properties": { "exchanges": { "items": { "$ref": "#/components/schemas/ExchangeTransaction" }, "type": "array" } }, "required": [ "exchanges" ], "title": "ExchangeTransactionListResult", "type": "object" }, "ExchangeTransactionResult": { "properties": { "exchange": { "$ref": "#/components/schemas/ExchangeTransaction" } }, "required": [ "exchange" ], "title": "ExchangeTransactionResult", "type": "object" }, "ExpenseResult": { "properties": { "expense": { "$ref": "#/components/schemas/FreeZoneExpense" } }, "required": [ "expense" ], "title": "ExpenseResult", "type": "object" }, "ExpenseStatus": { "description": "Expense status", "enum": [ "draft", "submitted", "approved", "rejected" ], "title": "ExpenseStatus", "type": "string" }, "ExpensesListResult": { "description": "Expense service types", "properties": { "expenses": { "items": { "$ref": "#/components/schemas/FreeZoneExpense" }, "type": "array" } }, "required": [ "expenses" ], "title": "ExpensesListResult", "type": "object" }, "FeeBreakdown": { "description": "─────────────────────────────────────────────────────────────────────────────── PRICING TYPES - Company pricing and subscription ─────────────────────────────────────────────────────────────────────────────── Fee breakdown for a single fee component", "properties": { "base": { "type": "number" }, "discount": { "type": "number" }, "discount_label": { "type": "string" }, "final": { "type": "number" }, "months": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "subtotal": { "type": "number" } }, "required": [ "base", "months", "quantity", "subtotal", "discount", "discount_label", "final" ], "title": "FeeBreakdown", "type": "object" }, "FinancialReport": { "description": "─────────────────────────────────────────────────────────────────────────────── FINANCIAL REPORTS ─────────────────────────────────────────────────────────────────────────────── Generated financial report [rootobject]", "properties": { "as_of_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "company_id": { "type": "string" }, "content": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "generated_by": { "type": "string" }, "period_end": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "period_start": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "report_type": { "$ref": "#/components/schemas/FinancialReportType" }, "sid": { "type": "string" }, "title": { "type": "string" } }, "required": [ "sid", "company_id", "report_type", "title", "content", "generated_by", "created_at" ], "title": "FinancialReport", "type": "object" }, "FinancialReportDetailResult": { "properties": { "as_of_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "company_id": { "type": "string" }, "content": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "period_end": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "period_start": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "report_id": { "type": "string" }, "report_type": { "$ref": "#/components/schemas/FinancialReportType" }, "title": { "type": "string" } }, "required": [ "report_id", "company_id", "report_type", "title", "content", "created_at" ], "title": "FinancialReportDetailResult", "type": "object" }, "FinancialReportListResult": { "properties": { "reports": { "items": { "$ref": "#/components/schemas/FinancialReportDetailResult" }, "type": "array" } }, "required": [ "reports" ], "title": "FinancialReportListResult", "type": "object" }, "FinancialReportResult": { "description": "Report service types", "properties": { "report_id": { "type": "string" }, "report_type": { "$ref": "#/components/schemas/FinancialReportType" } }, "required": [ "report_id", "report_type" ], "title": "FinancialReportResult", "type": "object" }, "FinancialReportType": { "description": "Financial report type", "enum": [ "balance_sheet", "income_statement", "cash_flow", "trial_balance" ], "title": "FinancialReportType", "type": "string" }, "FreeZoneCompany": { "description": "Free Zone Company entity [rootobject]", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "auto_renewal": { "type": "boolean" }, "company_id": { "type": "string" }, "company_type": { "$ref": "#/components/schemas/CompanyType" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "crypto_wallets": { "items": { "$ref": "#/components/schemas/CryptoWallet" }, "type": "array" }, "description": { "type": "string" }, "early_bird_applied": { "type": "boolean" }, "email": { "type": "string" }, "encrypted_private_key": { "type": "string" }, "industry": { "type": "string" }, "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "monthly_fee_rate": { "type": "number" }, "name": { "type": "string" }, "phone": { "type": "string" }, "prepaid_discount_applied": { "type": "number" }, "public_key": { "type": "string" }, "registration_number": { "type": "string" }, "setup_fee_paid": { "type": "number" }, "shareholder_fee_rate": { "type": "number" }, "shareholders": { "items": { "$ref": "#/components/schemas/ShareholderData" }, "type": "array" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/CompanyStatus" }, "subscription_end_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "subscription_plan": { "$ref": "#/components/schemas/CompanySubscriptionPlan" }, "subscription_start_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "tax_id": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "user_id": { "type": "string" }, "voting_model": { "$ref": "#/components/schemas/VotingModel" }, "website": { "type": "string" } }, "required": [ "sid", "company_id", "user_id", "name", "company_type", "voting_model", "description", "registration_number", "tax_id", "address", "shareholders", "crypto_wallets", "status", "keypair_version", "auto_renewal", "setup_fee_paid", "monthly_fee_rate", "shareholder_fee_rate", "prepaid_discount_applied", "early_bird_applied", "created_at", "updated_at" ], "title": "FreeZoneCompany", "type": "object" }, "FreeZoneExpense": { "description": "Free Zone Expense entity [rootobject]", "properties": { "amount": { "type": "number" }, "category": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "expense_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "fzc_id": { "type": "string" }, "receipt_number": { "type": "string" }, "receipt_url": { "type": "string" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/ExpenseStatus" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "vendor_name": { "type": "string" } }, "required": [ "sid", "fzc_id", "receipt_number", "vendor_name", "description", "amount", "currency", "category", "expense_date", "status", "created_at", "updated_at" ], "title": "FreeZoneExpense", "type": "object" }, "FreeZoneInvoice": { "description": "Free Zone Invoice entity [rootobject]", "properties": { "amount": { "type": "number" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "due_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "fzc_id": { "type": "string" }, "invoice_number": { "type": "string" }, "issue_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "line_items": { "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array" }, "reseller_invoice_id": { "type": "string" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/InvoiceStatus" }, "tax_amount": { "type": "number" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "fzc_id", "reseller_invoice_id", "invoice_number", "amount", "currency", "tax_amount", "description", "line_items", "issue_date", "due_date", "status", "created_at", "updated_at" ], "title": "FreeZoneInvoice", "type": "object" }, "FundTransfer": { "description": "─────────────────────────────────────────────────────────────────────────────── TREASURY OPERATIONS ─────────────────────────────────────────────────────────────────────────────── Fund transfer between accounts [rootobject]", "properties": { "amount": { "type": "number" }, "approval_threshold": { "type": "number" }, "approved_by": { "type": "string" }, "completed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "fee_amount": { "type": "number" }, "from_account_id": { "type": "string" }, "initiated_by": { "type": "string" }, "reference": { "type": "string" }, "requires_approval": { "type": "boolean" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/FundTransferStatus" }, "to_account_id": { "type": "string" }, "to_external_address": { "type": "string" }, "to_external_name": { "type": "string" }, "transaction_id": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "from_account_id", "amount", "currency", "status", "requires_approval", "approval_threshold", "initiated_by", "created_at", "updated_at" ], "title": "FundTransfer", "type": "object" }, "FundTransferDetailResult": { "properties": { "amount": { "type": "number" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "from_account_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/FundTransferStatus" }, "to_account_id": { "type": "string" }, "to_external_address": { "type": "string" }, "transfer_id": { "type": "string" } }, "required": [ "transfer_id", "from_account_id", "amount", "currency", "status", "created_at" ], "title": "FundTransferDetailResult", "type": "object" }, "FundTransferListResult": { "properties": { "transfers": { "items": { "$ref": "#/components/schemas/FundTransferDetailResult" }, "type": "array" } }, "required": [ "transfers" ], "title": "FundTransferListResult", "type": "object" }, "FundTransferResult": { "description": "Treasury operations service types", "properties": { "status": { "$ref": "#/components/schemas/FundTransferStatus" }, "transfer_id": { "type": "string" } }, "required": [ "transfer_id", "status" ], "title": "FundTransferResult", "type": "object" }, "FundTransferStatus": { "description": "Fund transfer status", "enum": [ "pending", "processing", "completed", "failed", "cancelled" ], "title": "FundTransferStatus", "type": "string" }, "GovernanceError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "GovernanceError", "type": "object" }, "IdenfyDocumentData": { "description": "iDenfy document data extracted from verification", "properties": { "doc_dob": { "type": "string" }, "doc_expiry": { "type": "string" }, "doc_first_name": { "type": "string" }, "doc_last_name": { "type": "string" }, "doc_nationality": { "type": "string" }, "doc_number": { "type": "string" }, "doc_type": { "type": "string" } }, "title": "IdenfyDocumentData", "type": "object" }, "IdenfyWebhookData": { "properties": { "client_id": { "type": "string" }, "data": { "$ref": "#/components/schemas/IdenfyDocumentData" }, "scan_ref": { "type": "string" }, "status": { "$ref": "#/components/schemas/IdenfyWebhookStatus" } }, "required": [ "client_id", "scan_ref", "status" ], "title": "IdenfyWebhookData", "type": "object" }, "IdenfyWebhookStatus": { "description": "iDenfy webhook status", "properties": { "auto_document": { "type": "string" }, "auto_face": { "type": "string" }, "manual_document": { "type": "string" }, "manual_face": { "type": "string" }, "overall": { "type": "string" } }, "required": [ "overall" ], "title": "IdenfyWebhookStatus", "type": "object" }, "IndividualVerificationResult": { "description": "Verification service types", "properties": { "has_full_access": { "type": "boolean" }, "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "member_since": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "name": { "type": "string" }, "public_key": { "type": "string" }, "resident_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/ResidentStatus" }, "valid": { "type": "boolean" }, "verified_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "verified_by": { "type": "string" } }, "required": [ "valid", "resident_id", "status", "verified_at", "has_full_access" ], "title": "IndividualVerificationResult", "type": "object" }, "InviteDetailResult": { "properties": { "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "invite_id": { "type": "string" }, "invitee_email": { "type": "string" }, "proposed_percentage": { "type": "number" }, "status": { "$ref": "#/components/schemas/ShareholderInviteStatus" } }, "required": [ "invite_id", "company_id", "invitee_email", "proposed_percentage", "status", "expires_at", "created_at" ], "title": "InviteDetailResult", "type": "object" }, "InviteListResult": { "properties": { "invites": { "items": { "$ref": "#/components/schemas/InviteDetailResult" }, "type": "array" } }, "required": [ "invites" ], "title": "InviteListResult", "type": "object" }, "InviteResult": { "description": "Shareholder service types", "properties": { "invite_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/ShareholderInviteStatus" }, "token": { "type": "string" } }, "required": [ "invite_id", "token", "status" ], "title": "InviteResult", "type": "object" }, "InvoiceCreateData": { "description": "Invoice service types", "properties": { "client_email": { "type": "string" }, "client_name": { "type": "string" }, "due_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/InvoiceLineItem" }, "type": "array" }, "notes": { "type": "string" } }, "required": [ "client_name", "client_email", "items", "due_date" ], "title": "InvoiceCreateData", "type": "object" }, "InvoiceError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "InvoiceError", "type": "object" }, "InvoiceLineItem": { "description": "Invoice line item for creating invoices", "properties": { "description": { "type": "string" }, "quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "tax_rate": { "type": "number" }, "unit_price": { "type": "number" } }, "required": [ "description", "quantity", "unit_price" ], "title": "InvoiceLineItem", "type": "object" }, "InvoiceResult": { "properties": { "invoice": { "$ref": "#/components/schemas/FreeZoneInvoice" } }, "required": [ "invoice" ], "title": "InvoiceResult", "type": "object" }, "InvoiceStatus": { "description": "Invoice status", "enum": [ "draft", "sent", "paid", "overdue", "cancelled" ], "title": "InvoiceStatus", "type": "string" }, "InvoiceTotalsResult": { "properties": { "currency": { "type": "string" }, "subtotal": { "type": "number" }, "tax": { "type": "number" }, "total": { "type": "number" } }, "required": [ "subtotal", "tax", "total", "currency" ], "title": "InvoiceTotalsResult", "type": "object" }, "InvoiceUpdateData": { "properties": { "client_email": { "type": "string" }, "client_name": { "type": "string" }, "due_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "notes": { "type": "string" }, "status": { "$ref": "#/components/schemas/InvoiceStatus" } }, "title": "InvoiceUpdateData", "type": "object" }, "InvoicesListResult": { "description": "Invoice service types", "properties": { "invoices": { "items": { "$ref": "#/components/schemas/FreeZoneInvoice" }, "type": "array" } }, "required": [ "invoices" ], "title": "InvoicesListResult", "type": "object" }, "KeyStatusResult": { "properties": { "has_keypair": { "type": "boolean" }, "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "public_key": { "type": "string" } }, "required": [ "has_keypair" ], "title": "KeyStatusResult", "type": "object" }, "KeypairError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "KeypairError", "type": "object" }, "KeypairResult": { "description": "Keypair service types", "properties": { "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "public_key": { "type": "string" } }, "required": [ "public_key", "keypair_version" ], "title": "KeypairResult", "type": "object" }, "KycCompleteResult": { "properties": { "complete": { "type": "boolean" }, "verified_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "complete" ], "title": "KycCompleteResult", "type": "object" }, "KycConfirmData": { "properties": { "document_verified": { "type": "boolean" }, "identity_verified": { "type": "boolean" }, "liveness_verified": { "type": "boolean" }, "verification_level": { "type": "string" } }, "required": [ "identity_verified", "document_verified", "liveness_verified", "verification_level" ], "title": "KycConfirmData", "type": "object" }, "KycConfirmResult": { "properties": { "resident_activated": { "type": "boolean" }, "success": { "type": "boolean" } }, "required": [ "success", "resident_activated" ], "title": "KycConfirmResult", "type": "object" }, "KycError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "KycError", "type": "object" }, "KycSession": { "description": "KYC Session entity [rootobject]", "properties": { "callback_url": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "document_verified": { "type": "boolean" }, "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "idenfy_scan_ref": { "type": "string" }, "identity_verified": { "type": "boolean" }, "kyc_url": { "type": "string" }, "liveness_verified": { "type": "boolean" }, "public_key": { "type": "string" }, "resident_id": { "type": "string" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/KycStatus" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "user_id": { "type": "string" }, "verification_level": { "type": "string" }, "verified_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "user_id", "resident_id", "public_key", "kyc_url", "status", "identity_verified", "document_verified", "liveness_verified", "expires_at", "created_at", "updated_at" ], "title": "KycSession", "type": "object" }, "KycSessionResult": { "description": "KYC service types", "properties": { "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "kyc_url": { "type": "string" }, "session_id": { "type": "string" } }, "required": [ "kyc_url", "session_id", "expires_at" ], "title": "KycSessionResult", "type": "object" }, "KycStatus": { "description": "KYC verification status", "enum": [ "pending", "in_progress", "completed", "failed", "expired" ], "title": "KycStatus", "type": "string" }, "KycStatusResult": { "properties": { "session_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/KycStatus" }, "verification_data": { "$ref": "#/components/schemas/KycVerificationData" }, "verified_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "session_id", "status" ], "title": "KycStatusResult", "type": "object" }, "KycUserStatusResult": { "description": "KYC service types", "properties": { "status": { "$ref": "#/components/schemas/KycStatus" }, "user_id": { "type": "string" }, "verified": { "type": "boolean" }, "verified_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "user_id", "status", "verified" ], "title": "KycUserStatusResult", "type": "object" }, "KycVerificationData": { "description": "KYC verification data", "properties": { "document_verified": { "type": "boolean" }, "identity_verified": { "type": "boolean" }, "liveness_verified": { "type": "boolean" }, "verification_level": { "type": "string" } }, "required": [ "identity_verified", "document_verified", "liveness_verified", "verification_level" ], "title": "KycVerificationData", "type": "object" }, "LineItem": { "description": "Invoice line item", "properties": { "amount": { "type": "number" }, "description": { "type": "string" }, "quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "unit_price": { "type": "number" } }, "required": [ "description", "quantity", "unit_price", "amount" ], "title": "LineItem", "type": "object" }, "LinkError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "LinkError", "type": "object" }, "LoginResult": { "properties": { "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "refresh_token": { "type": "string" }, "token": { "type": "string" }, "user_id": { "type": "string" } }, "required": [ "token", "refresh_token", "user_id", "expires_at" ], "title": "LoginResult", "type": "object" }, "LogoutResult": { "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "title": "LogoutResult", "type": "object" }, "MarkAllReadResult": { "description": "Message service types", "properties": { "count": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, "required": [ "count" ], "title": "MarkAllReadResult", "type": "object" }, "MarkReadResult": { "properties": { "marked_count": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "success": { "type": "boolean" } }, "required": [ "success", "marked_count" ], "title": "MarkReadResult", "type": "object" }, "MessageCategory": { "description": "Message categories", "enum": [ "account", "registration", "security", "kyc", "payment", "company", "resident", "general" ], "title": "MessageCategory", "type": "string" }, "MessageError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "MessageError", "type": "object" }, "MessageResult": { "properties": { "message": { "$ref": "#/components/schemas/UserMessage" } }, "required": [ "message" ], "title": "MessageResult", "type": "object" }, "MessageType": { "description": "Message types", "enum": [ "system", "notification", "alert" ], "title": "MessageType", "type": "string" }, "MessagesListResult": { "description": "Message service types", "properties": { "messages": { "items": { "$ref": "#/components/schemas/UserMessage" }, "type": "array" } }, "required": [ "messages" ], "title": "MessagesListResult", "type": "object" }, "Payment": { "description": "Payment entity for crypto/ClickPesa [rootobject]", "properties": { "amount": { "type": "number" }, "auto_renewal": { "type": "boolean" }, "clickpesa_order_id": { "type": "string" }, "confirmation_count": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "confirmed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "crypto_amount": { "type": "string" }, "currency": { "type": "string" }, "entity_id": { "type": "string" }, "entity_type": { "$ref": "#/components/schemas/EntityType" }, "exchange_rate": { "type": "string" }, "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "external_id": { "type": "string" }, "payment_purpose": { "type": "string" }, "payment_type": { "$ref": "#/components/schemas/PaymentType" }, "sender_address": { "type": "string" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/PaymentStatus" }, "subscription_plan": { "type": "string" }, "transaction_hash": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "user_id": { "type": "string" }, "wallet_address": { "type": "string" } }, "required": [ "sid", "user_id", "entity_id", "entity_type", "payment_type", "amount", "currency", "external_id", "payment_purpose", "auto_renewal", "status", "expires_at", "created_at", "updated_at" ], "title": "Payment", "type": "object" }, "PaymentCompleteResult": { "properties": { "complete": { "type": "boolean" }, "payment_id": { "type": "string" } }, "required": [ "complete" ], "title": "PaymentCompleteResult", "type": "object" }, "PaymentConfirmResult": { "properties": { "amount_received": { "type": "number" }, "confirmation_count": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "confirmed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "payment_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/PaymentStatus" }, "transaction_hash": { "type": "string" } }, "required": [ "payment_id", "status" ], "title": "PaymentConfirmResult", "type": "object" }, "PaymentCreateData": { "description": "Payment service types", "properties": { "amount": { "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "payment_method": { "$ref": "#/components/schemas/PaymentMethod" } }, "required": [ "amount", "currency", "payment_method" ], "title": "PaymentCreateData", "type": "object" }, "PaymentError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "PaymentError", "type": "object" }, "PaymentInvoiceResult": { "properties": { "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "invoice_id": { "type": "string" }, "payment_url": { "type": "string" } }, "required": [ "invoice_id", "payment_url", "expires_at" ], "title": "PaymentInvoiceResult", "type": "object" }, "PaymentMethod": { "description": "Payment method enum", "enum": [ "crypto", "clickpesa", "bank_transfer", "card" ], "title": "PaymentMethod", "type": "string" }, "PaymentResult": { "properties": { "payment": { "$ref": "#/components/schemas/Payment" } }, "required": [ "payment" ], "title": "PaymentResult", "type": "object" }, "PaymentStatus": { "description": "Payment status", "enum": [ "pending", "confirming", "confirmed", "failed", "expired" ], "title": "PaymentStatus", "type": "string" }, "PaymentType": { "description": "Payment types", "enum": [ "bitcoin", "ethereum", "clickpesa" ], "title": "PaymentType", "type": "string" }, "PaymentVerifyResult": { "properties": { "status": { "$ref": "#/components/schemas/PaymentStatus" }, "verified": { "type": "boolean" } }, "required": [ "verified", "status" ], "title": "PaymentVerifyResult", "type": "object" }, "PaymentWalletResult": { "description": "Payment service types", "properties": { "amount": { "type": "number" }, "crypto_amount": { "type": "string" }, "currency": { "type": "string" }, "exchange_rate": { "type": "string" }, "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "external_id": { "type": "string" }, "payment_id": { "type": "string" }, "payment_type": { "$ref": "#/components/schemas/PaymentType" }, "wallet_address": { "type": "string" } }, "required": [ "wallet_address", "payment_type", "amount", "currency", "crypto_amount", "exchange_rate", "payment_id", "expires_at", "external_id" ], "title": "PaymentWalletResult", "type": "object" }, "PaymentsListResult": { "properties": { "payments": { "items": { "$ref": "#/components/schemas/Payment" }, "type": "array" } }, "required": [ "payments" ], "title": "PaymentsListResult", "type": "object" }, "PricingBreakdown": { "description": "Complete pricing breakdown for company registration", "properties": { "company_type": { "$ref": "#/components/schemas/CompanyType" }, "early_bird": { "type": "boolean" }, "effective_monthly": { "type": "number" }, "monthly_fee": { "$ref": "#/components/schemas/FeeBreakdown" }, "setup_fee": { "$ref": "#/components/schemas/FeeBreakdown" }, "shareholder_count": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "shareholder_fee": { "$ref": "#/components/schemas/FeeBreakdown" }, "subscription_plan": { "$ref": "#/components/schemas/CompanySubscriptionPlan" }, "total": { "type": "number" } }, "required": [ "company_type", "subscription_plan", "shareholder_count", "early_bird", "setup_fee", "monthly_fee", "total", "effective_monthly" ], "title": "PricingBreakdown", "type": "object" }, "PricingError": { "description": "Pricing error", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "PricingError", "type": "object" }, "PricingItem": { "properties": { "item_type": { "type": "string" }, "quantity": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "unit_price": { "type": "number" } }, "required": [ "item_type", "quantity", "unit_price" ], "title": "PricingItem", "type": "object" }, "PricingPlan": { "properties": { "currency": { "type": "string" }, "features": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "price": { "type": "number" } }, "required": [ "name", "price", "currency", "features" ], "title": "PricingPlan", "type": "object" }, "PricingPlansResult": { "description": "Pricing service types", "properties": { "plans": { "items": { "$ref": "#/components/schemas/PricingPlan" }, "type": "array" } }, "required": [ "plans" ], "title": "PricingPlansResult", "type": "object" }, "PricingResult": { "description": "Pricing calculation result", "properties": { "breakdown": { "$ref": "#/components/schemas/PricingBreakdown" } }, "required": [ "breakdown" ], "title": "PricingResult", "type": "object" }, "PricingTotalResult": { "properties": { "currency": { "type": "string" }, "subtotal": { "type": "number" }, "tax": { "type": "number" }, "total": { "type": "number" } }, "required": [ "subtotal", "tax", "total", "currency" ], "title": "PricingTotalResult", "type": "object" }, "PrivateKeyResult": { "properties": { "private_key": { "type": "string" } }, "required": [ "private_key" ], "title": "PrivateKeyResult", "type": "object" }, "Proposal": { "description": "─────────────────────────────────────────────────────────────────────────────── GOVERNANCE & VOTING ─────────────────────────────────────────────────────────────────────────────── Governance proposal [rootobject]", "properties": { "allow_abstention": { "type": "boolean" }, "category": { "$ref": "#/components/schemas/ProposalCategory" }, "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "description": { "type": "string" }, "passing_threshold": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "proposer_id": { "type": "string" }, "quorum_percentage": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "resolution_id": { "type": "string" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/ProposalStatus" }, "title": { "type": "string" }, "total_voted": { "type": "number" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "votes_abstain": { "type": "number" }, "votes_against": { "type": "number" }, "votes_for": { "type": "number" }, "voting_ends_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "voting_starts_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "company_id", "title", "description", "category", "status", "proposer_id", "voting_starts_at", "voting_ends_at", "quorum_percentage", "passing_threshold", "allow_abstention", "votes_for", "votes_against", "votes_abstain", "total_voted", "created_at", "updated_at" ], "title": "Proposal", "type": "object" }, "ProposalCategory": { "description": "Proposal category", "enum": [ "financial", "strategic", "operational", "governance", "personnel" ], "title": "ProposalCategory", "type": "string" }, "ProposalDetailResult": { "properties": { "category": { "$ref": "#/components/schemas/ProposalCategory" }, "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "description": { "type": "string" }, "passing_threshold": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "proposal_id": { "type": "string" }, "proposer_id": { "type": "string" }, "quorum_percentage": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "quorum_reached": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/ProposalStatus" }, "title": { "type": "string" }, "total_voted": { "type": "number" }, "votes_abstain": { "type": "number" }, "votes_against": { "type": "number" }, "votes_for": { "type": "number" }, "voting_ends_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "voting_starts_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "proposal_id", "company_id", "title", "description", "category", "status", "proposer_id", "voting_starts_at", "voting_ends_at", "quorum_percentage", "passing_threshold", "votes_for", "votes_against", "votes_abstain", "total_voted", "quorum_reached", "created_at" ], "title": "ProposalDetailResult", "type": "object" }, "ProposalListResult": { "properties": { "proposals": { "items": { "$ref": "#/components/schemas/ProposalDetailResult" }, "type": "array" } }, "required": [ "proposals" ], "title": "ProposalListResult", "type": "object" }, "ProposalResult": { "description": "Governance service types", "properties": { "proposal_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/ProposalStatus" } }, "required": [ "proposal_id", "status" ], "title": "ProposalResult", "type": "object" }, "ProposalStatus": { "description": "Proposal status", "enum": [ "draft", "active", "passed", "rejected", "expired", "executed" ], "title": "ProposalStatus", "type": "string" }, "PublicKeyHistory": { "description": "Historical public key for signature verification [rootobject]", "properties": { "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "entity_id": { "type": "string" }, "entity_type": { "$ref": "#/components/schemas/EntityType" }, "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "public_key": { "type": "string" }, "sid": { "type": "string" }, "user_id": { "type": "string" }, "valid_from": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "valid_until": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "user_id", "entity_type", "entity_id", "public_key", "keypair_version", "valid_from", "valid_until", "created_at" ], "title": "PublicKeyHistory", "type": "object" }, "PublicKeyHistoryListResult": { "description": "Public key history types", "properties": { "history": { "items": { "$ref": "#/components/schemas/PublicKeyHistory" }, "type": "array" } }, "required": [ "history" ], "title": "PublicKeyHistoryListResult", "type": "object" }, "PublicKeyHistoryResult": { "description": "Public key history types", "properties": { "current_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "keys": { "items": { "$ref": "#/components/schemas/PublicKeyHistory" }, "type": "array" } }, "required": [ "keys", "current_version" ], "title": "PublicKeyHistoryResult", "type": "object" }, "RefreshResult": { "properties": { "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "refresh_token": { "type": "string" }, "token": { "type": "string" } }, "required": [ "token", "refresh_token", "expires_at" ], "title": "RefreshResult", "type": "object" }, "RegisterResult": { "description": "Auth service types", "properties": { "email": { "type": "string" }, "user_id": { "type": "string" }, "verification_sent": { "type": "boolean" } }, "required": [ "user_id", "email", "verification_sent" ], "title": "RegisterResult", "type": "object" }, "RegistrationContract": { "description": "Registration Contract entity [rootobject] Note: category_str is indexed for Tantivy search; category enum provides type safety", "properties": { "category": { "$ref": "#/components/schemas/RegistrationContractCategory" }, "category_str": { "type": "string" }, "content": { "type": "string" }, "content_hash": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "name": { "type": "string" }, "required": { "type": "boolean" }, "sid": { "type": "string" }, "version": { "type": "string" } }, "required": [ "sid", "name", "version", "content", "content_hash", "required", "category", "category_str", "created_at" ], "title": "RegistrationContract", "type": "object" }, "RegistrationContractCategory": { "description": "Registration contract categories", "enum": [ "terms_of_service", "privacy_policy", "digital_residency", "company_formation" ], "title": "RegistrationContractCategory", "type": "string" }, "RegistrationContractResult": { "properties": { "contract": { "$ref": "#/components/schemas/RegistrationContract" } }, "required": [ "contract" ], "title": "RegistrationContractResult", "type": "object" }, "RegistrationError": { "description": "─────────────────────────────────────────────────────────────────────────────── ERROR TYPES ───────────────────────────────────────────────────────────────────────────────", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "RegistrationError", "type": "object" }, "RegistrationFlowStatus": { "description": "Registration flow status", "enum": [ "identity_pending", "identity_complete", "personal_info_complete", "payment_pending", "payment_complete", "kyc_pending", "kyc_complete", "registration_complete" ], "title": "RegistrationFlowStatus", "type": "string" }, "RegistrationStatusResult": { "description": "Registration service types", "properties": { "contracts_signed": { "type": "boolean" }, "entity_type": { "$ref": "#/components/schemas/EntityType" }, "kyc_complete": { "type": "boolean" }, "payment_complete": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/RegistrationFlowStatus" }, "user_id": { "type": "string" } }, "required": [ "user_id", "entity_type", "status", "contracts_signed", "payment_complete", "kyc_complete" ], "title": "RegistrationStatusResult", "type": "object" }, "RejectInviteResult": { "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "title": "RejectInviteResult", "type": "object" }, "ReportError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "ReportError", "type": "object" }, "RequiredContractsResult": { "properties": { "contracts": { "items": { "$ref": "#/components/schemas/RegistrationContract" }, "type": "array" }, "entity_type": { "$ref": "#/components/schemas/EntityType" } }, "required": [ "contracts", "entity_type" ], "title": "RequiredContractsResult", "type": "object" }, "ResendResult": { "properties": { "sent": { "type": "boolean" } }, "required": [ "sent" ], "title": "ResendResult", "type": "object" }, "ResetPasswordResult": { "properties": { "sent": { "type": "boolean" } }, "required": [ "sent" ], "title": "ResetPasswordResult", "type": "object" }, "ResidentCardResult": { "properties": { "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "member_since": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "name": { "type": "string" }, "public_key": { "type": "string" }, "resident_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/ResidentStatus" }, "subscription": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "required": [ "resident_id", "name", "status", "member_since" ], "title": "ResidentCardResult", "type": "object" }, "ResidentCreateData": { "description": "Resident service types", "properties": { "date_of_birth": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "nationality": { "type": "string" }, "user_id": { "type": "string" } }, "required": [ "user_id", "first_name", "last_name", "nationality" ], "title": "ResidentCreateData", "type": "object" }, "ResidentError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "ResidentError", "type": "object" }, "ResidentPricingResult": { "properties": { "annual_fee": { "type": "number" }, "currency": { "type": "string" }, "registration_fee": { "type": "number" } }, "required": [ "registration_fee", "annual_fee", "currency" ], "title": "ResidentPricingResult", "type": "object" }, "ResidentResult": { "properties": { "resident": { "$ref": "#/components/schemas/DigitalResident" } }, "required": [ "resident" ], "title": "ResidentResult", "type": "object" }, "ResidentStatus": { "description": "Digital Resident status", "enum": [ "pending", "active", "suspended", "expired" ], "title": "ResidentStatus", "type": "string" }, "ResidentUpdateData": { "properties": { "address": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "nationality": { "type": "string" } }, "title": "ResidentUpdateData", "type": "object" }, "ResidentsListResult": { "description": "Resident service types", "properties": { "page": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "page_size": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "residents": { "items": { "$ref": "#/components/schemas/DigitalResident" }, "type": "array" }, "total": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, "required": [ "residents", "total", "page", "page_size" ], "title": "ResidentsListResult", "type": "object" }, "Resolution": { "description": "Executed resolution from passed proposal [rootobject]", "properties": { "category": { "$ref": "#/components/schemas/ProposalCategory" }, "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "description": { "type": "string" }, "executed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "executed_by": { "type": "string" }, "execution_notes": { "type": "string" }, "passed": { "type": "boolean" }, "proposal_id": { "type": "string" }, "quorum_reached": { "type": "boolean" }, "sid": { "type": "string" }, "title": { "type": "string" }, "votes_abstain": { "type": "number" }, "votes_against": { "type": "number" }, "votes_for": { "type": "number" } }, "required": [ "sid", "company_id", "proposal_id", "title", "description", "category", "votes_for", "votes_against", "votes_abstain", "quorum_reached", "passed", "created_at" ], "title": "Resolution", "type": "object" }, "ResolutionDetailResult": { "properties": { "category": { "$ref": "#/components/schemas/ProposalCategory" }, "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "executed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "passed": { "type": "boolean" }, "proposal_id": { "type": "string" }, "quorum_reached": { "type": "boolean" }, "resolution_id": { "type": "string" }, "title": { "type": "string" }, "votes_against": { "type": "number" }, "votes_for": { "type": "number" } }, "required": [ "resolution_id", "company_id", "proposal_id", "title", "category", "votes_for", "votes_against", "quorum_reached", "passed", "created_at" ], "title": "ResolutionDetailResult", "type": "object" }, "ResolutionListResult": { "properties": { "resolutions": { "items": { "$ref": "#/components/schemas/ResolutionDetailResult" }, "type": "array" } }, "required": [ "resolutions" ], "title": "ResolutionListResult", "type": "object" }, "ResolutionResult": { "properties": { "passed": { "type": "boolean" }, "proposal_id": { "type": "string" }, "resolution_id": { "type": "string" } }, "required": [ "resolution_id", "proposal_id", "passed" ], "title": "ResolutionResult", "type": "object" }, "RevokeKeypairResult": { "description": "Keypair service types", "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ], "title": "RevokeKeypairResult", "type": "object" }, "RevokeLinkResult": { "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ], "title": "RevokeLinkResult", "type": "object" }, "RevokeResult": { "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message" ], "title": "RevokeResult", "type": "object" }, "ShareTransfer": { "description": "Share transfer between shareholders [rootobject]", "properties": { "approved_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "company_id": { "type": "string" }, "completed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "from_resident_id": { "type": "string" }, "from_signature": { "type": "string" }, "percentage": { "type": "number" }, "proposal_id": { "type": "string" }, "reason": { "type": "string" }, "requires_vote": { "type": "boolean" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/ShareTransferStatus" }, "to_resident_id": { "type": "string" }, "to_signature": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "company_id", "from_resident_id", "to_resident_id", "percentage", "status", "requires_vote", "created_at", "updated_at" ], "title": "ShareTransfer", "type": "object" }, "ShareTransferListResult": { "properties": { "transfers": { "items": { "$ref": "#/components/schemas/ShareTransfer" }, "type": "array" } }, "required": [ "transfers" ], "title": "ShareTransferListResult", "type": "object" }, "ShareTransferResult": { "properties": { "transfer": { "$ref": "#/components/schemas/ShareTransfer" } }, "required": [ "transfer" ], "title": "ShareTransferResult", "type": "object" }, "ShareTransferStatus": { "description": "Share transfer status", "enum": [ "pending", "approved", "rejected", "completed", "cancelled" ], "title": "ShareTransferStatus", "type": "string" }, "ShareholderData": { "description": "Shareholder data with ownership percentage", "properties": { "name": { "type": "string" }, "percentage": { "type": "number" }, "resident_id": { "type": "string" } }, "required": [ "resident_id", "name", "percentage" ], "title": "ShareholderData", "type": "object" }, "ShareholderError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "ShareholderError", "type": "object" }, "ShareholderFeeRateResult": { "description": "Shareholder fee rate result", "properties": { "rate": { "type": "number" }, "tier_label": { "type": "string" } }, "required": [ "rate", "tier_label" ], "title": "ShareholderFeeRateResult", "type": "object" }, "ShareholderFeeTier": { "description": "Shareholder fee tier (for tiered pricing)", "properties": { "max_count": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "rate": { "type": "number" } }, "required": [ "max_count", "rate" ], "title": "ShareholderFeeTier", "type": "object" }, "ShareholderInvite": { "description": "─────────────────────────────────────────────────────────────────────────────── SHAREHOLDER MANAGEMENT ─────────────────────────────────────────────────────────────────────────────── Invitation to become shareholder [rootobject]", "properties": { "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "invitee_email": { "type": "string" }, "invitee_resident_id": { "type": "string" }, "inviter_id": { "type": "string" }, "message": { "type": "string" }, "proposed_percentage": { "type": "number" }, "responded_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/ShareholderInviteStatus" }, "token": { "type": "string" } }, "required": [ "sid", "company_id", "inviter_id", "invitee_email", "proposed_percentage", "status", "token", "expires_at", "created_at" ], "title": "ShareholderInvite", "type": "object" }, "ShareholderInviteListResult": { "properties": { "invites": { "items": { "$ref": "#/components/schemas/ShareholderInvite" }, "type": "array" } }, "required": [ "invites" ], "title": "ShareholderInviteListResult", "type": "object" }, "ShareholderInviteResult": { "description": "Shareholder service types (aliases for generator compatibility)", "properties": { "invite": { "$ref": "#/components/schemas/ShareholderInvite" } }, "required": [ "invite" ], "title": "ShareholderInviteResult", "type": "object" }, "ShareholderInviteStatus": { "description": "Shareholder invite status", "enum": [ "pending", "accepted", "rejected", "expired" ], "title": "ShareholderInviteStatus", "type": "string" }, "ShareholderResult": { "properties": { "company_id": { "type": "string" }, "ownership_percentage": { "type": "number" }, "resident_id": { "type": "string" }, "shareholder_id": { "type": "string" } }, "required": [ "shareholder_id", "resident_id", "company_id", "ownership_percentage" ], "title": "ShareholderResult", "type": "object" }, "SignContractResult": { "properties": { "contract_id": { "type": "string" }, "signature": { "type": "string" }, "signature_id": { "type": "string" }, "signed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "signature_id", "contract_id", "signed_at", "signature" ], "title": "SignContractResult", "type": "object" }, "SignError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "SignError", "type": "object" }, "SignResult": { "properties": { "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "signature": { "type": "string" }, "signed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "signer_id": { "type": "string" } }, "required": [ "signature", "signed_at", "signer_id", "keypair_version" ], "title": "SignResult", "type": "object" }, "SignaturesListResult": { "properties": { "signatures": { "items": { "$ref": "#/components/schemas/ContractSignature" }, "type": "array" } }, "required": [ "signatures" ], "title": "SignaturesListResult", "type": "object" }, "SignedDocumentsResult": { "properties": { "documents": { "items": { "$ref": "#/components/schemas/ContractSignature" }, "type": "array" } }, "required": [ "documents" ], "title": "SignedDocumentsResult", "type": "object" }, "SubscriptionInfo": { "description": "Subscription information (computed, returned in auth and resident card)", "properties": { "auto_renewal": { "type": "boolean" }, "days_remaining": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "end_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "plan": { "type": "string" }, "start_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "status": { "$ref": "#/components/schemas/SubscriptionStatus" } }, "required": [ "status", "auto_renewal" ], "title": "SubscriptionInfo", "type": "object" }, "SubscriptionResult": { "properties": { "auto_renewal": { "type": "boolean" }, "plan": { "type": "string" }, "subscription_end_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "plan", "auto_renewal" ], "title": "SubscriptionResult", "type": "object" }, "SubscriptionStatus": { "description": "─────────────────────────────────────────────────────────────────────────────── SUBSCRIPTION TYPES - Resident subscription lifecycle ─────────────────────────────────────────────────────────────────────────────── Subscription status (computed by backend from dates)", "enum": [ "none", "active", "expiring", "suspended" ], "title": "SubscriptionStatus", "type": "string" }, "TallyResult": { "properties": { "passed": { "type": "boolean" }, "proposal_id": { "type": "string" }, "quorum_reached": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/ProposalStatus" }, "total_voted": { "type": "number" }, "votes_abstain": { "type": "number" }, "votes_against": { "type": "number" }, "votes_for": { "type": "number" } }, "required": [ "proposal_id", "votes_for", "votes_against", "votes_abstain", "total_voted", "quorum_reached", "passed", "status" ], "title": "TallyResult", "type": "object" }, "TaxCalculationResult": { "description": "Tax service types", "properties": { "currency": { "type": "string" }, "deductions": { "type": "number" }, "gross_revenue": { "type": "number" }, "tax_due": { "type": "number" }, "tax_rate": { "type": "number" }, "taxable_income": { "type": "number" } }, "required": [ "gross_revenue", "deductions", "taxable_income", "tax_rate", "tax_due", "currency" ], "title": "TaxCalculationResult", "type": "object" }, "TaxDeadlineItem": { "properties": { "due_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "filing_type": { "$ref": "#/components/schemas/TaxFilingPeriod" }, "period_end": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "period_start": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "status": { "type": "string" } }, "required": [ "filing_type", "period_start", "period_end", "due_date", "status" ], "title": "TaxDeadlineItem", "type": "object" }, "TaxDeadlineResult": { "properties": { "deadlines": { "items": { "$ref": "#/components/schemas/TaxDeadlineItem" }, "type": "array" } }, "required": [ "deadlines" ], "title": "TaxDeadlineResult", "type": "object" }, "TaxDocument": { "description": "Tax document [rootobject]", "properties": { "company_id": { "type": "string" }, "content": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "document_type": { "type": "string" }, "file_url": { "type": "string" }, "filing_id": { "type": "string" }, "generated": { "type": "boolean" }, "name": { "type": "string" }, "sid": { "type": "string" } }, "required": [ "sid", "filing_id", "company_id", "document_type", "name", "generated", "created_at" ], "title": "TaxDocument", "type": "object" }, "TaxDocumentDetailResult": { "properties": { "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "document_id": { "type": "string" }, "document_type": { "type": "string" }, "filing_id": { "type": "string" }, "generated": { "type": "boolean" }, "name": { "type": "string" } }, "required": [ "document_id", "filing_id", "document_type", "name", "generated", "created_at" ], "title": "TaxDocumentDetailResult", "type": "object" }, "TaxDocumentListResult": { "properties": { "documents": { "items": { "$ref": "#/components/schemas/TaxDocumentDetailResult" }, "type": "array" } }, "required": [ "documents" ], "title": "TaxDocumentListResult", "type": "object" }, "TaxDocumentResult": { "properties": { "document_id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "document_id", "name" ], "title": "TaxDocumentResult", "type": "object" }, "TaxError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "TaxError", "type": "object" }, "TaxFiling": { "description": "─────────────────────────────────────────────────────────────────────────────── TAX & COMPLIANCE ─────────────────────────────────────────────────────────────────────────────── Tax filing record [rootobject]", "properties": { "company_id": { "type": "string" }, "cost_of_goods_sold": { "type": "number" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "due_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "filing_type": { "$ref": "#/components/schemas/TaxFilingPeriod" }, "gross_profit": { "type": "number" }, "gross_revenue": { "type": "number" }, "net_income": { "type": "number" }, "operating_expenses": { "type": "number" }, "period_end": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "period_start": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "sid": { "type": "string" }, "signature": { "type": "string" }, "status": { "$ref": "#/components/schemas/TaxFilingStatus" }, "submitted_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "submitted_by": { "type": "string" }, "tax_due": { "type": "number" }, "tax_rate": { "type": "number" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "company_id", "filing_type", "period_start", "period_end", "due_date", "status", "gross_revenue", "cost_of_goods_sold", "gross_profit", "operating_expenses", "net_income", "tax_rate", "tax_due", "created_at", "updated_at" ], "title": "TaxFiling", "type": "object" }, "TaxFilingDetailResult": { "properties": { "company_id": { "type": "string" }, "cost_of_goods_sold": { "type": "number" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "due_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "filing_id": { "type": "string" }, "filing_type": { "$ref": "#/components/schemas/TaxFilingPeriod" }, "gross_profit": { "type": "number" }, "gross_revenue": { "type": "number" }, "net_income": { "type": "number" }, "operating_expenses": { "type": "number" }, "period_end": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "period_start": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "status": { "$ref": "#/components/schemas/TaxFilingStatus" }, "tax_due": { "type": "number" }, "tax_rate": { "type": "number" } }, "required": [ "filing_id", "company_id", "filing_type", "period_start", "period_end", "due_date", "status", "gross_revenue", "cost_of_goods_sold", "gross_profit", "operating_expenses", "net_income", "tax_rate", "tax_due", "created_at" ], "title": "TaxFilingDetailResult", "type": "object" }, "TaxFilingListResult": { "properties": { "filings": { "items": { "$ref": "#/components/schemas/TaxFilingDetailResult" }, "type": "array" } }, "required": [ "filings" ], "title": "TaxFilingListResult", "type": "object" }, "TaxFilingPeriod": { "description": "Tax filing period type", "enum": [ "monthly", "quarterly", "annual" ], "title": "TaxFilingPeriod", "type": "string" }, "TaxFilingResult": { "description": "Tax service types", "properties": { "filing_id": { "type": "string" }, "status": { "$ref": "#/components/schemas/TaxFilingStatus" } }, "required": [ "filing_id", "status" ], "title": "TaxFilingResult", "type": "object" }, "TaxFilingStatus": { "description": "Tax filing status", "enum": [ "draft", "submitted", "accepted", "rejected", "amended" ], "title": "TaxFilingStatus", "type": "string" }, "TemplateResult": { "properties": { "template": { "$ref": "#/components/schemas/ContractTemplate" } }, "required": [ "template" ], "title": "TemplateResult", "type": "object" }, "TemplatesListResult": { "properties": { "templates": { "items": { "$ref": "#/components/schemas/ContractTemplate" }, "type": "array" } }, "required": [ "templates" ], "title": "TemplatesListResult", "type": "object" }, "TransactionResult": { "properties": { "transaction": { "$ref": "#/components/schemas/TreasuryTransaction" } }, "required": [ "transaction" ], "title": "TransactionResult", "type": "object" }, "TransactionsListResult": { "properties": { "transactions": { "items": { "$ref": "#/components/schemas/TreasuryTransaction" }, "type": "array" } }, "required": [ "transactions" ], "title": "TransactionsListResult", "type": "object" }, "TransferDetailResult": { "properties": { "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "from_resident_id": { "type": "string" }, "percentage": { "type": "number" }, "requires_vote": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/ShareTransferStatus" }, "to_resident_id": { "type": "string" }, "transfer_id": { "type": "string" } }, "required": [ "transfer_id", "company_id", "from_resident_id", "to_resident_id", "percentage", "status", "requires_vote", "created_at" ], "title": "TransferDetailResult", "type": "object" }, "TransferListResult": { "properties": { "transfers": { "items": { "$ref": "#/components/schemas/TransferDetailResult" }, "type": "array" } }, "required": [ "transfers" ], "title": "TransferListResult", "type": "object" }, "TransferResult": { "properties": { "status": { "$ref": "#/components/schemas/ShareTransferStatus" }, "transfer_id": { "type": "string" } }, "required": [ "transfer_id", "status" ], "title": "TransferResult", "type": "object" }, "TreasuryAccount": { "description": "Treasury Account entity [rootobject]", "properties": { "account_number": { "type": "string" }, "balance": { "type": "number" }, "bank_name": { "type": "string" }, "bic": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "iban": { "type": "string" }, "kind": { "$ref": "#/components/schemas/TreasuryAccountKind" }, "name": { "type": "string" }, "network": { "type": "string" }, "owner_id": { "type": "string" }, "owner_type": { "$ref": "#/components/schemas/EntityType" }, "sid": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "wallet_address": { "type": "string" } }, "required": [ "sid", "owner_type", "owner_id", "name", "kind", "currency", "balance", "created_at", "updated_at" ], "title": "TreasuryAccount", "type": "object" }, "TreasuryAccountKind": { "description": "Treasury account kind", "enum": [ "crypto_wallet", "bank_account" ], "title": "TreasuryAccountKind", "type": "string" }, "TreasuryAccountResult": { "properties": { "account": { "$ref": "#/components/schemas/TreasuryAccount" } }, "required": [ "account" ], "title": "TreasuryAccountResult", "type": "object" }, "TreasuryAccountsListResult": { "description": "Treasury service types", "properties": { "accounts": { "items": { "$ref": "#/components/schemas/TreasuryAccount" }, "type": "array" } }, "required": [ "accounts" ], "title": "TreasuryAccountsListResult", "type": "object" }, "TreasuryAccountsResult": { "description": "Treasury service types", "properties": { "accounts": { "items": { "$ref": "#/components/schemas/TreasuryAccount" }, "type": "array" } }, "required": [ "accounts" ], "title": "TreasuryAccountsResult", "type": "object" }, "TreasuryError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "TreasuryError", "type": "object" }, "TreasuryOperationsError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "TreasuryOperationsError", "type": "object" }, "TreasuryTransaction": { "description": "Treasury Transaction entity [rootobject]", "properties": { "account_id": { "type": "string" }, "amount": { "type": "number" }, "asset": { "type": "string" }, "counterparty": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "currency": { "type": "string" }, "sid": { "type": "string" }, "status": { "$ref": "#/components/schemas/TreasuryTransactionStatus" }, "timestamp": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "tx_type": { "$ref": "#/components/schemas/TreasuryTransactionType" } }, "required": [ "sid", "account_id", "timestamp", "tx_type", "asset", "amount", "currency", "status", "created_at" ], "title": "TreasuryTransaction", "type": "object" }, "TreasuryTransactionStatus": { "description": "Treasury transaction status", "enum": [ "pending", "confirmed", "failed" ], "title": "TreasuryTransactionStatus", "type": "string" }, "TreasuryTransactionType": { "description": "Treasury transaction type", "enum": [ "credit", "debit", "transfer" ], "title": "TreasuryTransactionType", "type": "string" }, "TreasuryTransactionsResult": { "properties": { "transactions": { "items": { "$ref": "#/components/schemas/TreasuryTransaction" }, "type": "array" } }, "required": [ "transactions" ], "title": "TreasuryTransactionsResult", "type": "object" }, "UnreadCountResult": { "properties": { "count": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, "required": [ "count" ], "title": "UnreadCountResult", "type": "object" }, "UnsignedDocumentsResult": { "description": "Document service types", "properties": { "documents": { "items": { "$ref": "#/components/schemas/RegistrationContract" }, "type": "array" } }, "required": [ "documents" ], "title": "UnsignedDocumentsResult", "type": "object" }, "UpdateCompanyData": { "properties": { "address": { "$ref": "#/components/schemas/Address" }, "description": { "type": "string" }, "email": { "type": "string" }, "industry": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "shareholders": { "items": { "$ref": "#/components/schemas/ShareholderData" }, "type": "array" }, "status": { "$ref": "#/components/schemas/CompanyStatus" }, "website": { "type": "string" } }, "title": "UpdateCompanyData", "type": "object" }, "UpdateContractData": { "properties": { "counterparty": { "type": "string" }, "end_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/ContractStatus" }, "total_value": { "type": "number" } }, "title": "UpdateContractData", "type": "object" }, "UpdateExpenseData": { "properties": { "amount": { "type": "number" }, "category": { "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "expense_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "receipt_number": { "type": "string" }, "receipt_url": { "type": "string" }, "status": { "$ref": "#/components/schemas/ExpenseStatus" }, "vendor_name": { "type": "string" } }, "title": "UpdateExpenseData", "type": "object" }, "UpdateInvoiceData": { "properties": { "amount": { "type": "number" }, "description": { "type": "string" }, "due_date": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "line_items": { "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array" }, "status": { "$ref": "#/components/schemas/InvoiceStatus" }, "tax_amount": { "type": "number" } }, "title": "UpdateInvoiceData", "type": "object" }, "UpdateResidentData": { "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "phone": { "type": "string" }, "status": { "$ref": "#/components/schemas/ResidentStatus" } }, "title": "UpdateResidentData", "type": "object" }, "UpdateTreasuryAccountData": { "properties": { "account_number": { "type": "string" }, "bank_name": { "type": "string" }, "bic": { "type": "string" }, "iban": { "type": "string" }, "name": { "type": "string" } }, "title": "UpdateTreasuryAccountData", "type": "object" }, "User": { "description": "─────────────────────────────────────────────────────────────────────────────── BUSINESS RULES - Implemented in rpc.rs (not supported by new generator) ─────────────────────────────────────────────────────────────────────────────── ─────────────────────────────────────────────────────────────────────────────── ROOT OBJECTS - Storable entities with CRUD operations [rootobject] ─────────────────────────────────────────────────────────────────────────────── User account for authentication [rootobject]", "properties": { "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "email": { "type": "string" }, "email_verified": { "type": "boolean" }, "email_verified_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "encrypted_private_key": { "type": "string" }, "first_name": { "type": "string" }, "is_active": { "type": "boolean" }, "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "kyc_verified": { "type": "boolean" }, "kyc_verified_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "last_name": { "type": "string" }, "password_hash": { "type": "string" }, "public_key": { "type": "string" }, "sid": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "sid", "email", "password_hash", "is_active", "email_verified", "kyc_verified", "keypair_version", "created_at", "updated_at" ], "title": "User", "type": "object" }, "UserInfo": { "properties": { "email": { "type": "string" }, "email_verified": { "type": "boolean" }, "first_name": { "type": "string" }, "id": { "type": "string" }, "is_active": { "type": "boolean" }, "kyc_verified": { "type": "boolean" }, "kyc_verified_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "last_name": { "type": "string" }, "subscription": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "required": [ "id", "email", "is_active", "email_verified", "kyc_verified" ], "title": "UserInfo", "type": "object" }, "UserKeypair": { "description": "User Keypair entity for storing encrypted keys [rootobject]", "properties": { "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "encrypted_private_key": { "type": "string" }, "entity_id": { "type": "string" }, "entity_type": { "$ref": "#/components/schemas/EntityType" }, "is_current": { "type": "boolean" }, "public_key": { "type": "string" }, "sid": { "type": "string" }, "user_id": { "type": "string" }, "version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, "required": [ "sid", "user_id", "entity_type", "entity_id", "public_key", "encrypted_private_key", "version", "is_current", "created_at" ], "title": "UserKeypair", "type": "object" }, "UserMessage": { "description": "User message entity [rootobject]", "properties": { "action_label": { "type": "string" }, "action_url": { "type": "string" }, "body": { "type": "string" }, "category": { "$ref": "#/components/schemas/MessageCategory" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "is_read": { "type": "boolean" }, "message_type": { "$ref": "#/components/schemas/MessageType" }, "sid": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "user_id": { "type": "string" } }, "required": [ "sid", "user_id", "title", "body", "message_type", "is_read", "created_at", "updated_at" ], "title": "UserMessage", "type": "object" }, "ValidationResult": { "properties": { "permissions": { "items": { "type": "string" }, "type": "array" }, "reseller_id": { "type": "string" }, "valid": { "type": "boolean" } }, "required": [ "valid", "permissions" ], "title": "ValidationResult", "type": "object" }, "VerificationError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "VerificationError", "type": "object" }, "VerificationLink": { "description": "Verification Link for Tier 3 access [rootobject]", "properties": { "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "expires_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "first_used_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "label": { "type": "string" }, "last_used_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "resident_id": { "type": "string" }, "sid": { "type": "string" }, "single_use": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/VerificationLinkStatus" }, "token": { "type": "string" }, "use_count": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "user_id": { "type": "string" } }, "required": [ "sid", "user_id", "token", "expires_at", "single_use", "use_count", "status", "created_at" ], "title": "VerificationLink", "type": "object" }, "VerificationLinkResult": { "description": "Verification service types", "properties": { "link": { "$ref": "#/components/schemas/VerificationLink" } }, "required": [ "link" ], "title": "VerificationLinkResult", "type": "object" }, "VerificationLinkStatus": { "description": "Verification link status", "enum": [ "active", "expired", "used", "revoked" ], "title": "VerificationLinkStatus", "type": "string" }, "VerificationLinksListResult": { "properties": { "links": { "items": { "$ref": "#/components/schemas/VerificationLink" }, "type": "array" } }, "required": [ "links" ], "title": "VerificationLinksListResult", "type": "object" }, "VerificationLinksResult": { "description": "Verification service additional types", "properties": { "links": { "items": { "$ref": "#/components/schemas/VerificationLink" }, "type": "array" } }, "required": [ "links" ], "title": "VerificationLinksResult", "type": "object" }, "VerifyAllSignedResult": { "properties": { "all_signed": { "type": "boolean" }, "unsigned_count": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, "required": [ "all_signed", "unsigned_count" ], "title": "VerifyAllSignedResult", "type": "object" }, "VerifyByTokenResult": { "properties": { "entity_id": { "type": "string" }, "entity_type": { "$ref": "#/components/schemas/EntityType" }, "has_full_access": { "type": "boolean" }, "keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "member_since": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "name": { "type": "string" }, "public_key": { "type": "string" }, "status": { "type": "string" }, "valid": { "type": "boolean" }, "verified_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, "required": [ "valid", "entity_type", "entity_id", "status", "verified_at", "has_full_access" ], "title": "VerifyByTokenResult", "type": "object" }, "VerifyEmailResult": { "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message" ], "title": "VerifyEmailResult", "type": "object" }, "VerifyError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "VerifyError", "type": "object" }, "VerifyLinkResult": { "properties": { "company_id": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" }, "user_id": { "type": "string" }, "valid": { "type": "boolean" } }, "required": [ "valid", "permissions" ], "title": "VerifyLinkResult", "type": "object" }, "VerifyResult": { "properties": { "current_keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "document_hash": { "type": "string" }, "document_type": { "$ref": "#/components/schemas/DocumentType" }, "error": { "type": "string" }, "is_historical_key": { "type": "boolean" }, "signature_keypair_version": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" }, "signed_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "signer_id": { "type": "string" }, "valid": { "type": "boolean" } }, "required": [ "valid", "signer_id", "signature_keypair_version", "current_keypair_version", "is_historical_key" ], "title": "VerifyResult", "type": "object" }, "Vote": { "description": "Individual vote on a proposal [rootobject]", "properties": { "comment": { "type": "string" }, "company_id": { "type": "string" }, "created_at": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" }, "proposal_id": { "type": "string" }, "sid": { "type": "string" }, "signature": { "type": "string" }, "vote_value": { "$ref": "#/components/schemas/VoteValue" }, "voter_id": { "type": "string" }, "voting_power": { "type": "number" } }, "required": [ "sid", "proposal_id", "company_id", "voter_id", "vote_value", "voting_power", "signature", "created_at" ], "title": "Vote", "type": "object" }, "VoteListResult": { "description": "Governance service types", "properties": { "votes": { "items": { "$ref": "#/components/schemas/Vote" }, "type": "array" } }, "required": [ "votes" ], "title": "VoteListResult", "type": "object" }, "VoteResult": { "properties": { "proposal_id": { "type": "string" }, "vote_id": { "type": "string" }, "vote_value": { "$ref": "#/components/schemas/VoteValue" }, "voting_power": { "type": "number" } }, "required": [ "vote_id", "proposal_id", "vote_value", "voting_power" ], "title": "VoteResult", "type": "object" }, "VoteValue": { "description": "Vote value", "enum": [ "for", "against", "abstain" ], "title": "VoteValue", "type": "string" }, "VotingModel": { "description": "Voting model for companies", "enum": [ "standard", "cooperative" ], "title": "VotingModel", "type": "string" }, "VotingPowerResult": { "properties": { "company_id": { "type": "string" }, "resident_id": { "type": "string" }, "shareholding_percentage": { "type": "number" }, "voting_model": { "$ref": "#/components/schemas/VotingModel" }, "voting_power": { "type": "number" } }, "required": [ "resident_id", "company_id", "voting_power", "voting_model", "shareholding_percentage" ], "title": "VotingPowerResult", "type": "object" }, "WebhookError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WebhookError", "type": "object" }, "WebhookResult": { "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "required": [ "success", "message" ], "title": "WebhookResult", "type": "object" }, "otime": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS (internally u32 epoch seconds)", "examples": [ "2025-01-01 00:00:00", "2038-01-19 03:14:07" ], "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } } }, "info": { "description": "API key management for resellers", "title": "ApiKeyService", "version": "1.0.0" }, "methods": [ { "description": "Generate API key", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ApiKeyError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ApiKeyService.generate", "params": [ { "name": "client_id", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "required": true, "schema": { "type": "string" } }, { "name": "access_password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ApiKeyResult" } }, "summary": "generate" }, { "description": "Register a new user", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/RegistrationError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "AuthService.register", "params": [ { "name": "email", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } }, { "name": "first_name", "required": false, "schema": { "type": "string" } }, { "name": "last_name", "required": false, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/AuthResult" } }, "summary": "register" }, { "description": "Login user and return JWT token", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/AuthError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "AuthService.login", "params": [ { "name": "email", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/AuthResult" } }, "summary": "login" }, { "description": "Refresh JWT token", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/AuthError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "AuthService.refresh_token", "params": [ { "name": "token", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/AuthResult" } }, "summary": "refresh_token" }, { "description": "Send email verification", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/EmailError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "AuthService.send_verification_email", "params": [ { "name": "email", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/VerifyEmailResult" } }, "summary": "send_verification_email" }, { "description": "Verify email with token", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/EmailError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "AuthService.verify_email", "params": [ { "name": "token", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/VerifyEmailResult" } }, "summary": "verify_email" }, { "description": "Change password", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/AuthError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "AuthService.change_password", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "old_password", "required": true, "schema": { "type": "string" } }, { "name": "new_password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ChangePasswordResult" } }, "summary": "change_password" }, { "description": "Upload document", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/BusinessDocumentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "BusinessDocumentService.upload_document", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "document_type", "required": true, "schema": { "$ref": "#/components/schemas/BusinessDocumentType" } }, { "name": "name", "required": true, "schema": { "type": "string" } }, { "name": "description", "required": false, "schema": { "type": "string" } }, { "name": "file_url", "required": true, "schema": { "type": "string" } }, { "name": "uploaded_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/BusinessDocumentResult" } }, "summary": "upload_document" }, { "description": "Generate official document", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/BusinessDocumentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "BusinessDocumentService.generate_official_document", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "document_type", "required": true, "schema": { "$ref": "#/components/schemas/BusinessDocumentType" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/BusinessDocumentResult" } }, "summary": "generate_official_document" }, { "description": "Get document", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/BusinessDocumentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "BusinessDocumentService.get_document", "params": [ { "name": "document_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/BusinessDocumentDetailResult" } }, "summary": "get_document" }, { "description": "List documents for a company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/BusinessDocumentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "BusinessDocumentService.list_documents", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "document_type", "required": false, "schema": { "$ref": "#/components/schemas/BusinessDocumentType" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/BusinessDocumentListResult" } }, "summary": "list_documents" }, { "description": "Delete document (non-official only)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/BusinessDocumentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "BusinessDocumentService.delete_document", "params": [ { "name": "document_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/DeleteBusinessDocumentResult" } }, "summary": "delete_document" }, { "description": "List companies for user with pagination", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CompanyError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CompanyService.list", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "page", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, { "name": "page_size", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CompaniesListResult" } }, "summary": "list" }, { "description": "Create a new company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CompanyError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CompanyService.create", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/CreateCompanyData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CompanyResult" } }, "summary": "create" }, { "description": "Get company by ID", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CompanyError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CompanyService.get", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CompanyResult" } }, "summary": "get" }, { "description": "Update company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CompanyError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CompanyService.update", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/UpdateCompanyData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CompanyResult" } }, "summary": "update" }, { "description": "Delete company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CompanyError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CompanyService.delete", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/DeleteResult" } }, "summary": "delete" }, { "description": "Get company card (public display info)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CompanyError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CompanyService.get_card", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CompanyCardResult" } }, "summary": "get_card" }, { "description": "Get company key status", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KeypairError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CompanyService.get_key_status", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/KeyStatusResult" } }, "summary": "get_key_status" }, { "description": "View company private key", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KeypairError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CompanyService.view_private_key", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/PrivateKeyResult" } }, "summary": "view_private_key" }, { "description": "Regenerate company keypair", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KeypairError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CompanyService.regenerate_keypair", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/KeypairResult" } }, "summary": "regenerate_keypair" }, { "description": "Change company keypair password", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KeypairError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CompanyService.change_password", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "current_password", "required": true, "schema": { "type": "string" } }, { "name": "new_password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ChangePasswordResult" } }, "summary": "change_password" }, { "description": "List company contracts", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ContractError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ContractService.list_company_contracts", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ContractsListResult" } }, "summary": "list_company_contracts" }, { "description": "Get company contract", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ContractError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ContractService.get_company_contract", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } }, { "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ContractResult" } }, "summary": "get_company_contract" }, { "description": "Create company contract", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ContractError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ContractService.create_company_contract", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/CreateContractData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ContractResult" } }, "summary": "create_company_contract" }, { "description": "Update company contract", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ContractError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ContractService.update_company_contract", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } }, { "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/UpdateContractData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ContractResult" } }, "summary": "update_company_contract" }, { "description": "Archive company contract", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ContractError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ContractService.archive_company_contract", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } }, { "name": "contract_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ContractResult" } }, "summary": "archive_company_contract" }, { "description": "List contract templates", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ContractError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ContractService.list_templates", "params": [], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TemplatesListResult" } }, "summary": "list_templates" }, { "description": "Get contract template", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ContractError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ContractService.get_template", "params": [ { "name": "template_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TemplateResult" } }, "summary": "get_template" }, { "description": "Get required registration contracts", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ContractError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ContractService.get_required_contracts", "params": [ { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/RequiredContractsResult" } }, "summary": "get_required_contracts" }, { "description": "Sign contract", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/SignError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ContractService.sign_contract", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "contract_id", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/SignContractResult" } }, "summary": "sign_contract" }, { "description": "Get contract signatures for user", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ContractError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ContractService.get_signatures", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/SignaturesListResult" } }, "summary": "get_signatures" }, { "description": "Get user's credit balance (creates if not exists)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CreditError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CreditService.get_balance", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CreditBalanceResult" } }, "summary": "get_balance" }, { "description": "Top up credits from a confirmed payment", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CreditError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CreditService.top_up", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "amount", "required": true, "schema": { "type": "number" } }, { "name": "payment_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CreditTransactionResult" } }, "summary": "top_up" }, { "description": "Deduct credits for a service (KYC, subscription, company registration)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CreditError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CreditService.deduct", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "amount", "required": true, "schema": { "type": "number" } }, { "name": "description", "required": true, "schema": { "type": "string" } }, { "name": "reference_type", "required": true, "schema": { "type": "string" } }, { "name": "reference_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CreditTransactionResult" } }, "summary": "deduct" }, { "description": "Add bonus credits (welcome bonus, promotions)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CreditError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CreditService.add_bonus", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "amount", "required": true, "schema": { "type": "number" } }, { "name": "description", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CreditTransactionResult" } }, "summary": "add_bonus" }, { "description": "Refund credits (e.g., failed KYC)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CreditError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CreditService.refund", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "amount", "required": true, "schema": { "type": "number" } }, { "name": "description", "required": true, "schema": { "type": "string" } }, { "name": "reference_type", "required": true, "schema": { "type": "string" } }, { "name": "reference_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CreditTransactionResult" } }, "summary": "refund" }, { "description": "List credit transactions for a user", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CreditError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CreditService.list_transactions", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "page", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, { "name": "page_size", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CreditTransactionsListResult" } }, "summary": "list_transactions" }, { "description": "Get credit pricing (costs for services)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/CreditError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "CreditService.get_pricing", "params": [], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CreditPricingResult" } }, "summary": "get_pricing" }, { "description": "Sign document", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/SignError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "DocumentService.sign", "params": [ { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "entity_id", "required": true, "schema": { "type": "string" } }, { "name": "document_type", "required": true, "schema": { "$ref": "#/components/schemas/DocumentType" } }, { "name": "document_content", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/SignResult" } }, "summary": "sign" }, { "description": "Verify document signature", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/VerifyError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "DocumentService.verify", "params": [ { "name": "signature", "required": true, "schema": { "type": "string" } }, { "name": "signer_id", "required": true, "schema": { "type": "string" } }, { "name": "signer_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/VerifyResult" } }, "summary": "verify" }, { "description": "Get key status", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KeypairError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "DocumentService.get_key_status", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/KeyStatusResult" } }, "summary": "get_key_status" }, { "description": "List expenses for company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ExpenseService.list", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ExpensesListResult" } }, "summary": "list" }, { "description": "Create expense", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ExpenseService.create", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/CreateExpenseData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ExpenseResult" } }, "summary": "create" }, { "description": "Get expense by ID", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ExpenseService.get", "params": [ { "name": "expense_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ExpenseResult" } }, "summary": "get" }, { "description": "Update expense", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ExpenseService.update", "params": [ { "name": "expense_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/UpdateExpenseData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ExpenseResult" } }, "summary": "update" }, { "description": "Delete expense", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ExpenseService.delete", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } }, { "name": "expense_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/DeleteResult" } }, "summary": "delete" }, { "description": "Submit expense for approval", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ExpenseService.submit", "params": [ { "name": "expense_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ExpenseResult" } }, "summary": "submit" }, { "description": "Approve expense", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ExpenseService.approve", "params": [ { "name": "expense_id", "required": true, "schema": { "type": "string" } }, { "name": "approved_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ExpenseResult" } }, "summary": "approve" }, { "description": "Reject expense", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ExpenseService.reject", "params": [ { "name": "expense_id", "required": true, "schema": { "type": "string" } }, { "name": "rejected_by", "required": true, "schema": { "type": "string" } }, { "name": "reason", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ExpenseResult" } }, "summary": "reject" }, { "description": "Create a new proposal", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/GovernanceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "GovernanceService.create_proposal", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "title", "required": true, "schema": { "type": "string" } }, { "name": "description", "required": true, "schema": { "type": "string" } }, { "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/ProposalCategory" } }, { "name": "voting_days", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, { "name": "quorum_percentage", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, { "name": "passing_threshold", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, { "name": "allow_abstention", "required": true, "schema": { "type": "boolean" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ProposalResult" } }, "summary": "create_proposal" }, { "description": "Get proposal details", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/GovernanceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "GovernanceService.get_proposal", "params": [ { "name": "proposal_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ProposalDetailResult" } }, "summary": "get_proposal" }, { "description": "List proposals for a company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/GovernanceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "GovernanceService.list_proposals", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/ProposalStatus" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ProposalListResult" } }, "summary": "list_proposals" }, { "description": "Cast a vote on a proposal", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/GovernanceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "GovernanceService.cast_vote", "params": [ { "name": "proposal_id", "required": true, "schema": { "type": "string" } }, { "name": "voter_id", "required": true, "schema": { "type": "string" } }, { "name": "vote_value", "required": true, "schema": { "$ref": "#/components/schemas/VoteValue" } }, { "name": "comment", "required": false, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/VoteResult" } }, "summary": "cast_vote" }, { "description": "Get voting power for a shareholder", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/GovernanceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "GovernanceService.get_voting_power", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "resident_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/VotingPowerResult" } }, "summary": "get_voting_power" }, { "description": "Tally votes and update proposal status", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/GovernanceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "GovernanceService.tally_votes", "params": [ { "name": "proposal_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TallyResult" } }, "summary": "tally_votes" }, { "description": "Execute a passed proposal (create resolution)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/GovernanceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "GovernanceService.execute_proposal", "params": [ { "name": "proposal_id", "required": true, "schema": { "type": "string" } }, { "name": "executor_id", "required": true, "schema": { "type": "string" } }, { "name": "notes", "required": false, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ResolutionResult" } }, "summary": "execute_proposal" }, { "description": "List resolutions for a company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/GovernanceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "GovernanceService.list_resolutions", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ResolutionListResult" } }, "summary": "list_resolutions" }, { "description": "List invoices for company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "InvoiceService.list", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/InvoicesListResult" } }, "summary": "list" }, { "description": "Create invoice", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "InvoiceService.create", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/CreateInvoiceData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/InvoiceResult" } }, "summary": "create" }, { "description": "Get invoice by ID", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "InvoiceService.get", "params": [ { "name": "invoice_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/InvoiceResult" } }, "summary": "get" }, { "description": "Update invoice", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "InvoiceService.update", "params": [ { "name": "invoice_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/UpdateInvoiceData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/InvoiceResult" } }, "summary": "update" }, { "description": "Delete invoice", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/InvoiceError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "InvoiceService.delete", "params": [ { "name": "fzc_id", "required": true, "schema": { "type": "string" } }, { "name": "invoice_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/DeleteResult" } }, "summary": "delete" }, { "description": "Generate new keypair for entity", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KeypairError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "KeypairService.generate_keypair", "params": [ { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "entity_id", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/KeypairResult" } }, "summary": "generate_keypair" }, { "description": "Sign document", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/SignError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "KeypairService.sign_document", "params": [ { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "entity_id", "required": true, "schema": { "type": "string" } }, { "name": "document_type", "required": true, "schema": { "$ref": "#/components/schemas/DocumentType" } }, { "name": "document_content", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/SignResult" } }, "summary": "sign_document" }, { "description": "Verify signature", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/VerifyError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "KeypairService.verify_signature", "params": [ { "name": "signature", "required": true, "schema": { "type": "string" } }, { "name": "signer_id", "required": true, "schema": { "type": "string" } }, { "name": "signer_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/VerifyResult" } }, "summary": "verify_signature" }, { "description": "View private key (requires password)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KeypairError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "KeypairService.view_private_key", "params": [ { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "entity_id", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/PrivateKeyResult" } }, "summary": "view_private_key" }, { "description": "Regenerate keypair", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KeypairError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "KeypairService.regenerate_keypair", "params": [ { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "entity_id", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/KeypairResult" } }, "summary": "regenerate_keypair" }, { "description": "Start KYC verification session", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KycError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "KycService.start_verification", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } }, { "name": "public_key", "required": true, "schema": { "type": "string" } }, { "name": "callback_url", "required": false, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/KycSessionResult" } }, "summary": "start_verification" }, { "description": "Check KYC status", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KycError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "KycService.check_status", "params": [ { "name": "session_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/KycStatusResult" } }, "summary": "check_status" }, { "description": "Handle iDenfy webhook", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/WebhookError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "KycService.handle_idenfy_webhook", "params": [ { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/IdenfyWebhookData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/WebhookResult" } }, "summary": "handle_idenfy_webhook" }, { "description": "List user messages with filtering", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.list_user_messages", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "category", "required": false, "schema": { "$ref": "#/components/schemas/MessageCategory" } }, { "name": "is_read", "required": false, "schema": { "type": "boolean" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MessagesListResult" } }, "summary": "list_user_messages" }, { "description": "Get user message", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.get_user_message", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MessageResult" } }, "summary": "get_user_message" }, { "description": "Get unread count", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.get_unread_count", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/UnreadCountResult" } }, "summary": "get_unread_count" }, { "description": "Mark message as read", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.mark_as_read", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MarkReadResult" } }, "summary": "mark_as_read" }, { "description": "Mark message as unread", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.mark_as_unread", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MarkReadResult" } }, "summary": "mark_as_unread" }, { "description": "Mark all as read", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.mark_all_read", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MarkReadResult" } }, "summary": "mark_all_read" }, { "description": "Mark all as unread", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.mark_all_unread", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MarkReadResult" } }, "summary": "mark_all_unread" }, { "description": "Delete message", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.delete_message", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/DeleteResult" } }, "summary": "delete_message" }, { "description": "Create system message (admin)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.create_system_message", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "title", "required": true, "schema": { "type": "string" } }, { "name": "body", "required": true, "schema": { "type": "string" } }, { "name": "category", "required": false, "schema": { "$ref": "#/components/schemas/MessageCategory" } }, { "name": "action_url", "required": false, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MessageResult" } }, "summary": "create_system_message" }, { "description": "List company messages", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.list_company_messages", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MessagesListResult" } }, "summary": "list_company_messages" }, { "description": "Create company message", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.create_company_message", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "title", "required": true, "schema": { "type": "string" } }, { "name": "body", "required": true, "schema": { "type": "string" } }, { "name": "category", "required": false, "schema": { "$ref": "#/components/schemas/MessageCategory" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MessageResult" } }, "summary": "create_company_message" }, { "description": "Mark company message as read", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.mark_company_read", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MarkReadResult" } }, "summary": "mark_company_read" }, { "description": "Mark company message as unread", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.mark_company_unread", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MarkReadResult" } }, "summary": "mark_company_unread" }, { "description": "Mark all company messages read", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.mark_all_company_read", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MarkReadResult" } }, "summary": "mark_all_company_read" }, { "description": "Mark all company messages unread", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/MessageError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "MessageService.mark_all_company_unread", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/MarkReadResult" } }, "summary": "mark_all_company_unread" }, { "description": "Get crypto wallet address for payment", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/PaymentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PaymentService.get_payment_wallet", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } }, { "name": "payment_type", "required": true, "schema": { "$ref": "#/components/schemas/PaymentType" } }, { "name": "amount", "required": true, "schema": { "type": "number" } }, { "name": "currency", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/PaymentWalletResult" } }, "summary": "get_payment_wallet" }, { "description": "Confirm payment", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/PaymentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PaymentService.confirm_payment", "params": [ { "name": "payment_id", "required": true, "schema": { "type": "string" } }, { "name": "sender_address", "required": false, "schema": { "type": "string" } }, { "name": "transaction_hash", "required": false, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/PaymentConfirmResult" } }, "summary": "confirm_payment" }, { "description": "Initiate ClickPesa payment", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/PaymentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PaymentService.initiate_clickpesa", "params": [ { "name": "entity_id", "required": true, "schema": { "type": "string" } }, { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "amount", "required": true, "schema": { "type": "number" } }, { "name": "currency", "required": true, "schema": { "type": "string" } }, { "name": "description", "required": true, "schema": { "type": "string" } }, { "name": "payment_purpose", "required": true, "schema": { "type": "string" } }, { "name": "subscription_plan", "required": false, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ClickPesaResult" } }, "summary": "initiate_clickpesa" }, { "description": "Handle ClickPesa webhook", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/WebhookError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PaymentService.handle_payment_webhook", "params": [ { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/ClickPesaWebhookData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/WebhookResult" } }, "summary": "handle_payment_webhook" }, { "description": "Initiate subscription renewal payment", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/PaymentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PaymentService.initiate_renewal", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ClickPesaResult" } }, "summary": "initiate_renewal" }, { "description": "Get subscription status for a user", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/PaymentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PaymentService.get_subscription_status", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/SubscriptionInfo" } }, "summary": "get_subscription_status" }, { "description": "Calculate company registration pricing", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/PricingError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PricingService.calculate_company_pricing", "params": [ { "name": "company_type", "required": true, "schema": { "$ref": "#/components/schemas/CompanyType" } }, { "name": "shareholder_count", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, { "name": "subscription_plan", "required": true, "schema": { "$ref": "#/components/schemas/CompanySubscriptionPlan" } }, { "name": "early_bird", "required": true, "schema": { "type": "boolean" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/PricingResult" } }, "summary": "calculate_company_pricing" }, { "description": "Get all pricing configurations (for display)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/PricingError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PricingService.get_all_pricing", "params": [], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/AllPricingConfig" } }, "summary": "get_all_pricing" }, { "description": "Get shareholder fee rate for a company type and count", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/PricingError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PricingService.get_shareholder_fee_rate", "params": [ { "name": "company_type", "required": true, "schema": { "$ref": "#/components/schemas/CompanyType" } }, { "name": "shareholder_count", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ShareholderFeeRateResult" } }, "summary": "get_shareholder_fee_rate" }, { "description": "Get key history for an entity", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KeypairError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PublicKeyHistoryService.get_history", "params": [ { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "entity_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/PublicKeyHistoryResult" } }, "summary": "get_history" }, { "description": "Get specific historical key by version", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KeypairError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PublicKeyHistoryService.get_by_version", "params": [ { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "entity_id", "required": true, "schema": { "type": "string" } }, { "name": "version", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/PublicKeyHistory" } }, "summary": "get_by_version" }, { "description": "Verify signature with historical key lookup", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/VerifyError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "PublicKeyHistoryService.verify_with_history", "params": [ { "name": "signature", "required": true, "schema": { "type": "string" } }, { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "entity_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/VerifyResult" } }, "summary": "verify_with_history" }, { "description": "Get registration status", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/RegistrationError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "RegistrationService.get_status", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/RegistrationStatusResult" } }, "summary": "get_status" }, { "description": "Update registration status", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/RegistrationError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "RegistrationService.update_status", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "status", "required": true, "schema": { "$ref": "#/components/schemas/RegistrationFlowStatus" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/RegistrationStatusResult" } }, "summary": "update_status" }, { "description": "Check if resident payment is complete", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/RegistrationError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "RegistrationService.check_payment_complete", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/PaymentCompleteResult" } }, "summary": "check_payment_complete" }, { "description": "Check if user KYC is complete", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/RegistrationError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "RegistrationService.check_kyc_complete", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/KycCompleteResult" } }, "summary": "check_kyc_complete" }, { "description": "Activate resident if all requirements met", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/RegistrationError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "RegistrationService.activate_if_complete", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ActivateResult" } }, "summary": "activate_if_complete" }, { "description": "Confirm KYC (internal)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/KycError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "RegistrationService.confirm_kyc", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "resident_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/KycConfirmData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/KycConfirmResult" } }, "summary": "confirm_kyc" }, { "description": "Generate balance sheet", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ReportError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ReportService.generate_balance_sheet", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "as_of_date", "required": true, "schema": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "generated_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FinancialReportResult" } }, "summary": "generate_balance_sheet" }, { "description": "Generate income statement", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ReportError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ReportService.generate_income_statement", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "period_start", "required": true, "schema": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "period_end", "required": true, "schema": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "generated_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FinancialReportResult" } }, "summary": "generate_income_statement" }, { "description": "Generate cash flow statement", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ReportError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ReportService.generate_cash_flow", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "period_start", "required": true, "schema": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "period_end", "required": true, "schema": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "generated_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FinancialReportResult" } }, "summary": "generate_cash_flow" }, { "description": "Generate trial balance", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ReportError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ReportService.generate_trial_balance", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "as_of_date", "required": true, "schema": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "generated_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FinancialReportResult" } }, "summary": "generate_trial_balance" }, { "description": "Get report", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ReportError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ReportService.get_report", "params": [ { "name": "report_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FinancialReportDetailResult" } }, "summary": "get_report" }, { "description": "List reports for a company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ReportError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ReportService.list_reports", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "report_type", "required": false, "schema": { "$ref": "#/components/schemas/FinancialReportType" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FinancialReportListResult" } }, "summary": "list_reports" }, { "description": "List residents with pagination", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ResidentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ResidentService.list", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "page", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, { "name": "page_size", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ResidentsListResult" } }, "summary": "list" }, { "description": "Create a new resident", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ResidentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ResidentService.create", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/CreateResidentData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ResidentResult" } }, "summary": "create" }, { "description": "Get resident by ID", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ResidentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ResidentService.get", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ResidentResult" } }, "summary": "get" }, { "description": "Update resident", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ResidentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ResidentService.update", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/UpdateResidentData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ResidentResult" } }, "summary": "update" }, { "description": "Delete resident", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ResidentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ResidentService.delete", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/DeleteResult" } }, "summary": "delete" }, { "description": "Update subscription", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ResidentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ResidentService.update_subscription", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } }, { "name": "plan", "required": true, "schema": { "type": "string" } }, { "name": "auto_renewal", "required": true, "schema": { "type": "boolean" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/SubscriptionResult" } }, "summary": "update_subscription" }, { "description": "Get resident card (public display info)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ResidentError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ResidentService.get_card", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ResidentCardResult" } }, "summary": "get_card" }, { "description": "Invite someone to become a shareholder", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.invite_shareholder", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "inviter_id", "required": true, "schema": { "type": "string" } }, { "name": "invitee_email", "required": true, "schema": { "type": "string" } }, { "name": "proposed_percentage", "required": true, "schema": { "type": "number" } }, { "name": "message", "required": false, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/InviteResult" } }, "summary": "invite_shareholder" }, { "description": "Accept shareholder invite", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.accept_invite", "params": [ { "name": "invite_token", "required": true, "schema": { "type": "string" } }, { "name": "resident_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/AcceptInviteResult" } }, "summary": "accept_invite" }, { "description": "Reject shareholder invite", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.reject_invite", "params": [ { "name": "invite_token", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/RejectInviteResult" } }, "summary": "reject_invite" }, { "description": "List pending invites for a company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.list_invites", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/InviteListResult" } }, "summary": "list_invites" }, { "description": "Initiate share transfer", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.initiate_transfer", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "from_resident_id", "required": true, "schema": { "type": "string" } }, { "name": "to_resident_id", "required": true, "schema": { "type": "string" } }, { "name": "percentage", "required": true, "schema": { "type": "number" } }, { "name": "reason", "required": false, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TransferResult" } }, "summary": "initiate_transfer" }, { "description": "Approve share transfer (by recipient)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.approve_transfer", "params": [ { "name": "transfer_id", "required": true, "schema": { "type": "string" } }, { "name": "to_signature", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TransferResult" } }, "summary": "approve_transfer" }, { "description": "Complete share transfer", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.complete_transfer", "params": [ { "name": "transfer_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TransferResult" } }, "summary": "complete_transfer" }, { "description": "Cancel share transfer", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.cancel_transfer", "params": [ { "name": "transfer_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TransferResult" } }, "summary": "cancel_transfer" }, { "description": "List share transfers for a company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.list_transfers", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/ShareTransferStatus" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TransferListResult" } }, "summary": "list_transfers" }, { "description": "Initiate dividend distribution", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.initiate_dividend", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "total_amount", "required": true, "schema": { "type": "number" } }, { "name": "currency", "required": true, "schema": { "type": "string" } }, { "name": "source_account_id", "required": true, "schema": { "type": "string" } }, { "name": "distribution_date", "required": true, "schema": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "initiated_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/DividendResult" } }, "summary": "initiate_dividend" }, { "description": "Execute dividend distribution", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.execute_dividend", "params": [ { "name": "dividend_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/DividendResult" } }, "summary": "execute_dividend" }, { "description": "List dividend distributions for a company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/ShareholderError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "ShareholderService.list_dividends", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/DividendListResult" } }, "summary": "list_dividends" }, { "description": "Create tax filing", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TaxError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TaxService.create_filing", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "filing_type", "required": true, "schema": { "$ref": "#/components/schemas/TaxFilingPeriod" } }, { "name": "period_start", "required": true, "schema": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } }, { "name": "period_end", "required": true, "schema": { "description": "UTC timestamp in format YYYY-MM-DD HH:MM:SS", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TaxFilingResult" } }, "summary": "create_filing" }, { "description": "Get tax filing", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TaxError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TaxService.get_filing", "params": [ { "name": "filing_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TaxFilingDetailResult" } }, "summary": "get_filing" }, { "description": "Update tax filing (draft only)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TaxError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TaxService.update_filing", "params": [ { "name": "filing_id", "required": true, "schema": { "type": "string" } }, { "name": "gross_revenue", "required": true, "schema": { "type": "number" } }, { "name": "cost_of_goods_sold", "required": true, "schema": { "type": "number" } }, { "name": "operating_expenses", "required": true, "schema": { "type": "number" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TaxFilingResult" } }, "summary": "update_filing" }, { "description": "Submit tax filing", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TaxError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TaxService.submit_filing", "params": [ { "name": "filing_id", "required": true, "schema": { "type": "string" } }, { "name": "submitted_by", "required": true, "schema": { "type": "string" } }, { "name": "password", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TaxFilingResult" } }, "summary": "submit_filing" }, { "description": "List tax filings for a company", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TaxError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TaxService.list_filings", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/TaxFilingStatus" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TaxFilingListResult" } }, "summary": "list_filings" }, { "description": "Get upcoming filing deadlines", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TaxError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TaxService.get_deadlines", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TaxDeadlineResult" } }, "summary": "get_deadlines" }, { "description": "Generate tax document", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TaxError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TaxService.generate_document", "params": [ { "name": "filing_id", "required": true, "schema": { "type": "string" } }, { "name": "document_type", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TaxDocumentResult" } }, "summary": "generate_document" }, { "description": "List tax documents for a filing", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TaxError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TaxService.list_documents", "params": [ { "name": "filing_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TaxDocumentListResult" } }, "summary": "list_documents" }, { "description": "Initiate internal fund transfer", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryOperationsError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryOperationsService.initiate_transfer", "params": [ { "name": "from_account_id", "required": true, "schema": { "type": "string" } }, { "name": "to_account_id", "required": true, "schema": { "type": "string" } }, { "name": "amount", "required": true, "schema": { "type": "number" } }, { "name": "currency", "required": true, "schema": { "type": "string" } }, { "name": "reference", "required": false, "schema": { "type": "string" } }, { "name": "initiated_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FundTransferResult" } }, "summary": "initiate_transfer" }, { "description": "Initiate external fund transfer", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryOperationsError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryOperationsService.initiate_external_transfer", "params": [ { "name": "from_account_id", "required": true, "schema": { "type": "string" } }, { "name": "to_address", "required": true, "schema": { "type": "string" } }, { "name": "to_name", "required": true, "schema": { "type": "string" } }, { "name": "amount", "required": true, "schema": { "type": "number" } }, { "name": "currency", "required": true, "schema": { "type": "string" } }, { "name": "reference", "required": false, "schema": { "type": "string" } }, { "name": "initiated_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FundTransferResult" } }, "summary": "initiate_external_transfer" }, { "description": "Approve fund transfer", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryOperationsError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryOperationsService.approve_transfer", "params": [ { "name": "transfer_id", "required": true, "schema": { "type": "string" } }, { "name": "approved_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FundTransferResult" } }, "summary": "approve_transfer" }, { "description": "Cancel fund transfer", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryOperationsError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryOperationsService.cancel_transfer", "params": [ { "name": "transfer_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FundTransferResult" } }, "summary": "cancel_transfer" }, { "description": "List fund transfers for an account", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryOperationsError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryOperationsService.list_transfers", "params": [ { "name": "account_id", "required": true, "schema": { "type": "string" } }, { "name": "status", "required": false, "schema": { "$ref": "#/components/schemas/FundTransferStatus" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/FundTransferListResult" } }, "summary": "list_transfers" }, { "description": "Get exchange rate quote", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryOperationsError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryOperationsService.get_exchange_quote", "params": [ { "name": "from_currency", "required": true, "schema": { "type": "string" } }, { "name": "to_currency", "required": true, "schema": { "type": "string" } }, { "name": "amount", "required": true, "schema": { "type": "number" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ExchangeQuoteResult" } }, "summary": "get_exchange_quote" }, { "description": "Execute currency exchange", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryOperationsError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryOperationsService.execute_exchange", "params": [ { "name": "owner_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "owner_id", "required": true, "schema": { "type": "string" } }, { "name": "from_account_id", "required": true, "schema": { "type": "string" } }, { "name": "to_account_id", "required": true, "schema": { "type": "string" } }, { "name": "from_amount", "required": true, "schema": { "type": "number" } }, { "name": "from_currency", "required": true, "schema": { "type": "string" } }, { "name": "exchange_rate", "required": true, "schema": { "type": "number" } }, { "name": "initiated_by", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ExchangeResult" } }, "summary": "execute_exchange" }, { "description": "List exchange transactions", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryOperationsError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryOperationsService.list_exchanges", "params": [ { "name": "owner_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "owner_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/ExchangeListResult" } }, "summary": "list_exchanges" }, { "description": "List company treasury accounts", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryService.list_company_accounts", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TreasuryAccountsResult" } }, "summary": "list_company_accounts" }, { "description": "Get company treasury account", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryService.get_company_account", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "account_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TreasuryAccountResult" } }, "summary": "get_company_account" }, { "description": "List company treasury transactions", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryService.list_company_transactions", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "account_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TreasuryTransactionsResult" } }, "summary": "list_company_transactions" }, { "description": "Create company treasury account", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryService.create_company_account", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/CreateTreasuryAccountData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TreasuryAccountResult" } }, "summary": "create_company_account" }, { "description": "Update company treasury account", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryService.update_company_account", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "account_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/UpdateTreasuryAccountData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TreasuryAccountResult" } }, "summary": "update_company_account" }, { "description": "List resident treasury accounts", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryService.list_resident_accounts", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TreasuryAccountsResult" } }, "summary": "list_resident_accounts" }, { "description": "Get resident treasury account", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryService.get_resident_account", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } }, { "name": "account_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TreasuryAccountResult" } }, "summary": "get_resident_account" }, { "description": "List resident treasury transactions", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryService.list_resident_transactions", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } }, { "name": "account_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TreasuryTransactionsResult" } }, "summary": "list_resident_transactions" }, { "description": "Create resident treasury account", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryService.create_resident_account", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/CreateTreasuryAccountData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TreasuryAccountResult" } }, "summary": "create_resident_account" }, { "description": "Update resident treasury account", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/TreasuryError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "TreasuryService.update_resident_account", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } }, { "name": "account_id", "required": true, "schema": { "type": "string" } }, { "name": "data", "required": true, "schema": { "$ref": "#/components/schemas/UpdateTreasuryAccountData" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/TreasuryAccountResult" } }, "summary": "update_resident_account" }, { "description": "Verify individual (Tier 1: anonymous, Tier 2: member, Tier 3: via link)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/VerificationError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "VerificationService.verify_individual", "params": [ { "name": "resident_id", "required": true, "schema": { "type": "string" } }, { "name": "requester_tier", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, { "name": "link_token", "required": false, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/IndividualVerificationResult" } }, "summary": "verify_individual" }, { "description": "Verify company (Tier 1: anonymous, Tier 2: member, Tier 3: via link)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/VerificationError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "VerificationService.verify_company", "params": [ { "name": "company_id", "required": true, "schema": { "type": "string" } }, { "name": "requester_tier", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, { "name": "link_token", "required": false, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CompanyVerificationResult" } }, "summary": "verify_company" }, { "description": "Create verification link", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/LinkError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "VerificationService.create_verification_link", "params": [ { "name": "entity_type", "required": true, "schema": { "$ref": "#/components/schemas/EntityType" } }, { "name": "entity_id", "required": true, "schema": { "type": "string" } }, { "name": "label", "required": false, "schema": { "type": "string" } }, { "name": "expires_in_hours", "required": true, "schema": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer" } }, { "name": "single_use", "required": true, "schema": { "type": "boolean" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/CreateLinkResult" } }, "summary": "create_verification_link" }, { "description": "Revoke verification link", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/LinkError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "VerificationService.revoke_verification_link", "params": [ { "name": "link_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/RevokeResult" } }, "summary": "revoke_verification_link" }, { "description": "List verification links for user", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/LinkError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "VerificationService.list_verification_links", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/VerificationLinksResult" } }, "summary": "list_verification_links" }, { "description": "Delete inactive verification links", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/LinkError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "VerificationService.delete_inactive_links", "params": [ { "name": "user_id", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/DeleteLinksResult" } }, "summary": "delete_inactive_links" }, { "description": "Verify by token (public endpoint)", "errors": [ { "code": -32000, "data": { "properties": { "error": { "$ref": "#/components/schemas/VerificationError" } }, "type": "object" }, "message": "Error variant 0" } ], "name": "VerificationService.verify_by_token", "params": [ { "name": "token", "required": true, "schema": { "type": "string" } } ], "result": { "description": "Method result", "name": "result", "schema": { "$ref": "#/components/schemas/VerifyByTokenResult" } }, "summary": "verify_by_token" } ], "openrpc": "1.3.2" }