Changelog & Version History

This section documents notable changes to the MIDSuite Client API, including feature additions, behavioral changes, and deprecations. It helps integrators understand how the API evolves over time and how to maintain compatibility with existing integrations.

The MIDSuite Client API follows a versioned endpoint strategy, currently centered around the v1 API namespace. Changes within a version are designed to be backward compatible whenever possible.

Current API Version

Version: v1
Base Path: /api/v1/

All active services are exposed under the v1 namespace, including:

• /api/v1/precheck

• /api/v1/rules

• /api/v1/sentry

• /api/v1/idverify

• /api/v1/pipeline

These endpoints provide the primary functionality of the MIDSuite platform, including transaction validation, fraud detection, identity verification, and pipeline orchestration.

Versioning Strategy

MIDSuite uses URL-based versioning to ensure long-term stability for client integrations.

Key principles include:

• Major version changes are introduced through a new path (e.g., /api/v2/...)

• Minor enhancements within a version remain backward compatible

• Existing fields are never removed within the same major version

• New optional fields may be added without affecting existing integrations

This strategy allows clients to upgrade on their own schedule without breaking existing integrations.

Deprecation Policy

When functionality must be replaced or removed, the following process is followed:

1. The feature or endpoint is marked as deprecated in the documentation.

2. A replacement endpoint or behavior is provided when possible.

3. A sunset timeline is announced to allow integrators time to migrate.

4. The deprecated feature is eventually removed in a future major version.

Deprecations are always communicated in advance to ensure integrations remain stable.

Legacy API

The MIDSuite platform previously exposed legacy endpoints that predate the v1 API design.

Example legacy endpoint:

POST /api/legacy/precheck

The legacy API remains available only for existing customers migrating to the modern API. New integrations should use the v1 endpoints exclusively.

Legacy access has been closed to new customers as of January 2026.

Version History

v1.0.0 — Initial Client API Release

Initial public release of the MIDSuite Client API.

Key capabilities introduced:

• PreCheck transaction validation

• Rules Engine fraud decisioning

• Sentry behavioral risk scoring

• Identity verification (ID Verify)

• Pipeline orchestration API

• Unified response format with:

  • isSuccess

  • structured errors

  • billing invoice details

• Consistent JSON request and response schemas across services

Staying Informed

When changes occur, the changelog will be updated with:

• New features

• Behavior changes

• Deprecations

• Migration guidance

Integrators are encouraged to periodically review this section when maintaining or upgrading their integration.