Versioning

The Check API is versioned. When backwards-incompatible changes are made to the API, a new, dated version is released.

See our API Changelog for a complete list of API versions and their changes.

To set the API version on a specific request, send a Check-Version header.

Check-Version: 2025-01-01

In addition, every Partner account has a default API version associated with it. If no version is specified on a request, the account's default API version will be used. An account's default API version starts out as the latest API version available when the account is created. To change your account's default API version, contact support.

Webhooks are sent using your account's default API version, so changing the default also changes the shape of webhook payloads.

Deprecated versions

The 2021 API versions are deprecated, and Check will stop supporting them on May 31, 2027:

  • 2021-01-15
  • 2021-02-16
  • 2021-04-08
  • 2021-09-02

After May 31, 2027, requests made with a deprecated version will return an error. This applies whether the version is sent in the Check-Version header or comes from your account's default.

Upgrade to 2023-04-04 or later before then. We recommend 2025-01-01, the latest version. To test an upgrade, send the new version in the Check-Version header on individual requests, then ask support to change your account's default once your integration handles it.

If your integration uses one of these versions and you need help planning the upgrade, contact support or your Check partner contact.