May'26 - CDR Insights API Updates

The new POST /insights endpoint generates an Expense‑to‑Income CDR Insight and supports requests for either a single user or multiple users (1–10). Single‑user requests return an individual insight, while multi‑user requests returns an aggregated result.

• Endpoint: POST /insights
• Supported Types: EXPENSE_RATIO_VERIFICATION, BALANCE_VERIFICATION, ACCOUNT_VERIFICATION, IDENTITY_VERIFICATION, INCOME_VERIFICATION
• Multi-user: Multi-user requests (1–10 users) are currently supported only for EXPENSE_RATIO_VERIFICATION

Use Cases: Generate expense ratio, balance, account, identity, or income verifications across multiple users in a single API call.

GET /insights/types returns all supported CDR Insight types and the Insight-specific input schema each type expects. Records are pre-seeded per environment and serve as static reference data — no runtime creation or validation occurs.

• Endpoint: GET /insights/types
• Returns: type, id, name, description, supportMultipleUsers, dataSchema for each Insight type
• Note: dataSchema reflects Insight-specific input only — does not include transport-level fields such as users or type

Use Cases: Discover available Insight types and their required input fields before constructing a POST /insights request.

GET /insights/types/{typeId} returns the definition of a single Insight type by ID. Designed for discoverability and input validation — returns the dataSchema for the requested type alongside its metadata.

• Endpoint: GET /insights/types/{typeId}
• Path Parameter: typeId — one of ACCOUNT_VERIFICATION, BALANCE_VERIFICATION, IDENTITY_VERIFICATION, INCOME_VERIFICATION, EXPENSE_RATIO_VERIFICATION
• Error: 404 returned for unknown typeId values

Use Cases: Validate the required input shape for a specific Insight type before submitting a request, or surface type details in a partner-facing UI.

The Balance Verification API response field accountNumber has been renamed to balance. The previous naming was misleading and caused confusion with Account Verification.

• Changed Field: accountNumber → balance in BalanceInsightDataItem and AccountBalanceData schemas
• Affected Endpoint: GET /users/{userId}/insights/{insightId} where insightType is balance

Use Cases: Consumers reading balance verification results must update their integration to reference the balance field instead of accountNumber.