{"openapi":"3.1.0","info":{"title":"TechnoMinds Provider Core API","description":"Public API for TechnoMinds Provider Core v1.0 (Wave-1.md sections 14/28). Dev-mode auth: Authorization: Bearer <token> — see src/auth.ts for the Wave-1 local substitute for real identity/authorization packages.","version":"1.0.0"},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{}},"paths":{"/v1/connected-businesses":{"post":{"tags":["connected-businesses"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_reference":{"type":"string","minLength":1,"maxLength":120},"display_name":{"type":"string","minLength":1,"maxLength":160},"legal_name_ar":{"type":"string","minLength":1,"maxLength":160,"nullable":true},"legal_name_en":{"type":"string","minLength":1,"maxLength":160},"vat_reference":{"type":"string","minLength":1,"maxLength":120,"nullable":true},"commercial_registration_reference":{"type":"string","minLength":1,"maxLength":120,"nullable":true},"national_address_reference":{"type":"string","minLength":1,"maxLength":120,"nullable":true},"products":{"type":"array","items":{"type":"string","enum":["fatoorah","address"]},"minItems":1,"default":["fatoorah","address"]}},"required":["external_reference","display_name","legal_name_en"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"platform_organization_id":{"type":"string","minLength":1},"external_reference":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"legal_name_ar":{"type":"string","minLength":1,"nullable":true},"legal_name_en":{"type":"string","minLength":1},"vat_reference":{"type":"string","minLength":1,"nullable":true},"commercial_registration_reference":{"type":"string","minLength":1,"nullable":true},"national_address_reference":{"type":"string","minLength":1,"nullable":true},"lifecycle_status":{"type":"string","enum":["active","suspended","closed"]},"resources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"capability_id":{"type":"string"},"lifecycle_status":{"type":"string"}},"required":["id","capability_id","lifecycle_status"],"additionalProperties":false}}},"required":["id","created_at","updated_at","platform_organization_id","external_reference","display_name","legal_name_ar","legal_name_en","vat_reference","commercial_registration_reference","national_address_reference","lifecycle_status","resources"],"additionalProperties":false}}}},"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"platform_organization_id":{"type":"string","minLength":1},"external_reference":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"legal_name_ar":{"type":"string","minLength":1,"nullable":true},"legal_name_en":{"type":"string","minLength":1},"vat_reference":{"type":"string","minLength":1,"nullable":true},"commercial_registration_reference":{"type":"string","minLength":1,"nullable":true},"national_address_reference":{"type":"string","minLength":1,"nullable":true},"lifecycle_status":{"type":"string","enum":["active","suspended","closed"]},"resources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"capability_id":{"type":"string"},"lifecycle_status":{"type":"string"}},"required":["id","capability_id","lifecycle_status"],"additionalProperties":false}}},"required":["id","created_at","updated_at","platform_organization_id","external_reference","display_name","legal_name_ar","legal_name_en","vat_reference","commercial_registration_reference","national_address_reference","lifecycle_status","resources"],"additionalProperties":false}}}}}},"get":{"tags":["connected-businesses"],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"cursor","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"platform_organization_id":{"type":"string","minLength":1},"external_reference":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"legal_name_ar":{"type":"string","minLength":1,"nullable":true},"legal_name_en":{"type":"string","minLength":1},"vat_reference":{"type":"string","minLength":1,"nullable":true},"commercial_registration_reference":{"type":"string","minLength":1,"nullable":true},"national_address_reference":{"type":"string","minLength":1,"nullable":true},"lifecycle_status":{"type":"string","enum":["active","suspended","closed"]}},"required":["id","created_at","updated_at","platform_organization_id","external_reference","display_name","legal_name_ar","legal_name_en","vat_reference","commercial_registration_reference","national_address_reference","lifecycle_status"],"additionalProperties":false}},"next_cursor":{"type":"string","format":"uuid","nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}}},"/v1/connected-businesses/{id}":{"get":{"tags":["connected-businesses"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"platform_organization_id":{"type":"string","minLength":1},"external_reference":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"legal_name_ar":{"type":"string","minLength":1,"nullable":true},"legal_name_en":{"type":"string","minLength":1},"vat_reference":{"type":"string","minLength":1,"nullable":true},"commercial_registration_reference":{"type":"string","minLength":1,"nullable":true},"national_address_reference":{"type":"string","minLength":1,"nullable":true},"lifecycle_status":{"type":"string","enum":["active","suspended","closed"]},"resources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"capability_id":{"type":"string"},"lifecycle_status":{"type":"string"}},"required":["id","capability_id","lifecycle_status"],"additionalProperties":false}}},"required":["id","created_at","updated_at","platform_organization_id","external_reference","display_name","legal_name_ar","legal_name_en","vat_reference","commercial_registration_reference","national_address_reference","lifecycle_status","resources"],"additionalProperties":false}}}}}},"patch":{"tags":["connected-businesses"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"display_name":{"type":"string","minLength":1,"maxLength":160},"legal_name_ar":{"type":"string","minLength":1,"maxLength":160,"nullable":true},"legal_name_en":{"type":"string","minLength":1,"maxLength":160},"vat_reference":{"type":"string","minLength":1,"maxLength":120,"nullable":true},"lifecycle_status":{"type":"string","enum":["active","suspended","closed"]}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"platform_organization_id":{"type":"string","minLength":1},"external_reference":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"legal_name_ar":{"type":"string","minLength":1,"nullable":true},"legal_name_en":{"type":"string","minLength":1},"vat_reference":{"type":"string","minLength":1,"nullable":true},"commercial_registration_reference":{"type":"string","minLength":1,"nullable":true},"national_address_reference":{"type":"string","minLength":1,"nullable":true},"lifecycle_status":{"type":"string","enum":["active","suspended","closed"]}},"required":["id","created_at","updated_at","platform_organization_id","external_reference","display_name","legal_name_ar","legal_name_en","vat_reference","commercial_registration_reference","national_address_reference","lifecycle_status"],"additionalProperties":false}}}}}}},"/v1/connected-businesses/{id}/credentials":{"post":{"tags":["connected-businesses"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"product":{"type":"string","enum":["fatoorah","address"]},"name":{"type":"string","minLength":1,"maxLength":120,"default":"Connected business sandbox key"}},"required":["product"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"prefix":{"type":"string"},"full_key":{"type":"string"},"product":{"type":"string","enum":["fatoorah","address"]},"connected_business_id":{"type":"string","format":"uuid"},"service_resource_id":{"type":"string","format":"uuid"}},"required":["id","prefix","full_key","product","connected_business_id","service_resource_id"],"additionalProperties":false}}}}}}},"/v1/oauth/token":{"post":{"tags":["oauth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"grant_type":{"type":"string","enum":["client_credentials"]},"client_id":{"type":"string","minLength":1},"client_secret":{"type":"string","minLength":1},"scope":{"type":"string"}},"required":["grant_type","client_id","client_secret"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"access_token":{"type":"string"},"token_type":{"type":"string","enum":["Bearer"]},"expires_in":{"type":"number"},"scope":{"type":"string"}},"required":["access_token","token_type","expires_in","scope"],"additionalProperties":false}}}}}}},"/v1/organizations":{"post":{"tags":["organizations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"legal_name_ar":{"type":"string","minLength":1},"legal_name_en":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"organization_type":{"type":"string","enum":["standard_customer","reseller","vendor","white_label_tenant","internal"]},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"commercial_registration_reference":{"type":"string","minLength":1,"nullable":true},"vat_reference":{"type":"string","minLength":1,"nullable":true},"national_address_reference":{"type":"string","minLength":1,"nullable":true},"verification_status":{"type":"string","enum":["unverified","pending_review","verified","rejected"]},"risk_status":{"type":"string","enum":["normal","watch","restricted","suspended_risk"]},"data_residency_policy":{"type":"string","enum":["sa_only","sa_primary_intl_backup","unrestricted"]},"lifecycle_status":{"type":"string","enum":["pending","active","suspended","terminated","archived"]}},"required":["legal_name_ar","legal_name_en","display_name","organization_type","country"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"legal_name_ar":{"type":"string","minLength":1},"legal_name_en":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"organization_type":{"type":"string","enum":["standard_customer","reseller","vendor","white_label_tenant","internal"]},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"commercial_registration_reference":{"type":"string","minLength":1,"nullable":true},"vat_reference":{"type":"string","minLength":1,"nullable":true},"national_address_reference":{"type":"string","minLength":1,"nullable":true},"verification_status":{"type":"string","enum":["unverified","pending_review","verified","rejected"]},"risk_status":{"type":"string","enum":["normal","watch","restricted","suspended_risk"]},"data_residency_policy":{"type":"string","enum":["sa_only","sa_primary_intl_backup","unrestricted"]},"lifecycle_status":{"type":"string","enum":["pending","active","suspended","terminated","archived"]}},"required":["id","created_at","updated_at","legal_name_ar","legal_name_en","display_name","organization_type","country","commercial_registration_reference","vat_reference","national_address_reference","verification_status","risk_status","data_residency_policy","lifecycle_status"],"additionalProperties":false}}}}}}},"/v1/organizations/{id}":{"get":{"tags":["organizations"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"legal_name_ar":{"type":"string","minLength":1},"legal_name_en":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"organization_type":{"type":"string","enum":["standard_customer","reseller","vendor","white_label_tenant","internal"]},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"commercial_registration_reference":{"type":"string","minLength":1,"nullable":true},"vat_reference":{"type":"string","minLength":1,"nullable":true},"national_address_reference":{"type":"string","minLength":1,"nullable":true},"verification_status":{"type":"string","enum":["unverified","pending_review","verified","rejected"]},"risk_status":{"type":"string","enum":["normal","watch","restricted","suspended_risk"]},"data_residency_policy":{"type":"string","enum":["sa_only","sa_primary_intl_backup","unrestricted"]},"lifecycle_status":{"type":"string","enum":["pending","active","suspended","terminated","archived"]}},"required":["id","created_at","updated_at","legal_name_ar","legal_name_en","display_name","organization_type","country","commercial_registration_reference","vat_reference","national_address_reference","verification_status","risk_status","data_residency_policy","lifecycle_status"],"additionalProperties":false}}}}}}},"/v1/products":{"get":{"tags":["products"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"cursor","required":false},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":200},"in":"query","name":"limit","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"code":{"type":"string","minLength":1},"name_ar":{"type":"string","minLength":1},"name_en":{"type":"string","minLength":1},"description":{"type":"string","minLength":1},"category":{"type":"string","enum":["api_access","webhook_infrastructure","durable_job_execution","internal_provider_sandbox","other"]},"service_classification":{"type":"string","enum":["developer_platform","infrastructure","internal_tooling","support_service"]},"regulatory_classification":{"type":"string","enum":["ordinary_software","software_over_licensed_rail","regulated_pending_determination"]},"availability":{"type":"string","enum":["ga","beta","internal_only","deprecated"]},"required_documents":{"type":"array","items":{"type":"string","minLength":1}},"required_approvals":{"type":"array","items":{"type":"string","minLength":1}},"required_credentials":{"type":"array","items":{"type":"string","minLength":1}},"provisioning_workflow":{"type":"string","minLength":1},"metering_metrics":{"type":"array","items":{"type":"string","minLength":1}},"billing_model":{"type":"string","enum":["subscription","usage_based","hybrid","free"]},"termination_policy":{"type":"string","minLength":1}},"required":["id","created_at","updated_at","code","name_ar","name_en","description","category","service_classification","regulatory_classification","availability","required_documents","required_approvals","required_credentials","provisioning_workflow","metering_metrics","billing_model","termination_policy"],"additionalProperties":false}},"next_cursor":{"type":"string","nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}}},"/v1/plans":{"get":{"tags":["products"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"product_id","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"product_id":{"type":"string","minLength":1},"code":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"billing_period":{"type":"string","enum":["monthly","annual","usage_only","one_time"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"setup_fee":{"type":"integer","minimum":0,"nullable":true},"recurring_fee":{"type":"integer","minimum":0,"nullable":true},"included_usage":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","minLength":1},"quantity":{"type":"number","minimum":0}},"required":["metric","quantity"],"additionalProperties":false}},"overage_rules":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","minLength":1},"unit_price":{"type":"integer","minimum":0}},"required":["metric","unit_price"],"additionalProperties":false}},"minimum_commitment":{"type":"integer","minimum":0,"nullable":true},"trial_policy":{"type":"object","properties":{"trial_days":{"type":"integer","minimum":0},"requires_payment_method":{"type":"boolean"}},"required":["trial_days","requires_payment_method"],"additionalProperties":false,"nullable":true},"tax_policy_reference":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["draft","active","deprecated","retired"]},"prices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"plan_id":{"type":"string","minLength":1},"component_type":{"type":"string","enum":["recurring_fee","setup_fee","tiered_usage","graduated_usage","volume_usage","per_unit","package_pricing","credit","discount","minimum_spend"]},"metric":{"type":"string","minLength":1,"nullable":true},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"tax_treatment":{"type":"string","enum":["tax_exclusive","tax_inclusive"]},"amount":{"type":"integer","nullable":true},"unit_amount":{"type":"integer","minimum":0,"nullable":true},"tiers":{"type":"array","items":{"type":"object","properties":{"upper_bound":{"type":"number","minimum":0,"nullable":true},"unit_amount":{"type":"integer","minimum":0},"flat_amount":{"type":"integer","minimum":0,"nullable":true}},"required":["upper_bound","unit_amount","flat_amount"],"additionalProperties":false},"nullable":true},"package_size":{"type":"integer","exclusiveMinimum":true,"minimum":0,"nullable":true},"package_amount":{"type":"integer","minimum":0,"nullable":true},"status":{"type":"string","enum":["active","inactive"]}},"required":["id","created_at","updated_at","plan_id","component_type","metric","currency","tax_treatment","amount","unit_amount","tiers","package_size","package_amount","status"],"additionalProperties":false}}},"required":["id","created_at","updated_at","product_id","code","name","billing_period","currency","setup_fee","recurring_fee","included_usage","overage_rules","minimum_commitment","trial_policy","tax_policy_reference","status","prices"],"additionalProperties":false}},"next_cursor":{"enum":["null"],"nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}}},"/v1/products/{id}":{"get":{"tags":["products"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"code":{"type":"string","minLength":1},"name_ar":{"type":"string","minLength":1},"name_en":{"type":"string","minLength":1},"description":{"type":"string","minLength":1},"category":{"type":"string","enum":["api_access","webhook_infrastructure","durable_job_execution","internal_provider_sandbox","other"]},"service_classification":{"type":"string","enum":["developer_platform","infrastructure","internal_tooling","support_service"]},"regulatory_classification":{"type":"string","enum":["ordinary_software","software_over_licensed_rail","regulated_pending_determination"]},"availability":{"type":"string","enum":["ga","beta","internal_only","deprecated"]},"required_documents":{"type":"array","items":{"type":"string","minLength":1}},"required_approvals":{"type":"array","items":{"type":"string","minLength":1}},"required_credentials":{"type":"array","items":{"type":"string","minLength":1}},"provisioning_workflow":{"type":"string","minLength":1},"metering_metrics":{"type":"array","items":{"type":"string","minLength":1}},"billing_model":{"type":"string","enum":["subscription","usage_based","hybrid","free"]},"termination_policy":{"type":"string","minLength":1},"plans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"product_id":{"type":"string","minLength":1},"code":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"billing_period":{"type":"string","enum":["monthly","annual","usage_only","one_time"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"setup_fee":{"type":"integer","minimum":0,"nullable":true},"recurring_fee":{"type":"integer","minimum":0,"nullable":true},"included_usage":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","minLength":1},"quantity":{"type":"number","minimum":0}},"required":["metric","quantity"],"additionalProperties":false}},"overage_rules":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string","minLength":1},"unit_price":{"type":"integer","minimum":0}},"required":["metric","unit_price"],"additionalProperties":false}},"minimum_commitment":{"type":"integer","minimum":0,"nullable":true},"trial_policy":{"type":"object","properties":{"trial_days":{"type":"integer","minimum":0},"requires_payment_method":{"type":"boolean"}},"required":["trial_days","requires_payment_method"],"additionalProperties":false,"nullable":true},"tax_policy_reference":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["draft","active","deprecated","retired"]}},"required":["id","created_at","updated_at","product_id","code","name","billing_period","currency","setup_fee","recurring_fee","included_usage","overage_rules","minimum_commitment","trial_policy","tax_policy_reference","status"],"additionalProperties":false}}},"required":["id","created_at","updated_at","code","name_ar","name_en","description","category","service_classification","regulatory_classification","availability","required_documents","required_approvals","required_credentials","provisioning_workflow","metering_metrics","billing_model","termination_policy","plans"],"additionalProperties":false}}}}}}},"/v1/subscriptions":{"get":{"tags":["subscriptions"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"commercial_status":{"type":"string","enum":["active","past_due","cancelled","paused"]},"service_status":{"type":"string","enum":["provisioning","active","degraded","suspended","terminated"]},"billing_status":{"type":"string","enum":["current","overdue","in_dunning","written_off"]},"provisioning_request_id":{"type":"string","minLength":1,"nullable":true},"started_at":{"type":"string","format":"date-time"},"renews_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","plan_id","commercial_status","service_status","billing_status","provisioning_request_id","started_at","renews_at","suspended_at","terminated_at"],"additionalProperties":false}},"next_cursor":{"enum":["null"],"nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}},"post":{"tags":["subscriptions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"requested_configuration":{"type":"object","additionalProperties":{}}},"required":["organization_id","product_id","plan_id"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"commercial_status":{"type":"string","enum":["active","past_due","cancelled","paused"]},"service_status":{"type":"string","enum":["provisioning","active","degraded","suspended","terminated"]},"billing_status":{"type":"string","enum":["current","overdue","in_dunning","written_off"]},"provisioning_request_id":{"type":"string","minLength":1,"nullable":true},"started_at":{"type":"string","format":"date-time"},"renews_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","plan_id","commercial_status","service_status","billing_status","provisioning_request_id","started_at","renews_at","suspended_at","terminated_at"],"additionalProperties":false}}}}}}},"/v1/subscriptions/{id}/select-plan":{"post":{"tags":["subscriptions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"plan_id":{"type":"string","minLength":1}},"required":["plan_id"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"subscription":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"commercial_status":{"type":"string","enum":["active","past_due","cancelled","paused"]},"service_status":{"type":"string","enum":["provisioning","active","degraded","suspended","terminated"]},"billing_status":{"type":"string","enum":["current","overdue","in_dunning","written_off"]},"provisioning_request_id":{"type":"string","minLength":1,"nullable":true},"started_at":{"type":"string","format":"date-time"},"renews_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","plan_id","commercial_status","service_status","billing_status","provisioning_request_id","started_at","renews_at","suspended_at","terminated_at"],"additionalProperties":false},"invoice":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"billing_period":{"type":"object","properties":{"start":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"end":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["start","end"],"additionalProperties":false},"subtotal":{"type":"integer"},"discount":{"type":"integer","minimum":0},"tax":{"type":"integer","minimum":0},"total":{"type":"integer"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"status":{"type":"string","enum":["draft","issued","paid","partially_paid","void","uncollectible"]},"tax_document_status":{"type":"string","enum":["not_applicable","pending","issued","failed"]},"issued_at":{"type":"string","format":"date-time","nullable":true},"due_at":{"type":"string","format":"date-time","nullable":true},"paid_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","billing_period","subtotal","discount","tax","total","currency","status","tax_document_status","issued_at","due_at","paid_at"],"additionalProperties":false,"nullable":true},"activation":{"type":"string","enum":["active","awaiting_payment"]}},"required":["subscription","invoice","activation"],"additionalProperties":false}}}}}}},"/v1/subscriptions/{id}/cancel":{"post":{"tags":["subscriptions"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"commercial_status":{"type":"string","enum":["active","past_due","cancelled","paused"]},"service_status":{"type":"string","enum":["provisioning","active","degraded","suspended","terminated"]},"billing_status":{"type":"string","enum":["current","overdue","in_dunning","written_off"]},"provisioning_request_id":{"type":"string","minLength":1,"nullable":true},"started_at":{"type":"string","format":"date-time"},"renews_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","plan_id","commercial_status","service_status","billing_status","provisioning_request_id","started_at","renews_at","suspended_at","terminated_at"],"additionalProperties":false}}}}}}},"/v1/subscriptions/{id}/reactivate":{"post":{"tags":["subscriptions"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"commercial_status":{"type":"string","enum":["active","past_due","cancelled","paused"]},"service_status":{"type":"string","enum":["provisioning","active","degraded","suspended","terminated"]},"billing_status":{"type":"string","enum":["current","overdue","in_dunning","written_off"]},"provisioning_request_id":{"type":"string","minLength":1,"nullable":true},"started_at":{"type":"string","format":"date-time"},"renews_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","plan_id","commercial_status","service_status","billing_status","provisioning_request_id","started_at","renews_at","suspended_at","terminated_at"],"additionalProperties":false}}}}}}},"/v1/subscriptions/{id}":{"get":{"tags":["subscriptions"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"commercial_status":{"type":"string","enum":["active","past_due","cancelled","paused"]},"service_status":{"type":"string","enum":["provisioning","active","degraded","suspended","terminated"]},"billing_status":{"type":"string","enum":["current","overdue","in_dunning","written_off"]},"provisioning_request_id":{"type":"string","minLength":1,"nullable":true},"started_at":{"type":"string","format":"date-time"},"renews_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","plan_id","commercial_status","service_status","billing_status","provisioning_request_id","started_at","renews_at","suspended_at","terminated_at"],"additionalProperties":false}}}}}}},"/v1/subscriptions/{id}/suspend":{"post":{"tags":["subscriptions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"reason":{"type":"string","minLength":1}},"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"commercial_status":{"type":"string","enum":["active","past_due","cancelled","paused"]},"service_status":{"type":"string","enum":["provisioning","active","degraded","suspended","terminated"]},"billing_status":{"type":"string","enum":["current","overdue","in_dunning","written_off"]},"provisioning_request_id":{"type":"string","minLength":1,"nullable":true},"started_at":{"type":"string","format":"date-time"},"renews_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","plan_id","commercial_status","service_status","billing_status","provisioning_request_id","started_at","renews_at","suspended_at","terminated_at"],"additionalProperties":false}}}}}}},"/v1/subscriptions/{id}/resume":{"post":{"tags":["subscriptions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"reason":{"type":"string","minLength":1}},"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"commercial_status":{"type":"string","enum":["active","past_due","cancelled","paused"]},"service_status":{"type":"string","enum":["provisioning","active","degraded","suspended","terminated"]},"billing_status":{"type":"string","enum":["current","overdue","in_dunning","written_off"]},"provisioning_request_id":{"type":"string","minLength":1,"nullable":true},"started_at":{"type":"string","format":"date-time"},"renews_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","plan_id","commercial_status","service_status","billing_status","provisioning_request_id","started_at","renews_at","suspended_at","terminated_at"],"additionalProperties":false}}}}}}},"/v1/subscriptions/{id}/terminate":{"post":{"tags":["subscriptions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"reason":{"type":"string","minLength":1}},"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"commercial_status":{"type":"string","enum":["active","past_due","cancelled","paused"]},"service_status":{"type":"string","enum":["provisioning","active","degraded","suspended","terminated"]},"billing_status":{"type":"string","enum":["current","overdue","in_dunning","written_off"]},"provisioning_request_id":{"type":"string","minLength":1,"nullable":true},"started_at":{"type":"string","format":"date-time"},"renews_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","plan_id","commercial_status","service_status","billing_status","provisioning_request_id","started_at","renews_at","suspended_at","terminated_at"],"additionalProperties":false}}}}}}},"/v1/subscriptions/{id}/change-plan":{"post":{"tags":["subscriptions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"plan_id":{"type":"string","minLength":1}},"required":["plan_id"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"plan_id":{"type":"string","minLength":1},"commercial_status":{"type":"string","enum":["active","past_due","cancelled","paused"]},"service_status":{"type":"string","enum":["provisioning","active","degraded","suspended","terminated"]},"billing_status":{"type":"string","enum":["current","overdue","in_dunning","written_off"]},"provisioning_request_id":{"type":"string","minLength":1,"nullable":true},"started_at":{"type":"string","format":"date-time"},"renews_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","plan_id","commercial_status","service_status","billing_status","provisioning_request_id","started_at","renews_at","suspended_at","terminated_at"],"additionalProperties":false}}}}}}},"/v1/support-cases":{"get":{"tags":["support"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"cursor","required":false},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":200},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":true},{"schema":{"type":"string","enum":["open","in_progress","waiting_on_customer","resolved","closed"]},"in":"query","name":"status","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1,"nullable":true},"resource_id":{"type":"string","minLength":1,"nullable":true},"severity":{"type":"string","enum":["low","medium","high","critical"]},"category":{"type":"string","enum":["billing","technical","account","provisioning","other"]},"status":{"type":"string","enum":["open","in_progress","waiting_on_customer","resolved","closed"]},"assigned_team":{"type":"string","enum":["support","billing","security","provider_ops","platform"],"nullable":true},"subject":{"type":"string","minLength":1,"maxLength":160,"nullable":true,"default":null},"description":{"type":"string","minLength":1,"maxLength":8000,"nullable":true,"default":null},"request_id":{"type":"string","minLength":1,"maxLength":200,"nullable":true,"default":null},"environment":{"type":"string","minLength":1,"maxLength":80,"nullable":true,"default":null},"diagnostics":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]},"default":{}},"opened_at":{"type":"string","format":"date-time"},"resolved_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","resource_id","severity","category","status","assigned_team","opened_at","resolved_at"],"additionalProperties":false}},"next_cursor":{"type":"string","nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}},"post":{"tags":["support"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1,"nullable":true},"resource_id":{"type":"string","minLength":1,"nullable":true},"subject":{"type":"string","minLength":3,"maxLength":160},"description":{"type":"string","minLength":10,"maxLength":8000},"severity":{"type":"string","enum":["low","medium","high","critical"]},"category":{"type":"string","enum":["billing","technical","account","provisioning","other"]},"request_id":{"type":"string","minLength":1,"maxLength":200,"nullable":true},"environment":{"type":"string","minLength":1,"maxLength":80,"nullable":true},"diagnostics":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]}}},"required":["organization_id","subject","description","severity","category"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1,"nullable":true},"resource_id":{"type":"string","minLength":1,"nullable":true},"severity":{"type":"string","enum":["low","medium","high","critical"]},"category":{"type":"string","enum":["billing","technical","account","provisioning","other"]},"status":{"type":"string","enum":["open","in_progress","waiting_on_customer","resolved","closed"]},"assigned_team":{"type":"string","enum":["support","billing","security","provider_ops","platform"],"nullable":true},"subject":{"type":"string","minLength":1,"maxLength":160,"nullable":true,"default":null},"description":{"type":"string","minLength":1,"maxLength":8000,"nullable":true,"default":null},"request_id":{"type":"string","minLength":1,"maxLength":200,"nullable":true,"default":null},"environment":{"type":"string","minLength":1,"maxLength":80,"nullable":true,"default":null},"diagnostics":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]},"default":{}},"opened_at":{"type":"string","format":"date-time"},"resolved_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","resource_id","severity","category","status","assigned_team","opened_at","resolved_at"],"additionalProperties":false}}}}}}},"/v1/support-cases/{id}":{"get":{"tags":["support"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1,"nullable":true},"resource_id":{"type":"string","minLength":1,"nullable":true},"severity":{"type":"string","enum":["low","medium","high","critical"]},"category":{"type":"string","enum":["billing","technical","account","provisioning","other"]},"status":{"type":"string","enum":["open","in_progress","waiting_on_customer","resolved","closed"]},"assigned_team":{"type":"string","enum":["support","billing","security","provider_ops","platform"],"nullable":true},"subject":{"type":"string","minLength":1,"maxLength":160,"nullable":true,"default":null},"description":{"type":"string","minLength":1,"maxLength":8000,"nullable":true,"default":null},"request_id":{"type":"string","minLength":1,"maxLength":200,"nullable":true,"default":null},"environment":{"type":"string","minLength":1,"maxLength":80,"nullable":true,"default":null},"diagnostics":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]},"default":{}},"opened_at":{"type":"string","format":"date-time"},"resolved_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","resource_id","severity","category","status","assigned_team","opened_at","resolved_at"],"additionalProperties":false}}}}}}},"/v1/support-cases/{id}/close":{"post":{"tags":["support"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1,"nullable":true},"resource_id":{"type":"string","minLength":1,"nullable":true},"severity":{"type":"string","enum":["low","medium","high","critical"]},"category":{"type":"string","enum":["billing","technical","account","provisioning","other"]},"status":{"type":"string","enum":["open","in_progress","waiting_on_customer","resolved","closed"]},"assigned_team":{"type":"string","enum":["support","billing","security","provider_ops","platform"],"nullable":true},"subject":{"type":"string","minLength":1,"maxLength":160,"nullable":true,"default":null},"description":{"type":"string","minLength":1,"maxLength":8000,"nullable":true,"default":null},"request_id":{"type":"string","minLength":1,"maxLength":200,"nullable":true,"default":null},"environment":{"type":"string","minLength":1,"maxLength":80,"nullable":true,"default":null},"diagnostics":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]},"default":{}},"opened_at":{"type":"string","format":"date-time"},"resolved_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","resource_id","severity","category","status","assigned_team","opened_at","resolved_at"],"additionalProperties":false}}}}}}},"/v1/spend-controls":{"get":{"tags":["billing"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string"},"product":{"type":"string","enum":["fatoorah","address","platform"]},"warning_threshold_percent":{"type":"integer"},"monthly_budget_minor_units":{"type":"integer","nullable":true},"hard_operation_limit":{"type":"integer","nullable":true},"notification_recipients":{"type":"array","items":{"type":"string","format":"email"}},"enabled":{"type":"boolean"},"current_operations":{"type":"number"},"warning_reached":{"type":"boolean"},"hard_limit_reached":{"type":"boolean"}},"required":["id","organization_id","product","warning_threshold_percent","monthly_budget_minor_units","hard_operation_limit","notification_recipients","enabled","current_operations","warning_reached","hard_limit_reached"],"additionalProperties":false}}}}}}}},"/v1/spend-controls/{product}":{"put":{"tags":["billing"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string"},"warning_threshold_percent":{"type":"integer"},"monthly_budget_minor_units":{"type":"integer","nullable":true},"hard_operation_limit":{"type":"integer","nullable":true},"notification_recipients":{"type":"array","items":{"type":"string","format":"email"},"maxItems":10},"enabled":{"type":"boolean"}},"required":["organization_id","warning_threshold_percent","monthly_budget_minor_units","hard_operation_limit","notification_recipients","enabled"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","enum":["fatoorah","address","platform"]},"in":"path","name":"product","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string"},"product":{"type":"string","enum":["fatoorah","address","platform"]},"warning_threshold_percent":{"type":"integer"},"monthly_budget_minor_units":{"type":"integer","nullable":true},"hard_operation_limit":{"type":"integer","nullable":true},"notification_recipients":{"type":"array","items":{"type":"string","format":"email"}},"enabled":{"type":"boolean"}},"required":["id","organization_id","product","warning_threshold_percent","monthly_budget_minor_units","hard_operation_limit","notification_recipients","enabled"],"additionalProperties":false}}}}}}},"/v1/growth/events":{"post":{"tags":["growth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"event_name":{"type":"string","enum":["page_view","product_view","pricing_view","docs_view","tool_used","signup_clicked","signup_started","email_verified","organization_created","product_selected","sandbox_provisioned","credential_created","quickstart_opened","first_request","first_success","webhook_created","plan_selected","payment_started","subscription_active","production_requested","address_activated","experiment_exposed"]},"occurred_at":{"type":"string","format":"date-time"},"anonymous_id":{"type":"string","minLength":8,"maxLength":200},"organization_id":{"type":"string","minLength":1,"maxLength":200},"product":{"type":"string","enum":["fatoorah","address","platform"]},"traffic_type":{"type":"string","enum":["public","real_customer","sandbox_customer","employee","internal","synthetic","automated_qa","load_test"],"default":"public"},"source":{"type":"string","maxLength":200},"medium":{"type":"string","maxLength":200},"campaign":{"type":"string","maxLength":200},"landing_page":{"type":"string","maxLength":500},"page_path":{"type":"string","maxLength":500},"language":{"type":"string","enum":["en","ar"]},"device_class":{"type":"string","enum":["mobile","desktop","tablet","server"]},"use_case":{"type":"string","maxLength":200},"developer_language":{"type":"string","maxLength":100},"experiment_id":{"type":"string","maxLength":120},"experiment_variant":{"type":"string","maxLength":80},"elapsed_from_signup_ms":{"type":"integer","minimum":0},"properties":{"type":"object","additionalProperties":{"anyOf":[{"type":"string","maxLength":500},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]},"default":{}}},"required":["event_name","organization_id"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accepted":{"type":"boolean","enum":[true]}},"required":["accepted"],"additionalProperties":false}}}}}}},"/v1/growth/summary":{"get":{"tags":["growth"],"parameters":[{"schema":{"type":"string","format":"date-time"},"in":"query","name":"since","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{}}}}}}},"/v1/api-keys":{"post":{"tags":["api-keys"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"environment":{"type":"string","enum":["sandbox","production"]},"scopes":{"type":"array","items":{"type":"string","enum":["organizations:read","organizations:write","products:read","subscriptions:read","subscriptions:write","api-keys:read","api-keys:write","webhooks:read","webhooks:write","jobs:read","jobs:write","usage:read","invoices:read","invoices:write","payments:read","payments:write","service-resources:read","connected-businesses:read","connected-businesses:write","audit-events:read","growth-events:read","growth-events:write","support:read","support:write","zatca-egs:read","zatca-egs:write","address:read","address:verify","invoice:validate","invoice:generate","invoice:submit","invoice:archive","usage:read","webhooks:manage","whatsapp:manage","whatsapp:send","whatsapp:webhook","conversations:read","conversations:manage","campaigns:read","campaigns:manage"]},"minItems":1},"allowed_origins":{"type":"array","items":{"type":"string","minLength":1}},"allowed_ips":{"type":"array","items":{"type":"string","minLength":1}},"rate_limit_policy":{"type":"string","minLength":1,"nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true}},"required":["organization_id","name","environment","scopes"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"prefix":{"type":"string","minLength":1},"environment":{"type":"string","enum":["sandbox","production"]},"scopes":{"type":"array","items":{"type":"string","minLength":1}},"allowed_origins":{"type":"array","items":{"type":"string","minLength":1}},"allowed_ips":{"type":"array","items":{"type":"string","minLength":1}},"rate_limit_policy":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["active","revoked","expired"]},"created_by":{"type":"string","minLength":1},"last_used_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"revoked_at":{"type":"string","format":"date-time","nullable":true},"secret":{"type":"string"},"full_key":{"type":"string"}},"required":["id","created_at","updated_at","organization_id","name","prefix","environment","scopes","allowed_origins","allowed_ips","rate_limit_policy","status","created_by","last_used_at","expires_at","revoked_at","secret","full_key"],"additionalProperties":false}}}}}},"get":{"tags":["api-keys"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"cursor","required":false},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":200},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"prefix":{"type":"string","minLength":1},"environment":{"type":"string","enum":["sandbox","production"]},"scopes":{"type":"array","items":{"type":"string","minLength":1}},"allowed_origins":{"type":"array","items":{"type":"string","minLength":1}},"allowed_ips":{"type":"array","items":{"type":"string","minLength":1}},"rate_limit_policy":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["active","revoked","expired"]},"created_by":{"type":"string","minLength":1},"last_used_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"revoked_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","name","prefix","environment","scopes","allowed_origins","allowed_ips","rate_limit_policy","status","created_by","last_used_at","expires_at","revoked_at"],"additionalProperties":false}},"next_cursor":{"type":"string","nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}}},"/v1/api-keys/{id}":{"delete":{"tags":["api-keys"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"prefix":{"type":"string","minLength":1},"environment":{"type":"string","enum":["sandbox","production"]},"scopes":{"type":"array","items":{"type":"string","minLength":1}},"allowed_origins":{"type":"array","items":{"type":"string","minLength":1}},"allowed_ips":{"type":"array","items":{"type":"string","minLength":1}},"rate_limit_policy":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["active","revoked","expired"]},"created_by":{"type":"string","minLength":1},"last_used_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"revoked_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","name","prefix","environment","scopes","allowed_origins","allowed_ips","rate_limit_policy","status","created_by","last_used_at","expires_at","revoked_at"],"additionalProperties":false}}}}}}},"/v1/webhook-endpoints":{"post":{"tags":["webhook-endpoints"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"event_types":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"signing_method":{"type":"string","enum":["hmac_sha256"]},"connected_business_id":{"type":"string","format":"uuid"},"product":{"type":"string","enum":["fatoorah","address"]}},"required":["organization_id","url","event_types"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"connected_business_id":{"type":"string","minLength":1,"nullable":true},"url":{"type":"string","format":"uri"},"event_types":{"type":"array","items":{"type":"string","minLength":1}},"signing_method":{"type":"string","enum":["hmac_sha256"]},"secret_reference":{"type":"string","minLength":1},"status":{"type":"string","enum":["active","disabled","failing"]},"failure_count":{"type":"integer","minimum":0},"last_success_at":{"type":"string","format":"date-time","nullable":true},"last_failure_at":{"type":"string","format":"date-time","nullable":true},"secret":{"type":"string"}},"required":["id","created_at","updated_at","organization_id","url","event_types","signing_method","secret_reference","status","failure_count","last_success_at","last_failure_at","secret"],"additionalProperties":false}}}}}},"get":{"tags":["webhook-endpoints"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"cursor","required":false},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":200},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"connected_business_id","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"connected_business_id":{"type":"string","minLength":1,"nullable":true},"url":{"type":"string","format":"uri"},"event_types":{"type":"array","items":{"type":"string","minLength":1}},"signing_method":{"type":"string","enum":["hmac_sha256"]},"secret_reference":{"type":"string","minLength":1},"status":{"type":"string","enum":["active","disabled","failing"]},"failure_count":{"type":"integer","minimum":0},"last_success_at":{"type":"string","format":"date-time","nullable":true},"last_failure_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","url","event_types","signing_method","secret_reference","status","failure_count","last_success_at","last_failure_at"],"additionalProperties":false}},"next_cursor":{"type":"string","nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}}},"/v1/webhook-endpoints/{id}/test":{"post":{"tags":["webhook-endpoints"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"delivery_id":{"type":"string"},"status":{"type":"string","enum":["delivered","failed","dead_letter"]},"response_code":{"type":"integer","nullable":true}},"required":["delivery_id","status","response_code"],"additionalProperties":false}}}}}}},"/v1/webhook-deliveries/{id}/replay":{"post":{"tags":["webhook-deliveries"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"reason":{"type":"string","minLength":1}},"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"delivery_id":{"type":"string"},"attempt":{"type":"integer"},"status":{"type":"string","enum":["delivered","failed","dead_letter"]},"response_code":{"type":"integer","nullable":true}},"required":["delivery_id","attempt","status","response_code"],"additionalProperties":false}}}}}}},"/v1/jobs":{"post":{"tags":["jobs"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"job_type":{"type":"string","minLength":1},"payload":{"type":"object","additionalProperties":{},"default":{}}},"required":["organization_id","job_type"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"job_type":{"type":"string"},"status":{"type":"string","enum":["queued","running","succeeded","failed","cancelled"]},"payload":{"type":"object","additionalProperties":{}},"result":{"type":"object","additionalProperties":{},"nullable":true},"error_code":{"type":"string","nullable":true},"attempts":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"completed_at":{"type":"string","nullable":true}},"required":["id","organization_id","job_type","status","payload","result","error_code","attempts","created_at","updated_at","completed_at"],"additionalProperties":false}}}}}}},"/v1/jobs/{id}":{"get":{"tags":["jobs"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":false},{"schema":{"type":"string","minLength":1},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization_id":{"type":"string"},"job_type":{"type":"string"},"status":{"type":"string","enum":["queued","running","succeeded","failed","cancelled"]},"payload":{"type":"object","additionalProperties":{}},"result":{"type":"object","additionalProperties":{},"nullable":true},"error_code":{"type":"string","nullable":true},"attempts":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"completed_at":{"type":"string","nullable":true}},"required":["id","organization_id","job_type","status","payload","result","error_code","attempts","created_at","updated_at","completed_at"],"additionalProperties":false}}}}}}},"/v1/usage":{"get":{"tags":["usage"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"cursor","required":false},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":200},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"subscription_id","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"metric","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"connected_business_id","required":false},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"from","required":false},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"to","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"connected_business_id":{"type":"string","minLength":1,"nullable":true},"subscription_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"capability_id":{"type":"string","minLength":1},"provider_id":{"type":"string","minLength":1,"nullable":true},"metric":{"type":"string","minLength":1},"quantity":{"type":"number","minimum":0},"unit":{"type":"string","minLength":1},"occurred_at":{"type":"string","format":"date-time"},"received_at":{"type":"string","format":"date-time"},"source_event_id":{"type":"string","minLength":1,"nullable":true},"idempotency_key":{"type":"string","minLength":1},"dimensions":{"type":"object","additionalProperties":{}}},"required":["id","organization_id","subscription_id","product_id","capability_id","provider_id","metric","quantity","unit","occurred_at","received_at","source_event_id","idempotency_key","dimensions"],"additionalProperties":false}},"next_cursor":{"type":"string","nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}}},"/v1/invoices":{"get":{"tags":["invoices"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"cursor","required":false},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":200},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"billing_period":{"type":"object","properties":{"start":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"end":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["start","end"],"additionalProperties":false},"subtotal":{"type":"integer"},"discount":{"type":"integer","minimum":0},"tax":{"type":"integer","minimum":0},"total":{"type":"integer"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"status":{"type":"string","enum":["draft","issued","paid","partially_paid","void","uncollectible"]},"tax_document_status":{"type":"string","enum":["not_applicable","pending","issued","failed"]},"issued_at":{"type":"string","format":"date-time","nullable":true},"due_at":{"type":"string","format":"date-time","nullable":true},"paid_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","billing_period","subtotal","discount","tax","total","currency","status","tax_document_status","issued_at","due_at","paid_at"],"additionalProperties":false}},"next_cursor":{"type":"string","nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}}},"/v1/invoices/{id}":{"get":{"tags":["invoices"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"billing_period":{"type":"object","properties":{"start":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"end":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["start","end"],"additionalProperties":false},"subtotal":{"type":"integer"},"discount":{"type":"integer","minimum":0},"tax":{"type":"integer","minimum":0},"total":{"type":"integer"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"status":{"type":"string","enum":["draft","issued","paid","partially_paid","void","uncollectible"]},"tax_document_status":{"type":"string","enum":["not_applicable","pending","issued","failed"]},"issued_at":{"type":"string","format":"date-time","nullable":true},"due_at":{"type":"string","format":"date-time","nullable":true},"paid_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","billing_period","subtotal","discount","tax","total","currency","status","tax_document_status","issued_at","due_at","paid_at"],"additionalProperties":false}}}}}}},"/v1/invoices/{id}/payment-session":{"post":{"tags":["invoices"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"payment_id":{"type":"string"},"checkout_reference":{"type":"string"},"checkout_url":{"type":"string"},"expires_at":{"type":"string"}},"required":["payment_id","checkout_reference","checkout_url","expires_at"],"additionalProperties":false}}}}}}},"/v1/payments":{"get":{"tags":["payments"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"invoice_id":{"type":"string","minLength":1},"provider":{"type":"string","minLength":1},"provider_reference":{"type":"string","minLength":1,"nullable":true},"amount":{"type":"integer","minimum":0},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"status":{"type":"string","enum":["created","pending_customer_action","authorized","captured","paid","failed","cancelled","refund_pending","partially_refunded","refunded","chargeback_or_dispute","settled","reconciliation_exception"]},"checkout_reference":{"type":"string","minLength":1,"nullable":true},"idempotency_key":{"type":"string","minLength":1,"nullable":true},"authorized_at":{"type":"string","format":"date-time","nullable":true},"captured_at":{"type":"string","format":"date-time","nullable":true},"failed_at":{"type":"string","format":"date-time","nullable":true},"refunded_at":{"type":"string","format":"date-time","nullable":true},"settled_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","invoice_id","provider","provider_reference","amount","currency","status","checkout_reference","idempotency_key","authorized_at","captured_at","failed_at","refunded_at","settled_at"],"additionalProperties":false}},"next_cursor":{"enum":["null"],"nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}}},"/v1/payments/{id}":{"get":{"tags":["payments"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"invoice_id":{"type":"string","minLength":1},"provider":{"type":"string","minLength":1},"provider_reference":{"type":"string","minLength":1,"nullable":true},"amount":{"type":"integer","minimum":0},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"status":{"type":"string","enum":["created","pending_customer_action","authorized","captured","paid","failed","cancelled","refund_pending","partially_refunded","refunded","chargeback_or_dispute","settled","reconciliation_exception"]},"checkout_reference":{"type":"string","minLength":1,"nullable":true},"idempotency_key":{"type":"string","minLength":1,"nullable":true},"authorized_at":{"type":"string","format":"date-time","nullable":true},"captured_at":{"type":"string","format":"date-time","nullable":true},"failed_at":{"type":"string","format":"date-time","nullable":true},"refunded_at":{"type":"string","format":"date-time","nullable":true},"settled_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","invoice_id","provider","provider_reference","amount","currency","status","checkout_reference","idempotency_key","authorized_at","captured_at","failed_at","refunded_at","settled_at"],"additionalProperties":false}}}}}}},"/v1/payments/{id}/refund-request":{"post":{"tags":["payments"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","exclusiveMinimum":true,"minimum":0},"reason":{"type":"string","minLength":1}},"required":["reason"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"invoice_id":{"type":"string","minLength":1},"provider":{"type":"string","minLength":1},"provider_reference":{"type":"string","minLength":1,"nullable":true},"amount":{"type":"integer","minimum":0},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"status":{"type":"string","enum":["created","pending_customer_action","authorized","captured","paid","failed","cancelled","refund_pending","partially_refunded","refunded","chargeback_or_dispute","settled","reconciliation_exception"]},"checkout_reference":{"type":"string","minLength":1,"nullable":true},"idempotency_key":{"type":"string","minLength":1,"nullable":true},"authorized_at":{"type":"string","format":"date-time","nullable":true},"captured_at":{"type":"string","format":"date-time","nullable":true},"failed_at":{"type":"string","format":"date-time","nullable":true},"refunded_at":{"type":"string","format":"date-time","nullable":true},"settled_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","invoice_id","provider","provider_reference","amount","currency","status","checkout_reference","idempotency_key","authorized_at","captured_at","failed_at","refunded_at","settled_at"],"additionalProperties":false}}}}}}},"/v1/service-resources":{"get":{"tags":["service-resources"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"cursor","required":false},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":200},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"subscription_id","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"subscription_id":{"type":"string","minLength":1},"capability_id":{"type":"string","minLength":1},"provider_id":{"type":"string","minLength":1},"external_reference":{"type":"string","minLength":1,"nullable":true},"region":{"type":"string","minLength":1,"nullable":true},"configuration":{"type":"object","additionalProperties":{}},"lifecycle_status":{"type":"string","enum":["provisioning","active","degraded","suspended","migrating","terminated","failed"]},"provisioned_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","subscription_id","capability_id","provider_id","external_reference","region","configuration","lifecycle_status","provisioned_at","suspended_at","terminated_at"],"additionalProperties":false}},"next_cursor":{"type":"string","nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}}},"/v1/service-resources/{id}":{"get":{"tags":["service-resources"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"product_id":{"type":"string","minLength":1},"subscription_id":{"type":"string","minLength":1},"capability_id":{"type":"string","minLength":1},"provider_id":{"type":"string","minLength":1},"external_reference":{"type":"string","minLength":1,"nullable":true},"region":{"type":"string","minLength":1,"nullable":true},"configuration":{"type":"object","additionalProperties":{}},"lifecycle_status":{"type":"string","enum":["provisioning","active","degraded","suspended","migrating","terminated","failed"]},"provisioned_at":{"type":"string","format":"date-time","nullable":true},"suspended_at":{"type":"string","format":"date-time","nullable":true},"terminated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","product_id","subscription_id","capability_id","provider_id","external_reference","region","configuration","lifecycle_status","provisioned_at","suspended_at","terminated_at"],"additionalProperties":false}}}}}}},"/v1/audit-events":{"get":{"tags":["audit-events"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"cursor","required":false},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":200},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"resource_type","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"resource_id","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"actor_type":{"type":"string","enum":["user","api_key","system","provider_webhook","break_glass"]},"actor_id":{"type":"string","minLength":1},"organization_id":{"type":"string","minLength":1,"nullable":true},"action":{"type":"string","minLength":1},"resource_type":{"type":"string","minLength":1},"resource_id":{"type":"string","minLength":1},"before_hash":{"type":"string","minLength":1,"nullable":true},"after_hash":{"type":"string","minLength":1,"nullable":true},"reason":{"type":"string","minLength":1,"nullable":true},"request_id":{"type":"string","minLength":1,"nullable":true},"ip_metadata":{"type":"object","additionalProperties":{},"nullable":true},"occurred_at":{"type":"string","format":"date-time"}},"required":["id","actor_type","actor_id","organization_id","action","resource_type","resource_id","before_hash","after_hash","reason","request_id","ip_metadata","occurred_at"],"additionalProperties":false}},"next_cursor":{"type":"string","nullable":true}},"required":["items","next_cursor"],"additionalProperties":false}}}}}}},"/v1/campaigns":{"post":{"tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]},"channel":{"type":"string","enum":["whatsapp","sms","email","voice"]},"sender_identity_id":{"type":"string","minLength":1},"template_reference":{"type":"string","minLength":1,"nullable":true},"audience_query":{"type":"object","additionalProperties":{}},"schedule":{"type":"object","additionalProperties":{},"nullable":true},"frequency_policy_id":{"type":"string","minLength":1,"nullable":true},"budget":{"type":"object","additionalProperties":{},"nullable":true},"approval_status":{"type":"string","enum":["not_required","pending","approved","rejected"]}},"required":["organization_id","purpose","channel","sender_identity_id","audience_query"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]},"channel":{"type":"string","enum":["whatsapp","sms","email","voice"]},"sender_identity_id":{"type":"string","minLength":1},"template_reference":{"type":"string","nullable":true},"audience_query":{"type":"object","additionalProperties":{}},"schedule":{"type":"object","additionalProperties":{},"nullable":true},"frequency_policy_id":{"type":"string","nullable":true},"budget":{"type":"object","additionalProperties":{},"nullable":true},"approval_status":{"type":"string","enum":["not_required","pending","approved","rejected"]},"status":{"type":"string","enum":["DRAFT","AUDIENCE_REVIEW","CONSENT_REVIEW","CONTENT_REVIEW","APPROVAL_REQUIRED","SCHEDULED","RUNNING","PAUSED","COMPLETED","CANCELLED","BLOCKED"]},"last_preflight_result":{"type":"object","properties":{"totalCount":{"type":"integer","minimum":0},"eligibleContactIds":{"type":"array","items":{"type":"string","minLength":1}},"suppressedContactIds":{"type":"array","items":{"type":"string","minLength":1}},"noConsentContactIds":{"type":"array","items":{"type":"string","minLength":1}},"wrongOrganizationContactIds":{"type":"array","items":{"type":"string","minLength":1}},"eligibleCount":{"type":"integer","minimum":0}},"required":["totalCount","eligibleContactIds","suppressedContactIds","noConsentContactIds","wrongOrganizationContactIds","eligibleCount"],"additionalProperties":false,"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organization_id","purpose","channel","sender_identity_id","template_reference","audience_query","schedule","frequency_policy_id","budget","approval_status","status","last_preflight_result","created_at","updated_at"],"additionalProperties":false}}}}}}},"/v1/campaigns/{id}":{"get":{"tags":["campaigns"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]},"channel":{"type":"string","enum":["whatsapp","sms","email","voice"]},"sender_identity_id":{"type":"string","minLength":1},"template_reference":{"type":"string","nullable":true},"audience_query":{"type":"object","additionalProperties":{}},"schedule":{"type":"object","additionalProperties":{},"nullable":true},"frequency_policy_id":{"type":"string","nullable":true},"budget":{"type":"object","additionalProperties":{},"nullable":true},"approval_status":{"type":"string","enum":["not_required","pending","approved","rejected"]},"status":{"type":"string","enum":["DRAFT","AUDIENCE_REVIEW","CONSENT_REVIEW","CONTENT_REVIEW","APPROVAL_REQUIRED","SCHEDULED","RUNNING","PAUSED","COMPLETED","CANCELLED","BLOCKED"]},"last_preflight_result":{"type":"object","properties":{"totalCount":{"type":"integer","minimum":0},"eligibleContactIds":{"type":"array","items":{"type":"string","minLength":1}},"suppressedContactIds":{"type":"array","items":{"type":"string","minLength":1}},"noConsentContactIds":{"type":"array","items":{"type":"string","minLength":1}},"wrongOrganizationContactIds":{"type":"array","items":{"type":"string","minLength":1}},"eligibleCount":{"type":"integer","minimum":0}},"required":["totalCount","eligibleContactIds","suppressedContactIds","noConsentContactIds","wrongOrganizationContactIds","eligibleCount"],"additionalProperties":false,"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organization_id","purpose","channel","sender_identity_id","template_reference","audience_query","schedule","frequency_policy_id","budget","approval_status","status","last_preflight_result","created_at","updated_at"],"additionalProperties":false}}}}}}},"/v1/campaigns/{id}/preflight":{"post":{"tags":["campaigns"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contactIds":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"required":["contactIds"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"totalCount":{"type":"integer","minimum":0},"eligibleContactIds":{"type":"array","items":{"type":"string","minLength":1}},"suppressedContactIds":{"type":"array","items":{"type":"string","minLength":1}},"noConsentContactIds":{"type":"array","items":{"type":"string","minLength":1}},"wrongOrganizationContactIds":{"type":"array","items":{"type":"string","minLength":1}},"eligibleCount":{"type":"integer","minimum":0}},"required":["totalCount","eligibleContactIds","suppressedContactIds","noConsentContactIds","wrongOrganizationContactIds","eligibleCount"],"additionalProperties":false}}}}}}},"/v1/campaigns/{id}/approve":{"post":{"tags":["campaigns"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]},"channel":{"type":"string","enum":["whatsapp","sms","email","voice"]},"sender_identity_id":{"type":"string","minLength":1},"template_reference":{"type":"string","nullable":true},"audience_query":{"type":"object","additionalProperties":{}},"schedule":{"type":"object","additionalProperties":{},"nullable":true},"frequency_policy_id":{"type":"string","nullable":true},"budget":{"type":"object","additionalProperties":{},"nullable":true},"approval_status":{"type":"string","enum":["not_required","pending","approved","rejected"]},"status":{"type":"string","enum":["DRAFT","AUDIENCE_REVIEW","CONSENT_REVIEW","CONTENT_REVIEW","APPROVAL_REQUIRED","SCHEDULED","RUNNING","PAUSED","COMPLETED","CANCELLED","BLOCKED"]},"last_preflight_result":{"type":"object","properties":{"totalCount":{"type":"integer","minimum":0},"eligibleContactIds":{"type":"array","items":{"type":"string","minLength":1}},"suppressedContactIds":{"type":"array","items":{"type":"string","minLength":1}},"noConsentContactIds":{"type":"array","items":{"type":"string","minLength":1}},"wrongOrganizationContactIds":{"type":"array","items":{"type":"string","minLength":1}},"eligibleCount":{"type":"integer","minimum":0}},"required":["totalCount","eligibleContactIds","suppressedContactIds","noConsentContactIds","wrongOrganizationContactIds","eligibleCount"],"additionalProperties":false,"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organization_id","purpose","channel","sender_identity_id","template_reference","audience_query","schedule","frequency_policy_id","budget","approval_status","status","last_preflight_result","created_at","updated_at"],"additionalProperties":false}}}}}}},"/v1/campaigns/{id}/launch":{"post":{"tags":["campaigns"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]},"channel":{"type":"string","enum":["whatsapp","sms","email","voice"]},"sender_identity_id":{"type":"string","minLength":1},"template_reference":{"type":"string","nullable":true},"audience_query":{"type":"object","additionalProperties":{}},"schedule":{"type":"object","additionalProperties":{},"nullable":true},"frequency_policy_id":{"type":"string","nullable":true},"budget":{"type":"object","additionalProperties":{},"nullable":true},"approval_status":{"type":"string","enum":["not_required","pending","approved","rejected"]},"status":{"type":"string","enum":["DRAFT","AUDIENCE_REVIEW","CONSENT_REVIEW","CONTENT_REVIEW","APPROVAL_REQUIRED","SCHEDULED","RUNNING","PAUSED","COMPLETED","CANCELLED","BLOCKED"]},"last_preflight_result":{"type":"object","properties":{"totalCount":{"type":"integer","minimum":0},"eligibleContactIds":{"type":"array","items":{"type":"string","minLength":1}},"suppressedContactIds":{"type":"array","items":{"type":"string","minLength":1}},"noConsentContactIds":{"type":"array","items":{"type":"string","minLength":1}},"wrongOrganizationContactIds":{"type":"array","items":{"type":"string","minLength":1}},"eligibleCount":{"type":"integer","minimum":0}},"required":["totalCount","eligibleContactIds","suppressedContactIds","noConsentContactIds","wrongOrganizationContactIds","eligibleCount"],"additionalProperties":false,"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organization_id","purpose","channel","sender_identity_id","template_reference","audience_query","schedule","frequency_policy_id","budget","approval_status","status","last_preflight_result","created_at","updated_at"],"additionalProperties":false}}}}}}},"/v1/conversations":{"get":{"tags":["conversations"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":false},{"schema":{"type":"string","enum":["open","pending","snoozed","closed"]},"in":"query","name":"status","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"queue","required":false},{"schema":{"type":"string","minLength":1},"in":"query","name":"assigned_agent","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"contact_id":{"type":"string","minLength":1},"channel":{"type":"string","enum":["whatsapp","sms","email","voice"]},"sender_identity_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["open","pending","snoozed","closed"]},"assigned_team":{"type":"string","nullable":true},"assigned_user":{"type":"string","minLength":1,"nullable":true},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"tags":{"type":"array","items":{"type":"string"}},"opened_at":{"type":"string","format":"date-time"},"last_activity_at":{"type":"string","format":"date-time"},"closed_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","contact_id","channel","sender_identity_id","status","assigned_team","assigned_user","priority","tags","opened_at","last_activity_at","closed_at"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false}}}}}}},"/v1/conversations/{id}":{"get":{"tags":["conversations"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"contact_id":{"type":"string","minLength":1},"channel":{"type":"string","enum":["whatsapp","sms","email","voice"]},"sender_identity_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["open","pending","snoozed","closed"]},"assigned_team":{"type":"string","nullable":true},"assigned_user":{"type":"string","minLength":1,"nullable":true},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"tags":{"type":"array","items":{"type":"string"}},"opened_at":{"type":"string","format":"date-time"},"last_activity_at":{"type":"string","format":"date-time"},"closed_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","contact_id","channel","sender_identity_id","status","assigned_team","assigned_user","priority","tags","opened_at","last_activity_at","closed_at"],"additionalProperties":false}}}}}}},"/v1/conversations/{id}/assign":{"post":{"tags":["conversations"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"agent_id":{"type":"string","minLength":1}},"required":["agent_id"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"contact_id":{"type":"string","minLength":1},"channel":{"type":"string","enum":["whatsapp","sms","email","voice"]},"sender_identity_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["open","pending","snoozed","closed"]},"assigned_team":{"type":"string","nullable":true},"assigned_user":{"type":"string","minLength":1,"nullable":true},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"tags":{"type":"array","items":{"type":"string"}},"opened_at":{"type":"string","format":"date-time"},"last_activity_at":{"type":"string","format":"date-time"},"closed_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","contact_id","channel","sender_identity_id","status","assigned_team","assigned_user","priority","tags","opened_at","last_activity_at","closed_at"],"additionalProperties":false}}}}}}},"/v1/conversations/{id}/resolve":{"post":{"tags":["conversations"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"contact_id":{"type":"string","minLength":1},"channel":{"type":"string","enum":["whatsapp","sms","email","voice"]},"sender_identity_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["open","pending","snoozed","closed"]},"assigned_team":{"type":"string","nullable":true},"assigned_user":{"type":"string","minLength":1,"nullable":true},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"tags":{"type":"array","items":{"type":"string"}},"opened_at":{"type":"string","format":"date-time"},"last_activity_at":{"type":"string","format":"date-time"},"closed_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","contact_id","channel","sender_identity_id","status","assigned_team","assigned_user","priority","tags","opened_at","last_activity_at","closed_at"],"additionalProperties":false}}}}}}},"/v1/address/verify":{"post":{"tags":["address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"candidate":{"type":"object","properties":{"country_code":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"string"},"building_number":{"type":"string"},"secondary_number":{"type":"string"},"postal_code":{"type":"string"},"short_address":{"type":"string"},"additional_number":{"type":"string"},"unit_number":{"type":"string"},"language":{"type":"string","enum":["ar","en"]}},"additionalProperties":false},"organization_id":{"type":"string","minLength":1}},"required":["candidate"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","enum":["VERIFIED","PARTIALLY_VERIFIED","AMBIGUOUS","NOT_FOUND","INVALID","PROVIDER_UNAVAILABLE","MANUAL_REVIEW_RECOMMENDED"]},"address":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1,"nullable":true},"country_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","pattern":"^[A-Z]{2}$"}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"street_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"street_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"building_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"secondary_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"postal_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"short_address":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","pattern":"^[A-Z]{4}\\d{4}$"}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"unit_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"latitude":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"number","minimum":-90,"maximum":90}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"longitude":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"number","minimum":-180,"maximum":180}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"additional_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"address_type":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","enum":["residential","commercial","government","mixed_use","po_box","unspecified"]}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"source":{"type":"string","enum":["spl","customer_provided","technominds_normalized"]},"source_reference":{"type":"string","minLength":1,"nullable":true},"verification_status":{"type":"string","enum":["VERIFIED","PARTIALLY_VERIFIED","AMBIGUOUS","NOT_FOUND","INVALID","PROVIDER_UNAVAILABLE","MANUAL_REVIEW_RECOMMENDED"]},"verified_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","country_code","region_code","region_name_ar","region_name_en","city_code","city_name_ar","city_name_en","district_code","district_name_ar","district_name_en","street_name_ar","street_name_en","building_number","secondary_number","postal_code","short_address","unit_number","latitude","longitude","additional_number","address_type","source","source_reference","verification_status","verified_at"],"additionalProperties":false,"nullable":true},"explanation_en":{"type":"string"},"explanation_ar":{"type":"string","nullable":true},"warnings":{"type":"array","items":{"type":"string"}}},"required":["result","address","explanation_en","explanation_ar","warnings"],"additionalProperties":false}}}}}}},"/v1/address/resolve-short":{"post":{"tags":["address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"short_address":{"type":"string","minLength":1},"language":{"type":"string","enum":["ar","en"]},"organization_id":{"type":"string","minLength":1}},"required":["short_address"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","enum":["VERIFIED","PARTIALLY_VERIFIED","AMBIGUOUS","NOT_FOUND","INVALID","PROVIDER_UNAVAILABLE","MANUAL_REVIEW_RECOMMENDED"]},"address":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1,"nullable":true},"country_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","pattern":"^[A-Z]{2}$"}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"street_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"street_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"building_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"secondary_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"postal_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"short_address":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","pattern":"^[A-Z]{4}\\d{4}$"}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"unit_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"latitude":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"number","minimum":-90,"maximum":90}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"longitude":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"number","minimum":-180,"maximum":180}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"additional_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"address_type":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","enum":["residential","commercial","government","mixed_use","po_box","unspecified"]}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"source":{"type":"string","enum":["spl","customer_provided","technominds_normalized"]},"source_reference":{"type":"string","minLength":1,"nullable":true},"verification_status":{"type":"string","enum":["VERIFIED","PARTIALLY_VERIFIED","AMBIGUOUS","NOT_FOUND","INVALID","PROVIDER_UNAVAILABLE","MANUAL_REVIEW_RECOMMENDED"]},"verified_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","country_code","region_code","region_name_ar","region_name_en","city_code","city_name_ar","city_name_en","district_code","district_name_ar","district_name_en","street_name_ar","street_name_en","building_number","secondary_number","postal_code","short_address","unit_number","latitude","longitude","additional_number","address_type","source","source_reference","verification_status","verified_at"],"additionalProperties":false,"nullable":true},"explanation_en":{"type":"string"},"explanation_ar":{"type":"string","nullable":true},"warnings":{"type":"array","items":{"type":"string"}}},"required":["result","address","explanation_en","explanation_ar","warnings"],"additionalProperties":false}}}}}}},"/v1/address/search":{"post":{"tags":["address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1},"region_code":{"type":"string"},"city_code":{"type":"string"},"limit":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":100},"language":{"type":"string","enum":["ar","en"]},"organization_id":{"type":"string","minLength":1}},"required":["query"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"address":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1,"nullable":true},"country_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","pattern":"^[A-Z]{2}$"}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"street_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"street_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"building_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"secondary_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"postal_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"short_address":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","pattern":"^[A-Z]{4}\\d{4}$"}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"unit_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"latitude":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"number","minimum":-90,"maximum":90}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"longitude":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"number","minimum":-180,"maximum":180}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"additional_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"address_type":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","enum":["residential","commercial","government","mixed_use","po_box","unspecified"]}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"source":{"type":"string","enum":["spl","customer_provided","technominds_normalized"]},"source_reference":{"type":"string","minLength":1,"nullable":true},"verification_status":{"type":"string","enum":["VERIFIED","PARTIALLY_VERIFIED","AMBIGUOUS","NOT_FOUND","INVALID","PROVIDER_UNAVAILABLE","MANUAL_REVIEW_RECOMMENDED"]},"verified_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","country_code","region_code","region_name_ar","region_name_en","city_code","city_name_ar","city_name_en","district_code","district_name_ar","district_name_en","street_name_ar","street_name_en","building_number","secondary_number","postal_code","short_address","unit_number","latitude","longitude","additional_number","address_type","source","source_reference","verification_status","verified_at"],"additionalProperties":false},"score":{"type":"number"}},"required":["address","score"],"additionalProperties":false}}},"required":["results"],"additionalProperties":false}}}}}}},"/v1/address/resolve-location":{"post":{"tags":["address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"radius_meters":{"type":"number","exclusiveMinimum":true,"minimum":0},"language":{"type":"string","enum":["ar","en"]},"organization_id":{"type":"string","minLength":1}},"required":["latitude","longitude"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","enum":["VERIFIED","PARTIALLY_VERIFIED","AMBIGUOUS","NOT_FOUND","INVALID","PROVIDER_UNAVAILABLE","MANUAL_REVIEW_RECOMMENDED"]},"candidates":{"type":"array","items":{"type":"object","properties":{"address":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1,"nullable":true},"country_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","pattern":"^[A-Z]{2}$"}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"street_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"street_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"building_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"secondary_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"postal_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"short_address":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","pattern":"^[A-Z]{4}\\d{4}$"}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"unit_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"latitude":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"number","minimum":-90,"maximum":90}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"longitude":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"number","minimum":-180,"maximum":180}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"additional_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"address_type":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","enum":["residential","commercial","government","mixed_use","po_box","unspecified"]}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"source":{"type":"string","enum":["spl","customer_provided","technominds_normalized"]},"source_reference":{"type":"string","minLength":1,"nullable":true},"verification_status":{"type":"string","enum":["VERIFIED","PARTIALLY_VERIFIED","AMBIGUOUS","NOT_FOUND","INVALID","PROVIDER_UNAVAILABLE","MANUAL_REVIEW_RECOMMENDED"]},"verified_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","country_code","region_code","region_name_ar","region_name_en","city_code","city_name_ar","city_name_en","district_code","district_name_ar","district_name_en","street_name_ar","street_name_en","building_number","secondary_number","postal_code","short_address","unit_number","latitude","longitude","additional_number","address_type","source","source_reference","verification_status","verified_at"],"additionalProperties":false},"distance_meters":{"type":"number"}},"required":["address","distance_meters"],"additionalProperties":false}}},"required":["result","candidates"],"additionalProperties":false}}}}}}},"/v1/address/batch-verify":{"post":{"tags":["address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string","minLength":1},"candidate":{"type":"object","properties":{"country_code":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"string"},"building_number":{"type":"string"},"secondary_number":{"type":"string"},"postal_code":{"type":"string"},"short_address":{"type":"string"},"additional_number":{"type":"string"},"unit_number":{"type":"string"},"language":{"type":"string","enum":["ar","en"]}},"additionalProperties":false}},"required":["reference","candidate"],"additionalProperties":false},"minItems":1,"maxItems":1000},"organization_id":{"type":"string","minLength":1}},"required":["items"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"batch_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["queued","processing","completed","failed","partially_completed"]},"item_count":{"type":"integer"},"submitted_at":{"type":"string"}},"required":["batch_id","status","item_count","submitted_at"],"additionalProperties":false}}}}}}},"/v1/address/batch-verify/{id}":{"get":{"tags":["address"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"batch_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["queued","processing","completed","failed","partially_completed"]},"item_count":{"type":"integer"},"completed_count":{"type":"integer"},"failed_count":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"reference":{"type":"string"},"result":{"type":"string","enum":["VERIFIED","PARTIALLY_VERIFIED","AMBIGUOUS","NOT_FOUND","INVALID","PROVIDER_UNAVAILABLE","MANUAL_REVIEW_RECOMMENDED"]},"address":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1,"nullable":true},"country_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","pattern":"^[A-Z]{2}$"}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"region_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"city_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"district_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"street_name_ar":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"street_name_en":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"building_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"secondary_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"postal_code":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"short_address":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","pattern":"^[A-Z]{4}\\d{4}$"}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"unit_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"latitude":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"number","minimum":-90,"maximum":90}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"longitude":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"number","minimum":-180,"maximum":180}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"additional_number":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","minLength":1}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"address_type":{"anyOf":[{"type":"object","properties":{"presence":{"type":"string","enum":["present"]},"value":{"type":"string","enum":["residential","commercial","government","mixed_use","po_box","unspecified"]}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["missing"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["unknown"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["not_applicable"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["withheld"]},"value":{"enum":["null"],"nullable":true}},"required":["presence","value"],"additionalProperties":false},{"type":"object","properties":{"presence":{"type":"string","enum":["invalid"]},"invalid_raw":{"type":"string","nullable":true}},"required":["presence","invalid_raw"],"additionalProperties":false}]},"source":{"type":"string","enum":["spl","customer_provided","technominds_normalized"]},"source_reference":{"type":"string","minLength":1,"nullable":true},"verification_status":{"type":"string","enum":["VERIFIED","PARTIALLY_VERIFIED","AMBIGUOUS","NOT_FOUND","INVALID","PROVIDER_UNAVAILABLE","MANUAL_REVIEW_RECOMMENDED"]},"verified_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","created_at","updated_at","organization_id","country_code","region_code","region_name_ar","region_name_en","city_code","city_name_ar","city_name_en","district_code","district_name_ar","district_name_en","street_name_ar","street_name_en","building_number","secondary_number","postal_code","short_address","unit_number","latitude","longitude","additional_number","address_type","source","source_reference","verification_status","verified_at"],"additionalProperties":false,"nullable":true}},"required":["reference","result","address"],"additionalProperties":false}},"submitted_at":{"type":"string"},"completed_at":{"type":"string","nullable":true}},"required":["batch_id","status","item_count","completed_count","failed_count","results","submitted_at","completed_at"],"additionalProperties":false}}}}}}},"/v1/address/regions":{"get":{"tags":["address"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"region_code":{"type":"string"},"region_name_ar":{"type":"string"},"region_name_en":{"type":"string"}},"required":["region_code","region_name_ar","region_name_en"],"additionalProperties":false}}}}}}}},"/v1/address/cities":{"get":{"tags":["address"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"region_code","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"city_code":{"type":"string"},"city_name_ar":{"type":"string"},"city_name_en":{"type":"string"},"region_code":{"type":"string"}},"required":["city_code","city_name_ar","city_name_en","region_code"],"additionalProperties":false}}}}}}}},"/v1/address/districts":{"get":{"tags":["address"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"city_code","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"district_code":{"type":"string"},"district_name_ar":{"type":"string"},"district_name_en":{"type":"string"},"city_code":{"type":"string"}},"required":["district_code","district_name_ar","district_name_en","city_code"],"additionalProperties":false}}}}}}}},"/v1/provider-network/dossiers":{"post":{"tags":["provider-network"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"candidate_id":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"capability_code":{"type":"string","minLength":1},"suggested_operating_model":{"type":"string","minLength":1},"legal_entity_evidence_reference":{"type":"string","minLength":1,"nullable":true},"authority_evidence_reference":{"type":"string","minLength":1,"nullable":true},"contract_reference":{"type":"string","minLength":1,"nullable":true},"data_role_evidence_reference":{"type":"string","minLength":1,"nullable":true},"processing_locations":{"type":"array","items":{"type":"string","minLength":2}},"credential_vault_reference":{"type":"string","minLength":1,"nullable":true},"credential_owner_reference":{"type":"string","minLength":1,"nullable":true},"notes":{"type":"string","maxLength":10000,"nullable":true}},"required":["candidate_id","display_name","capability_code","suggested_operating_model"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response"}}},"get":{"tags":["provider-network"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response"}}}},"/v1/provider-network/dossiers/{id}/status":{"patch":{"tags":["provider-network"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["discovered","account_connection_pending","evidence_review_pending","contract_pending","sandbox_pending","blocked","rejected"]},"notes":{"type":"string","maxLength":10000,"nullable":true},"reason":{"type":"string","minLength":1,"maxLength":2000}},"required":["status","reason"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response"}}}},"/v1/provider-network/dossiers/{id}/connectors":{"post":{"tags":["provider-network"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","minLength":1},"execution_mode":{"type":"string","minLength":1},"provenance_reference":{"type":"string","minLength":1},"contract_reference":{"type":"string","minLength":1},"egress_allowlist":{"type":"array","items":{"type":"string","minLength":3,"maxLength":253,"pattern":"^(?=.{1,253}$)(?!localhost$)(?!.*\\.localhost$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$"},"minItems":1,"default":[]},"secret_references":{"type":"array","items":{"type":"string","minLength":3,"maxLength":500},"minItems":1,"default":[]}},"required":["version","execution_mode","provenance_reference","contract_reference","egress_allowlist","secret_references"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response"}}}},"/v1/provider-network/dossiers/{id}/conformance-runs":{"post":{"tags":["provider-network"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connector_id":{"type":"string","format":"uuid"},"environment":{"type":"string","enum":["sandbox"]},"functional_status":{"type":"string","enum":["not_run","running","failed","invalidated"],"default":"not_run"},"reliability_status":{"type":"string","enum":["not_run","running","failed","invalidated"],"default":"not_run"},"security_status":{"type":"string","enum":["not_run","running","failed","invalidated"],"default":"not_run"},"billing_status":{"type":"string","enum":["not_run","running","failed","invalidated"],"default":"not_run"},"exit_status":{"type":"string","enum":["not_run","running","failed","invalidated"],"default":"not_run"},"evidence_reference":{"type":"string","minLength":1,"nullable":true},"result_summary":{"type":"object","additionalProperties":{},"default":{}}},"required":["connector_id","environment"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response"}}}},"/v1/whatsapp/business-accounts":{"post":{"tags":["whatsapp"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"sender_identity_id":{"type":"string","minLength":1},"meta_waba_id":{"type":"string","minLength":1,"nullable":true},"business_verification_status":{"type":"string","minLength":1}},"required":["organization_id","sender_identity_id","business_verification_status"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"sender_identity_id":{"type":"string","minLength":1},"meta_waba_id":{"type":"string","nullable":true},"business_verification_status":{"type":"string","minLength":1},"status":{"type":"string","enum":["active","suspended"]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","organization_id","sender_identity_id","meta_waba_id","business_verification_status","status","created_at","updated_at"],"additionalProperties":false}}}}}}},"/v1/whatsapp/phone-numbers":{"post":{"tags":["whatsapp"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"waba_id":{"type":"string","minLength":1},"sender_identity_id":{"type":"string","minLength":1},"phone_number":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"platform_status":{"type":"string","minLength":1,"nullable":true},"environment":{"type":"string","enum":["sandbox","production"]}},"required":["organization_id","waba_id","sender_identity_id","phone_number","display_name","environment"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"waba_id":{"type":"string","minLength":1},"sender_identity_id":{"type":"string","minLength":1},"phone_number":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"platform_status":{"type":"string","nullable":true},"environment":{"type":"string","enum":["sandbox","production"]},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","waba_id","sender_identity_id","phone_number","display_name","platform_status","environment","created_at","updated_at"],"additionalProperties":false}}}}}}},"/v1/whatsapp/templates":{"post":{"tags":["whatsapp"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"waba_id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"language":{"type":"string","minLength":1},"category":{"type":"string","enum":["AUTHENTICATION","UTILITY","MARKETING","SERVICE"]},"components":{},"variables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"example":{"type":"string"}},"required":["name","example"],"additionalProperties":false}},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]}},"required":["organization_id","waba_id","name","language","category","purpose"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"waba_id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"language":{"type":"string","minLength":1},"category":{"type":"string","enum":["AUTHENTICATION","UTILITY","MARKETING","SERVICE"]},"components":{},"variables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"example":{"type":"string"}},"required":["name","example"],"additionalProperties":false}},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]},"version":{"type":"integer","exclusiveMinimum":true,"minimum":0},"supersedes_template_id":{"type":"string","nullable":true},"provider_status":{"type":"string","nullable":true},"quality_status":{"type":"string","nullable":true},"status":{"type":"string","enum":["DRAFT","INTERNAL_REVIEW","SUBMITTED","APPROVED","REJECTED","PAUSED","DISABLED","SUPERSEDED"]},"last_reviewed_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","waba_id","name","language","category","variables","purpose","version","supersedes_template_id","provider_status","quality_status","status","last_reviewed_at","created_at","updated_at"],"additionalProperties":false}}}}}}},"/v1/whatsapp/templates/{id}/submit":{"post":{"tags":["whatsapp"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"waba_id":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"language":{"type":"string","minLength":1},"category":{"type":"string","enum":["AUTHENTICATION","UTILITY","MARKETING","SERVICE"]},"components":{},"variables":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"example":{"type":"string"}},"required":["name","example"],"additionalProperties":false}},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]},"version":{"type":"integer","exclusiveMinimum":true,"minimum":0},"supersedes_template_id":{"type":"string","nullable":true},"provider_status":{"type":"string","nullable":true},"quality_status":{"type":"string","nullable":true},"status":{"type":"string","enum":["DRAFT","INTERNAL_REVIEW","SUBMITTED","APPROVED","REJECTED","PAUSED","DISABLED","SUPERSEDED"]},"last_reviewed_at":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","waba_id","name","language","category","variables","purpose","version","supersedes_template_id","provider_status","quality_status","status","last_reviewed_at","created_at","updated_at"],"additionalProperties":false}}}}}}},"/v1/whatsapp/messages":{"post":{"tags":["whatsapp"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"contactId":{"type":"string","minLength":1},"phoneNumberId":{"type":"string","minLength":1},"templateId":{"type":"string","minLength":1,"nullable":true},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]},"environment":{"type":"string","enum":["sandbox","production"]},"idempotencyKey":{"type":"string","minLength":1},"content":{}},"required":["organizationId","contactId","phoneNumberId","templateId","purpose","environment","idempotencyKey"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"sent":{"type":"boolean","enum":[true]},"message":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"conversation_id":{"type":"string","nullable":true},"contact_id":{"type":"string","minLength":1},"phone_number_id":{"type":"string","minLength":1},"direction":{"type":"string","enum":["inbound","outbound"]},"template_id":{"type":"string","nullable":true},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]},"status":{"type":"string","enum":["QUEUED","SUBMITTED","ACCEPTED","DELIVERED","READ","FAILED","UNKNOWN_OUTCOME"]},"provider_message_reference":{"type":"string","nullable":true},"idempotency_key":{"type":"string","nullable":true},"cost":{"type":"integer","nullable":true},"error":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","organization_id","conversation_id","contact_id","phone_number_id","direction","template_id","purpose","status","provider_message_reference","idempotency_key","cost","error","created_at","updated_at"],"additionalProperties":false},"idempotentReplay":{"type":"boolean"}},"required":["sent","message","idempotentReplay"],"additionalProperties":false},{"type":"object","properties":{"sent":{"type":"boolean","enum":[false]},"reason":{"type":"string"}},"required":["sent","reason"],"additionalProperties":false}]}}}}}}},"/v1/whatsapp/webhook":{"post":{"tags":["whatsapp"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1},"contactId":{"type":"string","minLength":1},"phoneNumberId":{"type":"string","minLength":1},"content":{},"providerMessageReference":{"type":"string","minLength":1,"nullable":true},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]}},"required":["organizationId","contactId","phoneNumberId"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"conversation_id":{"type":"string","nullable":true},"contact_id":{"type":"string","minLength":1},"phone_number_id":{"type":"string","minLength":1},"direction":{"type":"string","enum":["inbound","outbound"]},"template_id":{"type":"string","nullable":true},"purpose":{"type":"string","enum":["ACCOUNT_SECURITY","AUTHENTICATION","ORDER_UPDATE","DELIVERY_UPDATE","APPOINTMENT_REMINDER","PAYMENT_REMINDER","SERVICE_ALERT","CUSTOMER_SUPPORT","CUSTOMER_REQUESTED_INFORMATION","MARKETING","REENGAGEMENT","SURVEY","LEGAL_NOTICE","OTHER_REVIEWED_PURPOSE"]},"status":{"type":"string","enum":["QUEUED","SUBMITTED","ACCEPTED","DELIVERED","READ","FAILED","UNKNOWN_OUTCOME"]},"provider_message_reference":{"type":"string","nullable":true},"idempotency_key":{"type":"string","nullable":true},"cost":{"type":"integer","nullable":true},"error":{"type":"string","nullable":true},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","organization_id","conversation_id","contact_id","phone_number_id","direction","template_id","purpose","status","provider_message_reference","idempotency_key","cost","error","created_at","updated_at"],"additionalProperties":false},"conversationId":{"type":"string"},"conversationCreated":{"type":"boolean"}},"required":["message","conversationId","conversationCreated"],"additionalProperties":false}}}}}}},"/v1/zatca/egs-units":{"post":{"tags":["zatca-egs"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"taxpayer_profile_id":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"device_reference":{"type":"string","minLength":1,"nullable":true},"branch_reference":{"type":"string","minLength":1,"nullable":true},"environment":{"type":"string","enum":["sandbox","production"]}},"required":["organization_id","taxpayer_profile_id","display_name","environment"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"taxpayer_profile_id":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"device_reference":{"type":"string","nullable":true},"branch_reference":{"type":"string","nullable":true},"environment":{"type":"string","enum":["sandbox","production"]},"status":{"type":"string","enum":["DRAFT","REQUIREMENTS_PENDING","CUSTOMER_AUTHORIZATION_PENDING","CSR_READY","COMPLIANCE_ONBOARDING","COMPLIANCE_ACTIVE","PRODUCTION_AUTHORIZATION_PENDING","PRODUCTION_ONBOARDING","PRODUCTION_ACTIVE","RENEWAL_DUE","SUSPENDED","REVOKED","TERMINATED"]},"credential_set_id":{"type":"string","minLength":1,"nullable":true},"invoice_counter":{"type":"integer","minimum":0},"previous_invoice_hash":{"type":"string","nullable":true},"last_submission_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organization_id","taxpayer_profile_id","display_name","device_reference","branch_reference","environment","status","credential_set_id","invoice_counter","previous_invoice_hash","last_submission_at","created_at","updated_at"],"additionalProperties":false}}}}}}},"/v1/zatca/egs-units/{egsUnitId}":{"get":{"tags":["zatca-egs"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"egsUnitId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"taxpayer_profile_id":{"type":"string","minLength":1},"display_name":{"type":"string","minLength":1},"device_reference":{"type":"string","nullable":true},"branch_reference":{"type":"string","nullable":true},"environment":{"type":"string","enum":["sandbox","production"]},"status":{"type":"string","enum":["DRAFT","REQUIREMENTS_PENDING","CUSTOMER_AUTHORIZATION_PENDING","CSR_READY","COMPLIANCE_ONBOARDING","COMPLIANCE_ACTIVE","PRODUCTION_AUTHORIZATION_PENDING","PRODUCTION_ONBOARDING","PRODUCTION_ACTIVE","RENEWAL_DUE","SUSPENDED","REVOKED","TERMINATED"]},"credential_set_id":{"type":"string","minLength":1,"nullable":true},"invoice_counter":{"type":"integer","minimum":0},"previous_invoice_hash":{"type":"string","nullable":true},"last_submission_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organization_id","taxpayer_profile_id","display_name","device_reference","branch_reference","environment","status","credential_set_id","invoice_counter","previous_invoice_hash","last_submission_at","created_at","updated_at"],"additionalProperties":false}}}}}}},"/v1/zatca/egs-units/{egsUnitId}/csr":{"post":{"tags":["zatca-egs"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"egs_unit_id":{"type":"string","format":"uuid"},"common_name":{"type":"string","minLength":1},"organization_identifier":{"type":"string","minLength":1},"organization_unit_name":{"type":"string","minLength":1},"unit_name":{"type":"string","minLength":1}},"required":["egs_unit_id","common_name","organization_identifier"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"egsUnitId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"egs_unit_id":{"type":"string","format":"uuid"},"csr_pem":{"type":"string"},"private_key_reference":{"type":"string"},"status":{"type":"string","enum":["DRAFT","REQUIREMENTS_PENDING","CUSTOMER_AUTHORIZATION_PENDING","CSR_READY","COMPLIANCE_ONBOARDING","COMPLIANCE_ACTIVE","PRODUCTION_AUTHORIZATION_PENDING","PRODUCTION_ONBOARDING","PRODUCTION_ACTIVE","RENEWAL_DUE","SUSPENDED","REVOKED","TERMINATED"]}},"required":["egs_unit_id","csr_pem","private_key_reference","status"],"additionalProperties":false}}}}}}},"/v1/zatca/egs-units/{egsUnitId}/compliance-onboard":{"post":{"tags":["zatca-egs"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"egs_unit_id":{"type":"string","format":"uuid"},"customer_action_id":{"type":"string","format":"uuid"},"otp":{"type":"string"}},"required":["egs_unit_id","customer_action_id","otp"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"egsUnitId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"egs_unit_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["DRAFT","REQUIREMENTS_PENDING","CUSTOMER_AUTHORIZATION_PENDING","CSR_READY","COMPLIANCE_ONBOARDING","COMPLIANCE_ACTIVE","PRODUCTION_AUTHORIZATION_PENDING","PRODUCTION_ONBOARDING","PRODUCTION_ACTIVE","RENEWAL_DUE","SUSPENDED","REVOKED","TERMINATED"]},"compliance_credential_reference":{"type":"string","nullable":true}},"required":["egs_unit_id","status","compliance_credential_reference"],"additionalProperties":false}}}}}}},"/v1/zatca/egs-units/{egsUnitId}/production-onboard":{"post":{"tags":["zatca-egs"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"egs_unit_id":{"type":"string","format":"uuid"},"customer_action_id":{"type":"string","format":"uuid"}},"required":["egs_unit_id","customer_action_id"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"egsUnitId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"egs_unit_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["DRAFT","REQUIREMENTS_PENDING","CUSTOMER_AUTHORIZATION_PENDING","CSR_READY","COMPLIANCE_ONBOARDING","COMPLIANCE_ACTIVE","PRODUCTION_AUTHORIZATION_PENDING","PRODUCTION_ONBOARDING","PRODUCTION_ACTIVE","RENEWAL_DUE","SUSPENDED","REVOKED","TERMINATED"]},"production_credential_reference":{"type":"string","nullable":true},"customer_action_required":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","minLength":1},"action_type":{"type":"string","enum":["supply_taxpayer_identity","approve_egs_onboarding","enter_portal_otp","authorize_production_onboarding","review_taxpayer_details","revoke_egs","approve_credential_renewal","confirm_branch_association"]},"why_required":{"type":"string","minLength":1},"taxpayer":{"type":"string","minLength":1},"authorized_actor":{"type":"string","nullable":true},"exact_steps":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"expires_at":{"type":"string","format":"date-time"},"security_warning":{"type":"string","minLength":1},"blocked_workflow":{"type":"string","minLength":1},"completion_evidence":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["pending","completed","expired","cancelled"]},"otp_attempts":{"type":"array","items":{"type":"object","properties":{"attempted_at":{"type":"string","format":"date-time"},"outcome":{"type":"string","enum":["success","failure","expired","attempts_exceeded"]},"attempt_number":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["attempted_at","outcome","attempt_number"],"additionalProperties":false}},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","organization_id","action_type","why_required","taxpayer","authorized_actor","exact_steps","expires_at","security_warning","blocked_workflow","completion_evidence","status","otp_attempts","created_at","updated_at"],"additionalProperties":false,"nullable":true}},"required":["egs_unit_id","status","production_credential_reference","customer_action_required"],"additionalProperties":false}}}}}}},"/v1/zatca/egs-units/{egsUnitId}/credentials/renew":{"post":{"tags":["zatca-egs"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"egs_unit_id":{"type":"string","format":"uuid"},"credential_type":{"type":"string","enum":["compliance","production"]}},"required":["egs_unit_id","credential_type"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"egsUnitId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"egs_unit_id":{"type":"string","format":"uuid"},"credential_type":{"type":"string","enum":["compliance","production"]},"status":{"type":"string","enum":["renewed","revoked","pending"]},"effective_at":{"type":"string"}},"required":["egs_unit_id","credential_type","status","effective_at"],"additionalProperties":false}}}}}}},"/v1/zatca/egs-units/{egsUnitId}/credentials/revoke":{"post":{"tags":["zatca-egs"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"egs_unit_id":{"type":"string","format":"uuid"},"credential_type":{"type":"string","enum":["compliance","production"]},"reason":{"type":"string","minLength":1}},"required":["egs_unit_id","credential_type","reason"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"egsUnitId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"egs_unit_id":{"type":"string","format":"uuid"},"credential_type":{"type":"string","enum":["compliance","production"]},"status":{"type":"string","enum":["renewed","revoked","pending"]},"effective_at":{"type":"string"}},"required":["egs_unit_id","credential_type","status","effective_at"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices":{"get":{"tags":["zatca-invoices"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"organization_id","required":false},{"schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"in":"query","name":"limit","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["DRAFT","VALIDATING","INVALID","VALID","GENERATED","SECURITY_PREPARED","SUBMISSION_PENDING","SUBMITTING","REPORTED","CLEARED","REJECTED","UNKNOWN_OUTCOME","RETRY_PENDING","CANCELLED","CREDITED","DEBITED","ARCHIVED"]},"identity":{"type":"object","properties":{"invoice_id":{"type":"string","minLength":1},"invoice_number":{"type":"string","minLength":1},"uuid":{"type":"string","format":"uuid"},"issue_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"issue_time":{"type":"string","pattern":"^\\d{2}:\\d{2}:\\d{2}$"},"invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"transaction_type":{"type":"string","nullable":true},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"tax_currency":{"type":"string","pattern":"^[A-Z]{3}$"},"previous_invoice_hash":{"type":"string","nullable":true},"invoice_counter_value":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["invoice_id","invoice_number","uuid","issue_date","issue_time","invoice_type","transaction_type","currency","tax_currency","previous_invoice_hash","invoice_counter_value"],"additionalProperties":false},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason","line_extension_amount","tax_amount","total_amount"],"additionalProperties":false},"minItems":1},"totals":{"type":"object","properties":{"line_extension_total":{"type":"integer"},"allowance_total":{"type":"integer","minimum":0},"charge_total":{"type":"integer","minimum":0},"tax_exclusive_total":{"type":"integer"},"tax_total":{"type":"integer","minimum":0},"rounding_amount":{"type":"integer"},"tax_inclusive_total":{"type":"integer"},"prepaid_amount":{"type":"integer","minimum":0},"payable_amount":{"type":"integer"}},"required":["line_extension_total","allowance_total","charge_total","tax_exclusive_total","tax_total","rounding_amount","tax_inclusive_total","prepaid_amount","payable_amount"],"additionalProperties":false},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"required":["credit_note_reference","debit_note_reference","cancellation_reason","adjustment_reason","original_invoice_references"],"additionalProperties":false},"compliance_extension":{"type":"object","properties":{"spec_version":{"type":"string","minLength":1},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["cryptographic_stamp","qr_payload_base64","invoice_hash_base64","ecdsa_signature_base64","ecdsa_public_key_base64","ecdsa_public_key_signature_base64","clearance_status","compliance_csid_reference","production_csid_reference","submission_uuid"]},"value":{"type":"string"},"source_rule_id":{"type":"string","minLength":1,"nullable":true}},"required":["key","value","source_rule_id"],"additionalProperties":false}}},"required":["spec_version","fields"],"additionalProperties":false,"nullable":true}},"required":["id","created_at","updated_at","organization_id","egs_unit_id","taxpayer_profile_id","status","identity","seller","buyer","supply","line_items","totals","notes","compliance_extension"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/{id}":{"get":{"tags":["zatca-invoices"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["DRAFT","VALIDATING","INVALID","VALID","GENERATED","SECURITY_PREPARED","SUBMISSION_PENDING","SUBMITTING","REPORTED","CLEARED","REJECTED","UNKNOWN_OUTCOME","RETRY_PENDING","CANCELLED","CREDITED","DEBITED","ARCHIVED"]},"identity":{"type":"object","properties":{"invoice_id":{"type":"string","minLength":1},"invoice_number":{"type":"string","minLength":1},"uuid":{"type":"string","format":"uuid"},"issue_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"issue_time":{"type":"string","pattern":"^\\d{2}:\\d{2}:\\d{2}$"},"invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"transaction_type":{"type":"string","nullable":true},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"tax_currency":{"type":"string","pattern":"^[A-Z]{3}$"},"previous_invoice_hash":{"type":"string","nullable":true},"invoice_counter_value":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["invoice_id","invoice_number","uuid","issue_date","issue_time","invoice_type","transaction_type","currency","tax_currency","previous_invoice_hash","invoice_counter_value"],"additionalProperties":false},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason","line_extension_amount","tax_amount","total_amount"],"additionalProperties":false},"minItems":1},"totals":{"type":"object","properties":{"line_extension_total":{"type":"integer"},"allowance_total":{"type":"integer","minimum":0},"charge_total":{"type":"integer","minimum":0},"tax_exclusive_total":{"type":"integer"},"tax_total":{"type":"integer","minimum":0},"rounding_amount":{"type":"integer"},"tax_inclusive_total":{"type":"integer"},"prepaid_amount":{"type":"integer","minimum":0},"payable_amount":{"type":"integer"}},"required":["line_extension_total","allowance_total","charge_total","tax_exclusive_total","tax_total","rounding_amount","tax_inclusive_total","prepaid_amount","payable_amount"],"additionalProperties":false},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"required":["credit_note_reference","debit_note_reference","cancellation_reason","adjustment_reason","original_invoice_references"],"additionalProperties":false},"compliance_extension":{"type":"object","properties":{"spec_version":{"type":"string","minLength":1},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["cryptographic_stamp","qr_payload_base64","invoice_hash_base64","ecdsa_signature_base64","ecdsa_public_key_base64","ecdsa_public_key_signature_base64","clearance_status","compliance_csid_reference","production_csid_reference","submission_uuid"]},"value":{"type":"string"},"source_rule_id":{"type":"string","minLength":1,"nullable":true}},"required":["key","value","source_rule_id"],"additionalProperties":false}}},"required":["spec_version","fields"],"additionalProperties":false,"nullable":true}},"required":["id","created_at","updated_at","organization_id","egs_unit_id","taxpayer_profile_id","status","identity","seller","buyer","supply","line_items","totals","notes","compliance_extension"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/validate-json":{"post":{"tags":["zatca-invoices"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"invoice":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["DRAFT","VALIDATING","INVALID","VALID","GENERATED","SECURITY_PREPARED","SUBMISSION_PENDING","SUBMITTING","REPORTED","CLEARED","REJECTED","UNKNOWN_OUTCOME","RETRY_PENDING","CANCELLED","CREDITED","DEBITED","ARCHIVED"]},"identity":{"type":"object","properties":{"invoice_id":{"type":"string","minLength":1},"invoice_number":{"type":"string","minLength":1},"uuid":{"type":"string","format":"uuid"},"issue_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"issue_time":{"type":"string","pattern":"^\\d{2}:\\d{2}:\\d{2}$"},"invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"transaction_type":{"type":"string","nullable":true},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"tax_currency":{"type":"string","pattern":"^[A-Z]{3}$"},"previous_invoice_hash":{"type":"string","nullable":true},"invoice_counter_value":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["invoice_id","invoice_number","uuid","issue_date","issue_time","invoice_type","transaction_type","currency","tax_currency","previous_invoice_hash","invoice_counter_value"],"additionalProperties":false},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason","line_extension_amount","tax_amount","total_amount"],"additionalProperties":false},"minItems":1},"totals":{"type":"object","properties":{"line_extension_total":{"type":"integer"},"allowance_total":{"type":"integer","minimum":0},"charge_total":{"type":"integer","minimum":0},"tax_exclusive_total":{"type":"integer"},"tax_total":{"type":"integer","minimum":0},"rounding_amount":{"type":"integer"},"tax_inclusive_total":{"type":"integer"},"prepaid_amount":{"type":"integer","minimum":0},"payable_amount":{"type":"integer"}},"required":["line_extension_total","allowance_total","charge_total","tax_exclusive_total","tax_total","rounding_amount","tax_inclusive_total","prepaid_amount","payable_amount"],"additionalProperties":false},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"required":["credit_note_reference","debit_note_reference","cancellation_reason","adjustment_reason","original_invoice_references"],"additionalProperties":false},"compliance_extension":{"type":"object","properties":{"spec_version":{"type":"string","minLength":1},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["cryptographic_stamp","qr_payload_base64","invoice_hash_base64","ecdsa_signature_base64","ecdsa_public_key_base64","ecdsa_public_key_signature_base64","clearance_status","compliance_csid_reference","production_csid_reference","submission_uuid"]},"value":{"type":"string"},"source_rule_id":{"type":"string","minLength":1,"nullable":true}},"required":["key","value","source_rule_id"],"additionalProperties":false}}},"required":["spec_version","fields"],"additionalProperties":false,"nullable":true}},"required":["id","created_at","updated_at","organization_id","egs_unit_id","taxpayer_profile_id","status","identity","seller","buyer","supply","line_items","totals","notes","compliance_extension"],"additionalProperties":false}},"required":["invoice"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"internal_validation":{"type":"object","properties":{"valid":{"type":"boolean"},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["valid","issues"],"additionalProperties":false},"official_sdk_validation":{"type":"object","properties":{"ran":{"type":"boolean"},"valid":{"type":"boolean","nullable":true},"sdk_version":{"type":"string","nullable":true},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["ran","valid","sdk_version","issues"],"additionalProperties":false},"specification_version":{"type":"string","nullable":true}},"required":["internal_validation","official_sdk_validation","specification_version"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/validate-xml":{"post":{"tags":["zatca-invoices"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"xml":{"type":"string","minLength":1},"specification_version":{"type":"string","minLength":1}},"required":["xml"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"internal_validation":{"type":"object","properties":{"valid":{"type":"boolean"},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["valid","issues"],"additionalProperties":false},"official_sdk_validation":{"type":"object","properties":{"ran":{"type":"boolean"},"valid":{"type":"boolean","nullable":true},"sdk_version":{"type":"string","nullable":true},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["ran","valid","sdk_version","issues"],"additionalProperties":false},"specification_version":{"type":"string","nullable":true}},"required":["internal_validation","official_sdk_validation","specification_version"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/generate/standard":{"post":{"tags":["zatca-invoices"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"tax_calculation_mode":{"type":"string","enum":["TECHNOMINDS_CALCULATES","CUSTOMER_SUPPLIES_AMOUNTS","VALIDATE_ONLY"]},"requested_invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason"],"additionalProperties":false},"minItems":1},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}},"required":["organization_id","tax_calculation_mode","seller","buyer","supply","line_items"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["DRAFT","VALIDATING","INVALID","VALID","GENERATED","SECURITY_PREPARED","SUBMISSION_PENDING","SUBMITTING","REPORTED","CLEARED","REJECTED","UNKNOWN_OUTCOME","RETRY_PENDING","CANCELLED","CREDITED","DEBITED","ARCHIVED"]},"identity":{"type":"object","properties":{"invoice_id":{"type":"string","minLength":1},"invoice_number":{"type":"string","minLength":1},"uuid":{"type":"string","format":"uuid"},"issue_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"issue_time":{"type":"string","pattern":"^\\d{2}:\\d{2}:\\d{2}$"},"invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"transaction_type":{"type":"string","nullable":true},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"tax_currency":{"type":"string","pattern":"^[A-Z]{3}$"},"previous_invoice_hash":{"type":"string","nullable":true},"invoice_counter_value":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["invoice_id","invoice_number","uuid","issue_date","issue_time","invoice_type","transaction_type","currency","tax_currency","previous_invoice_hash","invoice_counter_value"],"additionalProperties":false},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason","line_extension_amount","tax_amount","total_amount"],"additionalProperties":false},"minItems":1},"totals":{"type":"object","properties":{"line_extension_total":{"type":"integer"},"allowance_total":{"type":"integer","minimum":0},"charge_total":{"type":"integer","minimum":0},"tax_exclusive_total":{"type":"integer"},"tax_total":{"type":"integer","minimum":0},"rounding_amount":{"type":"integer"},"tax_inclusive_total":{"type":"integer"},"prepaid_amount":{"type":"integer","minimum":0},"payable_amount":{"type":"integer"}},"required":["line_extension_total","allowance_total","charge_total","tax_exclusive_total","tax_total","rounding_amount","tax_inclusive_total","prepaid_amount","payable_amount"],"additionalProperties":false},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"required":["credit_note_reference","debit_note_reference","cancellation_reason","adjustment_reason","original_invoice_references"],"additionalProperties":false},"compliance_extension":{"type":"object","properties":{"spec_version":{"type":"string","minLength":1},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["cryptographic_stamp","qr_payload_base64","invoice_hash_base64","ecdsa_signature_base64","ecdsa_public_key_base64","ecdsa_public_key_signature_base64","clearance_status","compliance_csid_reference","production_csid_reference","submission_uuid"]},"value":{"type":"string"},"source_rule_id":{"type":"string","minLength":1,"nullable":true}},"required":["key","value","source_rule_id"],"additionalProperties":false}}},"required":["spec_version","fields"],"additionalProperties":false,"nullable":true}},"required":["id","created_at","updated_at","organization_id","egs_unit_id","taxpayer_profile_id","status","identity","seller","buyer","supply","line_items","totals","notes","compliance_extension"],"additionalProperties":false},"classification":{"type":"object","properties":{"selected_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"rule_ids":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"input_facts":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]}},"reason":{"type":"string","minLength":1},"warnings":{"type":"array","items":{"type":"string"}}},"required":["selected_type","rule_ids","input_facts","reason","warnings"],"additionalProperties":false},"validation":{"type":"object","properties":{"internal_validation":{"type":"object","properties":{"valid":{"type":"boolean"},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["valid","issues"],"additionalProperties":false},"official_sdk_validation":{"type":"object","properties":{"ran":{"type":"boolean"},"valid":{"type":"boolean","nullable":true},"sdk_version":{"type":"string","nullable":true},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["ran","valid","sdk_version","issues"],"additionalProperties":false},"specification_version":{"type":"string","nullable":true}},"required":["internal_validation","official_sdk_validation","specification_version"],"additionalProperties":false},"tax_discrepancies":{"type":"array","items":{"type":"object","properties":{"field_path":{"type":"string"},"supplied":{"type":"number"},"recalculated":{"type":"number"}},"required":["field_path","supplied","recalculated"],"additionalProperties":false}},"xml":{"type":"object","properties":{"content":{"type":"string","nullable":true},"mapping_report":{"type":"array","items":{"type":"object","properties":{"canonical_field":{"type":"string"},"xml_xpath":{"type":"string"},"source_value":{"type":"string","nullable":true},"serialized_value":{"type":"string","nullable":true},"transformation":{"type":"string","nullable":true},"rule_reference":{"type":"string","nullable":true}},"required":["canonical_field","xml_xpath","source_value","serialized_value","transformation","rule_reference"],"additionalProperties":false},"nullable":true}},"required":["content","mapping_report"],"additionalProperties":false}},"required":["invoice","classification","validation","tax_discrepancies","xml"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/generate/simplified":{"post":{"tags":["zatca-invoices"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"tax_calculation_mode":{"type":"string","enum":["TECHNOMINDS_CALCULATES","CUSTOMER_SUPPLIES_AMOUNTS","VALIDATE_ONLY"]},"requested_invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason"],"additionalProperties":false},"minItems":1},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}},"required":["organization_id","tax_calculation_mode","seller","buyer","supply","line_items"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["DRAFT","VALIDATING","INVALID","VALID","GENERATED","SECURITY_PREPARED","SUBMISSION_PENDING","SUBMITTING","REPORTED","CLEARED","REJECTED","UNKNOWN_OUTCOME","RETRY_PENDING","CANCELLED","CREDITED","DEBITED","ARCHIVED"]},"identity":{"type":"object","properties":{"invoice_id":{"type":"string","minLength":1},"invoice_number":{"type":"string","minLength":1},"uuid":{"type":"string","format":"uuid"},"issue_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"issue_time":{"type":"string","pattern":"^\\d{2}:\\d{2}:\\d{2}$"},"invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"transaction_type":{"type":"string","nullable":true},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"tax_currency":{"type":"string","pattern":"^[A-Z]{3}$"},"previous_invoice_hash":{"type":"string","nullable":true},"invoice_counter_value":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["invoice_id","invoice_number","uuid","issue_date","issue_time","invoice_type","transaction_type","currency","tax_currency","previous_invoice_hash","invoice_counter_value"],"additionalProperties":false},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason","line_extension_amount","tax_amount","total_amount"],"additionalProperties":false},"minItems":1},"totals":{"type":"object","properties":{"line_extension_total":{"type":"integer"},"allowance_total":{"type":"integer","minimum":0},"charge_total":{"type":"integer","minimum":0},"tax_exclusive_total":{"type":"integer"},"tax_total":{"type":"integer","minimum":0},"rounding_amount":{"type":"integer"},"tax_inclusive_total":{"type":"integer"},"prepaid_amount":{"type":"integer","minimum":0},"payable_amount":{"type":"integer"}},"required":["line_extension_total","allowance_total","charge_total","tax_exclusive_total","tax_total","rounding_amount","tax_inclusive_total","prepaid_amount","payable_amount"],"additionalProperties":false},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"required":["credit_note_reference","debit_note_reference","cancellation_reason","adjustment_reason","original_invoice_references"],"additionalProperties":false},"compliance_extension":{"type":"object","properties":{"spec_version":{"type":"string","minLength":1},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["cryptographic_stamp","qr_payload_base64","invoice_hash_base64","ecdsa_signature_base64","ecdsa_public_key_base64","ecdsa_public_key_signature_base64","clearance_status","compliance_csid_reference","production_csid_reference","submission_uuid"]},"value":{"type":"string"},"source_rule_id":{"type":"string","minLength":1,"nullable":true}},"required":["key","value","source_rule_id"],"additionalProperties":false}}},"required":["spec_version","fields"],"additionalProperties":false,"nullable":true}},"required":["id","created_at","updated_at","organization_id","egs_unit_id","taxpayer_profile_id","status","identity","seller","buyer","supply","line_items","totals","notes","compliance_extension"],"additionalProperties":false},"classification":{"type":"object","properties":{"selected_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"rule_ids":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"input_facts":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]}},"reason":{"type":"string","minLength":1},"warnings":{"type":"array","items":{"type":"string"}}},"required":["selected_type","rule_ids","input_facts","reason","warnings"],"additionalProperties":false},"validation":{"type":"object","properties":{"internal_validation":{"type":"object","properties":{"valid":{"type":"boolean"},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["valid","issues"],"additionalProperties":false},"official_sdk_validation":{"type":"object","properties":{"ran":{"type":"boolean"},"valid":{"type":"boolean","nullable":true},"sdk_version":{"type":"string","nullable":true},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["ran","valid","sdk_version","issues"],"additionalProperties":false},"specification_version":{"type":"string","nullable":true}},"required":["internal_validation","official_sdk_validation","specification_version"],"additionalProperties":false},"tax_discrepancies":{"type":"array","items":{"type":"object","properties":{"field_path":{"type":"string"},"supplied":{"type":"number"},"recalculated":{"type":"number"}},"required":["field_path","supplied","recalculated"],"additionalProperties":false}},"xml":{"type":"object","properties":{"content":{"type":"string","nullable":true},"mapping_report":{"type":"array","items":{"type":"object","properties":{"canonical_field":{"type":"string"},"xml_xpath":{"type":"string"},"source_value":{"type":"string","nullable":true},"serialized_value":{"type":"string","nullable":true},"transformation":{"type":"string","nullable":true},"rule_reference":{"type":"string","nullable":true}},"required":["canonical_field","xml_xpath","source_value","serialized_value","transformation","rule_reference"],"additionalProperties":false},"nullable":true}},"required":["content","mapping_report"],"additionalProperties":false}},"required":["invoice","classification","validation","tax_discrepancies","xml"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/generate/credit-note":{"post":{"tags":["zatca-invoices"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"tax_calculation_mode":{"type":"string","enum":["TECHNOMINDS_CALCULATES","CUSTOMER_SUPPLIES_AMOUNTS","VALIDATE_ONLY"]},"requested_invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason"],"additionalProperties":false},"minItems":1},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"original_invoice_id":{"type":"string","minLength":1},"adjustment_reason":{"type":"string","minLength":1}},"required":["organization_id","tax_calculation_mode","seller","buyer","supply","line_items","original_invoice_id","adjustment_reason"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["DRAFT","VALIDATING","INVALID","VALID","GENERATED","SECURITY_PREPARED","SUBMISSION_PENDING","SUBMITTING","REPORTED","CLEARED","REJECTED","UNKNOWN_OUTCOME","RETRY_PENDING","CANCELLED","CREDITED","DEBITED","ARCHIVED"]},"identity":{"type":"object","properties":{"invoice_id":{"type":"string","minLength":1},"invoice_number":{"type":"string","minLength":1},"uuid":{"type":"string","format":"uuid"},"issue_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"issue_time":{"type":"string","pattern":"^\\d{2}:\\d{2}:\\d{2}$"},"invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"transaction_type":{"type":"string","nullable":true},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"tax_currency":{"type":"string","pattern":"^[A-Z]{3}$"},"previous_invoice_hash":{"type":"string","nullable":true},"invoice_counter_value":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["invoice_id","invoice_number","uuid","issue_date","issue_time","invoice_type","transaction_type","currency","tax_currency","previous_invoice_hash","invoice_counter_value"],"additionalProperties":false},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason","line_extension_amount","tax_amount","total_amount"],"additionalProperties":false},"minItems":1},"totals":{"type":"object","properties":{"line_extension_total":{"type":"integer"},"allowance_total":{"type":"integer","minimum":0},"charge_total":{"type":"integer","minimum":0},"tax_exclusive_total":{"type":"integer"},"tax_total":{"type":"integer","minimum":0},"rounding_amount":{"type":"integer"},"tax_inclusive_total":{"type":"integer"},"prepaid_amount":{"type":"integer","minimum":0},"payable_amount":{"type":"integer"}},"required":["line_extension_total","allowance_total","charge_total","tax_exclusive_total","tax_total","rounding_amount","tax_inclusive_total","prepaid_amount","payable_amount"],"additionalProperties":false},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"required":["credit_note_reference","debit_note_reference","cancellation_reason","adjustment_reason","original_invoice_references"],"additionalProperties":false},"compliance_extension":{"type":"object","properties":{"spec_version":{"type":"string","minLength":1},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["cryptographic_stamp","qr_payload_base64","invoice_hash_base64","ecdsa_signature_base64","ecdsa_public_key_base64","ecdsa_public_key_signature_base64","clearance_status","compliance_csid_reference","production_csid_reference","submission_uuid"]},"value":{"type":"string"},"source_rule_id":{"type":"string","minLength":1,"nullable":true}},"required":["key","value","source_rule_id"],"additionalProperties":false}}},"required":["spec_version","fields"],"additionalProperties":false,"nullable":true}},"required":["id","created_at","updated_at","organization_id","egs_unit_id","taxpayer_profile_id","status","identity","seller","buyer","supply","line_items","totals","notes","compliance_extension"],"additionalProperties":false},"classification":{"type":"object","properties":{"selected_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"rule_ids":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"input_facts":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]}},"reason":{"type":"string","minLength":1},"warnings":{"type":"array","items":{"type":"string"}}},"required":["selected_type","rule_ids","input_facts","reason","warnings"],"additionalProperties":false},"validation":{"type":"object","properties":{"internal_validation":{"type":"object","properties":{"valid":{"type":"boolean"},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["valid","issues"],"additionalProperties":false},"official_sdk_validation":{"type":"object","properties":{"ran":{"type":"boolean"},"valid":{"type":"boolean","nullable":true},"sdk_version":{"type":"string","nullable":true},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["ran","valid","sdk_version","issues"],"additionalProperties":false},"specification_version":{"type":"string","nullable":true}},"required":["internal_validation","official_sdk_validation","specification_version"],"additionalProperties":false},"tax_discrepancies":{"type":"array","items":{"type":"object","properties":{"field_path":{"type":"string"},"supplied":{"type":"number"},"recalculated":{"type":"number"}},"required":["field_path","supplied","recalculated"],"additionalProperties":false}},"xml":{"type":"object","properties":{"content":{"type":"string","nullable":true},"mapping_report":{"type":"array","items":{"type":"object","properties":{"canonical_field":{"type":"string"},"xml_xpath":{"type":"string"},"source_value":{"type":"string","nullable":true},"serialized_value":{"type":"string","nullable":true},"transformation":{"type":"string","nullable":true},"rule_reference":{"type":"string","nullable":true}},"required":["canonical_field","xml_xpath","source_value","serialized_value","transformation","rule_reference"],"additionalProperties":false},"nullable":true}},"required":["content","mapping_report"],"additionalProperties":false}},"required":["invoice","classification","validation","tax_discrepancies","xml"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/generate/debit-note":{"post":{"tags":["zatca-invoices"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"tax_calculation_mode":{"type":"string","enum":["TECHNOMINDS_CALCULATES","CUSTOMER_SUPPLIES_AMOUNTS","VALIDATE_ONLY"]},"requested_invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason"],"additionalProperties":false},"minItems":1},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"original_invoice_id":{"type":"string","minLength":1},"adjustment_reason":{"type":"string","minLength":1}},"required":["organization_id","tax_calculation_mode","seller","buyer","supply","line_items","original_invoice_id","adjustment_reason"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"organization_id":{"type":"string","minLength":1},"egs_unit_id":{"type":"string","minLength":1,"nullable":true},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"status":{"type":"string","enum":["DRAFT","VALIDATING","INVALID","VALID","GENERATED","SECURITY_PREPARED","SUBMISSION_PENDING","SUBMITTING","REPORTED","CLEARED","REJECTED","UNKNOWN_OUTCOME","RETRY_PENDING","CANCELLED","CREDITED","DEBITED","ARCHIVED"]},"identity":{"type":"object","properties":{"invoice_id":{"type":"string","minLength":1},"invoice_number":{"type":"string","minLength":1},"uuid":{"type":"string","format":"uuid"},"issue_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"issue_time":{"type":"string","pattern":"^\\d{2}:\\d{2}:\\d{2}$"},"invoice_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"transaction_type":{"type":"string","nullable":true},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"tax_currency":{"type":"string","pattern":"^[A-Z]{3}$"},"previous_invoice_hash":{"type":"string","nullable":true},"invoice_counter_value":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["invoice_id","invoice_number","uuid","issue_date","issue_time","invoice_type","transaction_type","currency","tax_currency","previous_invoice_hash","invoice_counter_value"],"additionalProperties":false},"seller":{"type":"object","properties":{"legal_name":{"type":"string","minLength":1},"vat_number":{"type":"string","pattern":"^\\d{15}$"},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"branch":{"type":"string","nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}}},"required":["legal_name","vat_number","commercial_registration","address","branch","additional_identifiers"],"additionalProperties":false},"buyer":{"type":"object","properties":{"legal_name":{"type":"string","nullable":true},"vat_number":{"type":"string","pattern":"^\\d{15}$","nullable":true},"commercial_registration":{"type":"string","nullable":true},"address":{"type":"string","minLength":1,"nullable":true},"additional_identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"buyer_type":{"type":"string","enum":["business","government","individual","unspecified"]}},"required":["legal_name","vat_number","commercial_registration","address","additional_identifiers","buyer_type"],"additionalProperties":false},"supply":{"type":"object","properties":{"supply_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"end_date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true},"purchase_order_reference":{"type":"string","nullable":true},"contract_reference":{"type":"string","nullable":true},"delivery_reference":{"type":"string","nullable":true},"payment_terms":{"type":"string","nullable":true},"payment_method":{"type":"string","enum":["cash","credit","bank_transfer","card","online_payment","other"],"nullable":true}},"required":["supply_date","end_date","purchase_order_reference","contract_reference","delivery_reference","payment_terms","payment_method"],"additionalProperties":false},"line_items":{"type":"array","items":{"type":"object","properties":{"line_id":{"type":"string","minLength":1},"name_ar":{"type":"string","nullable":true},"name_en":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"quantity":{"type":"number"},"unit_code":{"type":"string","minLength":1},"unit_price":{"type":"integer"},"discounts":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"charges":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","nullable":true},"reason_code":{"type":"string","nullable":true},"amount":{"type":"integer","minimum":0}},"required":["reason","reason_code","amount"],"additionalProperties":false}},"tax_category":{"type":"string","enum":["standard_rated","zero_rated","exempt","out_of_scope"]},"tax_rate":{"type":"number","minimum":0,"maximum":100},"tax_exemption_reason":{"type":"string","nullable":true},"line_extension_amount":{"type":"integer"},"tax_amount":{"type":"integer"},"total_amount":{"type":"integer"}},"required":["line_id","name_ar","name_en","description","quantity","unit_code","unit_price","discounts","charges","tax_category","tax_rate","tax_exemption_reason","line_extension_amount","tax_amount","total_amount"],"additionalProperties":false},"minItems":1},"totals":{"type":"object","properties":{"line_extension_total":{"type":"integer"},"allowance_total":{"type":"integer","minimum":0},"charge_total":{"type":"integer","minimum":0},"tax_exclusive_total":{"type":"integer"},"tax_total":{"type":"integer","minimum":0},"rounding_amount":{"type":"integer"},"tax_inclusive_total":{"type":"integer"},"prepaid_amount":{"type":"integer","minimum":0},"payable_amount":{"type":"integer"}},"required":["line_extension_total","allowance_total","charge_total","tax_exclusive_total","tax_total","rounding_amount","tax_inclusive_total","prepaid_amount","payable_amount"],"additionalProperties":false},"notes":{"type":"object","properties":{"credit_note_reference":{"type":"string","minLength":1,"nullable":true},"debit_note_reference":{"type":"string","minLength":1,"nullable":true},"cancellation_reason":{"type":"string","nullable":true},"adjustment_reason":{"type":"string","nullable":true},"original_invoice_references":{"type":"array","items":{"type":"string","minLength":1}}},"required":["credit_note_reference","debit_note_reference","cancellation_reason","adjustment_reason","original_invoice_references"],"additionalProperties":false},"compliance_extension":{"type":"object","properties":{"spec_version":{"type":"string","minLength":1},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["cryptographic_stamp","qr_payload_base64","invoice_hash_base64","ecdsa_signature_base64","ecdsa_public_key_base64","ecdsa_public_key_signature_base64","clearance_status","compliance_csid_reference","production_csid_reference","submission_uuid"]},"value":{"type":"string"},"source_rule_id":{"type":"string","minLength":1,"nullable":true}},"required":["key","value","source_rule_id"],"additionalProperties":false}}},"required":["spec_version","fields"],"additionalProperties":false,"nullable":true}},"required":["id","created_at","updated_at","organization_id","egs_unit_id","taxpayer_profile_id","status","identity","seller","buyer","supply","line_items","totals","notes","compliance_extension"],"additionalProperties":false},"classification":{"type":"object","properties":{"selected_type":{"type":"string","enum":["STANDARD_TAX_INVOICE","SIMPLIFIED_TAX_INVOICE","STANDARD_CREDIT_NOTE","SIMPLIFIED_CREDIT_NOTE","STANDARD_DEBIT_NOTE","SIMPLIFIED_DEBIT_NOTE"]},"rule_ids":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"input_facts":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"enum":["null"],"nullable":true}]}},"reason":{"type":"string","minLength":1},"warnings":{"type":"array","items":{"type":"string"}}},"required":["selected_type","rule_ids","input_facts","reason","warnings"],"additionalProperties":false},"validation":{"type":"object","properties":{"internal_validation":{"type":"object","properties":{"valid":{"type":"boolean"},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["valid","issues"],"additionalProperties":false},"official_sdk_validation":{"type":"object","properties":{"ran":{"type":"boolean"},"valid":{"type":"boolean","nullable":true},"sdk_version":{"type":"string","nullable":true},"issues":{"type":"array","items":{"type":"object","properties":{"rule_id":{"type":"string","nullable":true},"field_path":{"type":"string","nullable":true},"severity":{"type":"string","enum":["error","warning"]},"message_en":{"type":"string"},"message_ar":{"type":"string","nullable":true},"suggested_correction":{"type":"string","nullable":true}},"required":["rule_id","field_path","severity","message_en","message_ar","suggested_correction"],"additionalProperties":false}}},"required":["ran","valid","sdk_version","issues"],"additionalProperties":false},"specification_version":{"type":"string","nullable":true}},"required":["internal_validation","official_sdk_validation","specification_version"],"additionalProperties":false},"tax_discrepancies":{"type":"array","items":{"type":"object","properties":{"field_path":{"type":"string"},"supplied":{"type":"number"},"recalculated":{"type":"number"}},"required":["field_path","supplied","recalculated"],"additionalProperties":false}},"xml":{"type":"object","properties":{"content":{"type":"string","nullable":true},"mapping_report":{"type":"array","items":{"type":"object","properties":{"canonical_field":{"type":"string"},"xml_xpath":{"type":"string"},"source_value":{"type":"string","nullable":true},"serialized_value":{"type":"string","nullable":true},"transformation":{"type":"string","nullable":true},"rule_reference":{"type":"string","nullable":true}},"required":["canonical_field","xml_xpath","source_value","serialized_value","transformation","rule_reference"],"additionalProperties":false},"nullable":true}},"required":["content","mapping_report"],"additionalProperties":false}},"required":["invoice","classification","validation","tax_discrepancies","xml"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/{id}/render":{"post":{"tags":["zatca-invoices"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"language":{"type":"string","enum":["ar","en","bilingual"]},"format":{"type":"string","enum":["html","pdf"]}},"required":["language"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice_id":{"type":"string"},"language":{"type":"string","enum":["ar","en","bilingual"]},"format":{"type":"string","enum":["html","pdf"]},"content_base64":{"type":"string"}},"required":["invoice_id","language","format","content_base64"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/{id}/qr":{"post":{"tags":["zatca-invoices"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice_id":{"type":"string"},"qr_payload_base64":{"type":"string"},"qr_image_base64":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"number"},"name":{"type":"string"},"value":{"type":"string"}},"required":["tag","name","value"],"additionalProperties":false}}},"required":["invoice_id","qr_payload_base64","qr_image_base64","fields"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/{id}/report":{"post":{"tags":["zatca-invoices"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice_id":{"type":"string"},"submission_id":{"type":"string"},"status":{"type":"string"},"zatca_response_reference":{"type":"string","nullable":true}},"required":["invoice_id","submission_id","status","zatca_response_reference"],"additionalProperties":false}}}}}}},"/v1/zatca/invoices/{id}/clear":{"post":{"tags":["zatca-invoices"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"invoice_id":{"type":"string"},"submission_id":{"type":"string"},"status":{"type":"string"},"cleared_document_reference":{"type":"string","nullable":true}},"required":["invoice_id","submission_id","status","cleared_document_reference"],"additionalProperties":false}}}}}}},"/v1/zatca/submissions/{id}":{"get":{"tags":["zatca-submissions"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"invoice_id":{"type":"string"},"mode":{"type":"string","enum":["reporting","clearance"]},"status":{"type":"string","enum":["DRAFT","VALIDATING","INVALID","VALID","GENERATED","SECURITY_PREPARED","SUBMISSION_PENDING","SUBMITTING","REPORTED","CLEARED","REJECTED","UNKNOWN_OUTCOME","RETRY_PENDING","CANCELLED","CREDITED","DEBITED","ARCHIVED"]},"idempotency_key":{"type":"string","nullable":true},"submitted_at":{"type":"string"},"resolved_at":{"type":"string","nullable":true},"canonical_error":{"type":"string","nullable":true}},"required":["id","invoice_id","mode","status","idempotency_key","submitted_at","resolved_at","canonical_error"],"additionalProperties":false}}}}}}},"/v1/zatca/archive/export":{"post":{"tags":["zatca-archive"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organization_id":{"type":"string","minLength":1},"taxpayer_profile_id":{"type":"string","minLength":1,"nullable":true},"from":{"type":"string","minLength":1,"nullable":true},"to":{"type":"string","minLength":1,"nullable":true}},"required":["organization_id"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"export_id":{"type":"string"},"status":{"type":"string","enum":["queued","processing","completed","failed"]},"download_reference":{"type":"string","nullable":true},"signed":{"type":"boolean"},"requested_at":{"type":"string"}},"required":["export_id","status","download_reference","signed","requested_at"],"additionalProperties":false}}}}}}},"/v1/zatca/archive/export/{id}":{"get":{"tags":["zatca-archive"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"export_id":{"type":"string"},"status":{"type":"string","enum":["queued","processing","completed","failed"]},"download_reference":{"type":"string","nullable":true},"signed":{"type":"boolean"},"requested_at":{"type":"string"}},"required":["export_id","status","download_reference","signed","requested_at"],"additionalProperties":false}}}}}}},"/v1/self-service/bootstrap":{"post":{"summary":"Create a product-selected sandbox tenant for a verified identity","tags":["self-service"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"company_name":{"type":"string","minLength":2,"maxLength":160},"legal_name_ar":{"type":"string","minLength":2,"maxLength":160},"locale":{"type":"string","enum":["ar-SA","en-SA"]},"acquisition_context":{"type":"object","properties":{"product":{"type":"string","enum":["fatoorah","address","platform"]},"source":{"type":"string","pattern":"^[a-z0-9_-]+$","maxLength":80},"anonymous_id":{"type":"string","pattern":"^[a-zA-Z0-9_.-]+$","maxLength":120},"experiment_id":{"type":"string","pattern":"^[a-zA-Z0-9_.-]+$","maxLength":120},"experiment_variant":{"type":"string","pattern":"^[a-zA-Z0-9_.-]+$","maxLength":120}},"required":["product","source"],"additionalProperties":false},"selected_product":{"type":"string","enum":["fatoorah","address","platform"]}},"required":["company_name","selected_product"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"already_initialized":{"type":"boolean"},"user_id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","format":"uuid"},"subscription_id":{"type":"string","format":"uuid"},"service_resource_id":{"type":"string","format":"uuid"},"api_key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"prefix":{"type":"string"},"full_key":{"type":"string"}},"required":["id","prefix","full_key"],"additionalProperties":false,"nullable":true},"onboarding_status":{"type":"string","enum":["active"]},"selected_product":{"type":"string","enum":["fatoorah","address","platform"]}},"required":["already_initialized","user_id","organization_id","subscription_id","service_resource_id","api_key","onboarding_status","selected_product"],"additionalProperties":false}}}},"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"already_initialized":{"type":"boolean"},"user_id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","format":"uuid"},"subscription_id":{"type":"string","format":"uuid"},"service_resource_id":{"type":"string","format":"uuid"},"api_key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"prefix":{"type":"string"},"full_key":{"type":"string"}},"required":["id","prefix","full_key"],"additionalProperties":false,"nullable":true},"onboarding_status":{"type":"string","enum":["active"]},"selected_product":{"type":"string","enum":["fatoorah","address","platform"]}},"required":["already_initialized","user_id","organization_id","subscription_id","service_resource_id","api_key","onboarding_status","selected_product"],"additionalProperties":false}}}}}}},"/v1/self-service/session":{"post":{"summary":"Create a short-lived customer-portal session for an existing sandbox owner","tags":["self-service"],"security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","format":"uuid"},"api_key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"prefix":{"type":"string"},"full_key":{"type":"string"},"expires_at":{"type":"string","format":"date-time"}},"required":["id","prefix","full_key","expires_at"],"additionalProperties":false}},"required":["user_id","organization_id","api_key"],"additionalProperties":false}}}}}}},"/v1/request-logs":{"get":{"tags":["request-logs"],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"connected_business_id","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"connected_business_id":{"type":"string","format":"uuid","nullable":true},"method":{"type":"string"},"route":{"type":"string"},"status_code":{"type":"integer"},"duration_ms":{"type":"integer"},"correlation_id":{"type":"string"},"environment":{"type":"string"},"occurred_at":{"type":"string","format":"date-time"}},"required":["id","connected_business_id","method","route","status_code","duration_ms","correlation_id","environment","occurred_at"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false}}}}}}}},"security":[{"bearerAuth":[]}]}