What is MIDSuite?

MIDSuite is a fraud prevention and identity verification platform built for the payments industry. It provides real-time evaluation of card transactions, customer identity attributes, behavioral signals, and risk indicators.

The MIDSuite Client API enables backend systems, payment processors, and risk platforms to programmatically submit transaction and identity data for evaluation and receive structured, actionable responses within a synchronous request/response model.

The API is designed to integrate directly into checkout flows, account creation processes, recurring billing systems, and other transaction-driven workflows.

What Problems the Client API Solves

The MIDSuite Client API helps merchants and payment platforms reduce fraud, improve authorization performance, and automate decisioning across several domains:

Fraud Detection

Identify potentially fraudulent activity before authorization or fulfillment by evaluating:

• Card validation signals

• Behavioral and device characteristics

• IP risk indicators

• Historical and contextual data

Identity Verification

Confirm that a customer’s identity attributes match expected records, including:

• Name verification

• Email and phone verification

• Government-issued ID verification (e.g., driver’s license, passport, national ID, tax ID)

Risk Scoring

Generate structured outputs such as:

• Decision statuses (e.g., ACCEPT, REVIEW, DENY)

• Risk scores (e.g., requestScore, ipScore)

• AVS and CVV match results

These signals can be used directly for automated decisions or combined with your internal risk logic.

Decisioning Pipelines

Orchestrate multiple services in a single API call using the Pipeline API, enabling coordinated execution of:

• PreCheck

• Rules

• Sentry

• ID Verify

This reduces integration complexity while maintaining granular control over risk stages.

When to Use Individual Services vs. the Pipeline API

The MIDSuite Client API exposes individual service endpoints as well as a unified orchestration endpoint.

Use Individual Services When:

• You only need one specific evaluation (e.g., card validation only).

• You already have an internal decisioning engine.

• You want fine-grained control over execution order.

• You are incrementally adopting MIDSuite capabilities.

Available v1 service endpoints include:

• /api/v1/precheck

• /api/v1/rules

• /api/v1/sentry

• /api/v1/idverify

Use the Pipeline API When:

• You want a single request to execute multiple services.

• You want MIDSuite to manage orchestration between stages.

• You prefer simplified integration with unified billing and tagging.

The Pipeline endpoint:

• /api/v1/pipeline

The Pipeline API is especially useful in production checkout flows where performance, consistency, and operational simplicity are critical.

Intended Audience

This documentation is written for:

• Backend engineers integrating MIDSuite into server-side systems

• Payment platforms and gateways embedding fraud controls

• Risk and fraud teams defining automated decision logic

• Technical product managers overseeing fraud mitigation strategy

The API assumes familiarity with:

• RESTful HTTP APIs

• JSON request/response structures

• Secure handling of sensitive data (e.g., PCI-compliant practices)

• Server-to-server authentication using API keys

API Design Overview

The MIDSuite Client API follows a:

• Stateless, synchronous request/response model

• JSON-based payload structure

• API key authentication via header (X-API-KEY)

• Versioned URL structure (/api/v1/...)

Each service response includes:

• isSuccess — Indicates whether the request processed successfully

• errors — Structured error information (if applicable)

• A service-specific response object

• Billing information where applicable

This consistent structure simplifies integration and error handling across all services.