{"openapi":"3.0.3","info":{"title":"VisaDataHub Data API","version":"1.0.0","description":"Official-source factual snapshots. Independent service, not a government API. Server-to-server Bearer authentication. Canada BETA is non-commercial evaluation only; rights pending. Read-only data; no images, rankings or long third-party descriptions."},"servers":[{"url":"https://visadatahub.com/api/v1"}],"paths":{"/":{"get":{"operationId":"getRoot","summary":"API v1 overview","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Overview"},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/health":{"get":{"operationId":"get_health","summary":"Authenticated minimal health; no internal details","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Health"},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/meta":{"get":{"operationId":"get_meta","summary":"Release registry, definitions and freshness","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Registry"},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/countries":{"get":{"operationId":"get_countries","summary":"Stable country IDs and optional translated labels","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Page size.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from meta.pagination.next_cursor. Invalidated by changed results.","schema":{"type":"string","maxLength":160}},{"name":"sort","in":"query","required":false,"description":"Only metric endpoints permit value sorting; nulls sort last.","schema":{"type":"string","enum":["default"],"default":"default"}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Country"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/datasets":{"get":{"operationId":"get_datasets","summary":"Dataset registry alias of /meta","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Registry"},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/countries/{country_id}":{"get":{"operationId":"get_countries__country_id_","summary":"One country by stable ID","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}},{"name":"country_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Country"},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/visa-systems":{"get":{"operationId":"get_visa_systems","summary":"Released visa systems only","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Page size.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from meta.pagination.next_cursor. Invalidated by changed results.","schema":{"type":"string","maxLength":160}},{"name":"sort","in":"query","required":false,"description":"Only metric endpoints permit value sorting; nulls sort last.","schema":{"type":"string","enum":["default"],"default":"default"}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VisaSystem"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/visa-types":{"get":{"operationId":"get_visa_types","summary":"Released visa type IDs","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Page size.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from meta.pagination.next_cursor. Invalidated by changed results.","schema":{"type":"string","maxLength":160}},{"name":"sort","in":"query","required":false,"description":"Only metric endpoints permit value sorting; nulls sort last.","schema":{"type":"string","enum":["default"],"default":"default"}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VisaType"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/sources":{"get":{"operationId":"get_sources","summary":"Official source links; no copyrighted media","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Page size.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from meta.pagination.next_cursor. Invalidated by changed results.","schema":{"type":"string","maxLength":160}},{"name":"sort","in":"query","required":false,"description":"Only metric endpoints permit value sorting; nulls sort last.","schema":{"type":"string","enum":["default"],"default":"default"}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Source"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/processing-times":{"get":{"operationId":"get_processing_times","summary":"Canada published estimates; non-commercial evaluation only","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Page size.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from meta.pagination.next_cursor. Invalidated by changed results.","schema":{"type":"string","maxLength":160}},{"name":"sort","in":"query","required":false,"description":"Only metric endpoints permit value sorting; nulls sort last.","schema":{"type":"string","enum":["default","value_asc","value_desc"],"default":"default"}},{"name":"application_type","in":"query","required":false,"description":"Existing IRCC application subtype ID.","schema":{"type":"string","enum":["visitor-outside-canada","supervisa","study","work"]}},{"name":"applying_from","in":"query","required":false,"description":"Country ID from /countries or ISO code, e.g. CN.","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"Inclusive official update date.","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","required":false,"description":"Inclusive official update date.","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingTime"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/processing-times/canada":{"get":{"operationId":"get_processing_times_canada","summary":"Canada processing snapshot BETA, not appointment waits","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Page size.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from meta.pagination.next_cursor. Invalidated by changed results.","schema":{"type":"string","maxLength":160}},{"name":"sort","in":"query","required":false,"description":"Only metric endpoints permit value sorting; nulls sort last.","schema":{"type":"string","enum":["default","value_asc","value_desc"],"default":"default"}},{"name":"application_type","in":"query","required":false,"description":"Existing IRCC application subtype ID.","schema":{"type":"string","enum":["visitor-outside-canada","supervisa","study","work"]}},{"name":"applying_from","in":"query","required":false,"description":"Country ID from /countries or ISO code, e.g. CN.","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"Inclusive official update date.","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","required":false,"description":"Inclusive official update date.","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingTime"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/history/processing-times/canada":{"get":{"operationId":"get_history_processing_times_canada","summary":"Canada immutable retrieved snapshots; currently one snapshot","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Page size.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from meta.pagination.next_cursor. Invalidated by changed results.","schema":{"type":"string","maxLength":160}},{"name":"sort","in":"query","required":false,"description":"Only metric endpoints permit value sorting; nulls sort last.","schema":{"type":"string","enum":["default","value_asc","value_desc"],"default":"default"}},{"name":"application_type","in":"query","required":false,"description":"Existing IRCC application subtype ID.","schema":{"type":"string","enum":["visitor-outside-canada","supervisa","study","work"]}},{"name":"applying_from","in":"query","required":false,"description":"Country ID from /countries or ISO code, e.g. CN.","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"Inclusive official update date.","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","required":false,"description":"Inclusive official update date.","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProcessingTime"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/visa-statistics/united-states":{"get":{"operationId":"get_visa_statistics_united_states","summary":"US adjusted B visa refusal statistics FY2006–2025","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Page size.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from meta.pagination.next_cursor. Invalidated by changed results.","schema":{"type":"string","maxLength":160}},{"name":"sort","in":"query","required":false,"description":"Only metric endpoints permit value sorting; nulls sort last.","schema":{"type":"string","enum":["default","value_asc","value_desc"],"default":"default"}},{"name":"nationality","in":"query","required":false,"description":"Country ID or ISO code. Original unmapped source labels remain on rows.","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"Inclusive US fiscal year.","schema":{"type":"integer","minimum":2006,"maximum":2025}},{"name":"to","in":"query","required":false,"description":"Inclusive US fiscal year.","schema":{"type":"integer","minimum":2006,"maximum":2025}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RefusalRate"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/visa-statistics/us/refusal-rates":{"get":{"operationId":"get_visa_statistics_us_refusal_rates","summary":"US refusal statistics alias","security":[{"ApiKey":[]}],"parameters":[{"name":"lang","in":"query","required":false,"description":"Localized labels only; IDs and fields are stable.","schema":{"type":"string","enum":["en","zh-cn"],"default":"en"}},{"name":"include_sources","in":"query","required":false,"description":"Include official source provenance in meta.","schema":{"type":"boolean","default":false}},{"name":"limit","in":"query","required":false,"description":"Page size.","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"description":"Opaque cursor from meta.pagination.next_cursor. Invalidated by changed results.","schema":{"type":"string","maxLength":160}},{"name":"sort","in":"query","required":false,"description":"Only metric endpoints permit value sorting; nulls sort last.","schema":{"type":"string","enum":["default","value_asc","value_desc"],"default":"default"}},{"name":"nationality","in":"query","required":false,"description":"Country ID or ISO code. Original unmapped source labels remain on rows.","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"Inclusive US fiscal year.","schema":{"type":"integer","minimum":2006,"maximum":2025}},{"name":"to","in":"query","required":false,"description":"Inclusive US fiscal year.","schema":{"type":"integer","minimum":2006,"maximum":2025}}],"responses":{"200":{"description":"Success","headers":{"X-Request-ID":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}},"Last-Modified":{"schema":{"type":"string"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-Quota-Remaining":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RefusalRate"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"304":{"description":"Authenticated conditional GET, unchanged; counts against quota."},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing/invalid key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Revoked/expired key or commercial rights gate","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"405":{"description":"Only GET","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate or quota exceeded; Retry-After seconds","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"vdh_live_… / vdh_test_…"}},"schemas":{"Error":{"type":"object","required":["error","request_id"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["missing_api_key","invalid_api_key","revoked_api_key","expired_api_key","rate_limit_exceeded","quota_exceeded","invalid_parameter","not_found","data_unavailable","internal_error","method_not_allowed"]},"message":{"type":"string"}}},"request_id":{"type":"string"}}},"Meta":{"type":"object","required":["api_version","request_id","status","freshness"],"properties":{"api_version":{"type":"string","enum":["v1"]},"request_id":{"type":"string"},"status":{"type":"string","enum":["ready","beta"]},"dataset_id":{"type":"string","nullable":true},"freshness":{"type":"object","required":["official_updated_at","visadatahub_checked_at","retrieved_at","period"],"properties":{"official_updated_at":{"type":"string","nullable":true},"visadatahub_checked_at":{"type":"string","nullable":true},"retrieved_at":{"type":"string","nullable":true},"period":{"type":"object","nullable":true,"additionalProperties":true}},"nullable":true},"pagination":{"type":"object","required":["limit","total","next_cursor"],"properties":{"limit":{"type":"integer"},"total":{"type":"integer"},"next_cursor":{"type":"string","nullable":true}}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/Source"}}}},"Source":{"type":"object","required":["source_id","organization","title","url"],"properties":{"source_id":{"type":"string"},"organization":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"}}},"Country":{"type":"object","required":["country_id","iso_code","label","historical_entity","mapping_status"],"properties":{"country_id":{"type":"string"},"iso_code":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true},"label":{"type":"string"},"historical_entity":{"type":"boolean"},"mapping_status":{"type":"string"}}},"VisaSystem":{"type":"object","properties":{"jurisdiction_id":{"type":"string"},"iso_code":{"type":"string"},"status":{"type":"string"},"commercial_api_enabled":{"type":"boolean"}}},"VisaType":{"type":"object","properties":{"visa_type_id":{"type":"string"},"jurisdiction_id":{"type":"string"},"label":{"type":"string"},"application_group_id":{"type":"string"},"application_type_id":{"type":"string"}}},"ProcessingTime":{"type":"object","required":["jurisdiction_id","visa_type_id","applying_from_country_id","metric_type","value","unit","status","source_id","official_updated_at","visadatahub_checked_at","retrieved_at","period"],"properties":{"jurisdiction_id":{"type":"string","enum":["canada"]},"visa_type_id":{"type":"string"},"applying_from_country_id":{"type":"string"},"applying_from_iso":{"type":"string","nullable":true},"metric_type":{"type":"string","enum":["application_processing_time"]},"value":{"type":"number","nullable":true},"unit":{"type":"string","nullable":true},"status":{"type":"string"},"source_id":{"type":"string"},"official_updated_at":{"type":"string","nullable":true},"visadatahub_checked_at":{"type":"string","nullable":true},"retrieved_at":{"type":"string","nullable":true},"period":{"type":"object","nullable":true,"additionalProperties":true}}},"RefusalRate":{"type":"object","required":["jurisdiction_id","visa_type_id","nationality_country_id","nationality_slug","fiscal_year","metric_type","value","unit","source_id","official_updated_at","visadatahub_checked_at","retrieved_at","period"],"properties":{"jurisdiction_id":{"type":"string","enum":["united-states"]},"visa_type_id":{"type":"string","enum":["b"]},"nationality_country_id":{"type":"string","nullable":true},"nationality_label":{"type":"string"},"nationality_slug":{"type":"string"},"fiscal_year":{"type":"integer","minimum":2006,"maximum":2025},"metric_type":{"type":"string","enum":["adjusted_b_visa_refusal_rate"]},"value":{"type":"number","nullable":true,"description":"Official adjusted percentage; historical negative adjusted values preserved, not clamped."},"unit":{"type":"string","enum":["percent"]},"source_id":{"type":"string"},"official_updated_at":{"type":"string","nullable":true},"visadatahub_checked_at":{"type":"string","nullable":true},"retrieved_at":{"type":"string","nullable":true},"period":{"type":"object","nullable":true,"additionalProperties":true}}},"Overview":{"type":"object","properties":{"api_version":{"type":"string"},"base_url":{"type":"string"},"documentation_url":{"type":"string"},"authentication":{"type":"string"}}},"Health":{"type":"object","required":["status","api_version"],"properties":{"status":{"type":"string","enum":["ok"]},"api_version":{"type":"string"}}},"Registry":{"type":"object","properties":{"api_version":{"type":"string"},"datasets":{"type":"array","items":{"type":"object","required":["dataset_id","status","commercial_api_enabled"],"additionalProperties":true}},"definitions":{"type":"object","additionalProperties":{"type":"string"}}}}}}}