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.

Auth Links now remain valid for 30 days, allowing users to link and share data from multiple accounts across financial institutions within this period. Links expire automatically after 30 days or once users complete the disclosure flow.

• Auth Link Expiry: 30 days or upon disclosure flow completion
• Supported Actions: Link multiple accounts, share data with multiple institutions

Use Cases: Enable longer self-service financial data capture, reduce repeated consent requests, and allow multi-account linking in a single window.

The new GET /notifications/webhooks/{webhookId}/stats endpoint provides real-time monitoring of webhook delivery. Track performance and troubleshoot delivery issues directly through the API.

• Endpoint: GET /notifications/webhooks/{webhookId}/stats
• Response: Returns delivery status, success/failure counts, and timestamps

Use Cases: Monitor webhook success rates, identify failures, and ensure timely notifications for financial events.

Permission sets now support additional endpoints across Events, Merchants, Reports, Users, Enrich, and Webhooks categories, allowing partners to enable or disable access via the Dashboard to prevent unexpected 403 errors.

• Events & Jobs: GET /events/{eventId}, POST /jobs/{jobId}/mfa
• Merchants: GET /merchants, GET /merchants/{merchantId}
• Reports: GET /reports/types/{reportTypeId}, DELETE /reports/{reportId}, GET /reports/{reportId}/transactions
• Users: POST /users/{userId}/connections/{connectionId}/purge, GET /users/{userId}/identities, POST /users/{userId}/insights/expense-ratio
• Enrich: GET/POST /enrich/jobs, GET /enrich/jobs/{id}
• Webhooks: GET /notifications/webhooks/{webhookId}/stats

Use Cases: Control access to sensitive endpoints, manage user-level permissions, and reduce API errors due to insufficient permissions.

Manage and retrieve payee information with support for multiple payee types including domestic, biller, international, and digital wallet payments. List all payees with advanced filtering and pagination.

• GET /users/{userId}/payees: List all payees with pagination and filtering support
• GET /users/{userId}/payees/{payeeId}: Get detailed payee information by payee ID
• Query Parameters: limit (1-500), filter by type, connectionId, or created date

Use Cases: Retrieve all domestic payees, filter payees by connection, or get detailed information for a specific payee including bank details.

Analyse spending patterns and expense distribution across categories. Get insights into how much users are spending on different expense categories relative to their income.

• Body Params: Period and category filters for expense analysis
• expense object: Configuration for expense ratio calculation and filtering
• Response: Returns expense breakdown by category with ratio percentages

Use Cases: Analyze expense ratios for budgeting applications, identify spending trends, or provide personalized financial recommendations based on expense categories.