For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact SalesGet Support
HomeGuidesAPI reference
HomeGuidesAPI reference
  • Get started
    • Quickstart—Verify a Business
    • Quickstart—Register an entity for payroll taxes
    • Learn how Middesk works
    • Security
    • Changelog
  • Build with Middesk
    • Get your API keys
    • Understand API changes
    • Status codes and errors reference
    • Implement webhooks
    • Secure webhooks
    • Use GraphQL
    • Connect MCP
  • Verify a business (KYB)
    • Verify TIN
    • Verify name and address
    • Verify Secretary of State status
    • Verify owners and officers
    • Screen for sanctions and watchlists
    • Search for adverse media
    • Search for Politically Exposed Persons
    • Implement KYC
    • Discover connections
    • Evaluate online presence
    • Assess credit risk
    • Accelerate onboarding
    • Monitor business activity
    • Manage business entities
    • Work with agents
LogoLogo
Contact SalesGet Support
On this page
  • Breaking changes
  • Non-breaking changes
  • Disruptive changes
  • Non-disruptive changes
Build with Middesk

Understand API changes

Was this page helpful?
Previous

Status codes and errors messages

Next
Built with

Middesk uses major-release versioning for its API, currently in version 1 (v1). This guide explains how Middesk categorizes API changes and manages backwards compatibility.

Breaking changes

Breaking changes are not backwards compatible and can cause existing integrations to fail. Middesk rarely makes breaking changes, but when necessary, notifies affected customers in advance and provides an opt-out option.

Examples of breaking changes:

  • Removing or renaming fields in API responses
  • Changing the data type of existing fields
  • Removing or deprecating API endpoints
  • Modifying authentication methods or security protocols
  • Decreasing rate limits
  • Removing webhook events

Non-breaking changes

Non-breaking changes are backwards compatible with existing integrations. These are typically additive changes that don’t affect current functionality.

Examples of non-breaking changes:

  • Adding new API endpoints
  • Adding optional request parameters
  • Adding new fields to API responses
  • Changing the order of fields in responses
  • Changing opaque string formats (such as IDs or error messages)
  • Adding new webhook events

Non-breaking changes can be further broken down into disruptive and non-disruptive changes.

Disruptive changes

Some backwards-compatible changes may still affect your business logic or workflows. For disruptive changes, Middesk contacts affected customers in advance and uses feature flags to opt those users in.

Examples of disruptive, non-breaking changes:

  • Adding secondary data sources for address verification (such as Google Places or websites)
  • Auto-subscribing customers to new webhook event types
  • Changing data sources for the watchlist database
  • Adding new status values (success, warning, failure) to existing insights or tasks

Non-disruptive changes

Most API changes fall into this category and don’t affect your integration.

Examples of non-disruptive, non-breaking changes:

  • New endpoints like Policies
  • New Task types
  • New fields in the Businesses API
  • Additional optional filters for GET /v1/businesses
Get a demo
Contact your account manager or contact sales to inquire about access.