Skip to main content
The Worldly API is versioned. When a change made to the Worldly API is not backwards-compatible, we release a new API version to avoid breaking existing integrations. Worldly API subscribers and partners may continue to use older API versions, however, older versions will not be able to access new endpoints or tools released on the Worldly platform.

​
Versionable changes

The following would require Worldly to create a new version of its API:
  • Modifying authentication methods
  • Modifying a URI path
  • Modifying required query parameters
  • Deleting a resource or API endpoint
  • Deleting a response field

​
Non-versionable changes

The following would not require Worldly to create a new version of its API:
  • Adding new APIs with the same URI path
  • Adding new API endpoints
  • Adding new optional parameters to existing endpoints
  • Adding new response fields
  • Changing the order of properties in existing API responses

​
API versions

Use the version selector at the top of this page to switch between versions.
  • v1.1 (Latest) — Current API with OpenSSL-based authentication
  • v1.0 — Includes Scope 3 API
  • v0.1 (Legacy) — Legacy JWT-based authentication