API template library

Plaid Consumer Report mock API and live sandbox

A WireMock simulation of Plaid's REST API — covering check reports, cash-flow and income insights, the LendScore, report PDFs, loan registration, and monitoring.

Vendor
Plaid
Functionality
Credit and cash flow reports
Spec version
2020-09-14_1.688.6
Endpoints
25
Stubs
28
Protocol
REST
Validation
AI-validated Before publication, an AI agent exercised these endpoints against the real Plaid API through WireMock's recording proxy, and the recorded traffic was used to verify each stub's request and response shapes.

Live sandbox · no signup, no API key

Plaid Consumer Report (CRA)

A running WireMock Cloud instance of this template, callable right now from a terminal, a script, or an AI agent.

Base URL
https://vkvk7.wiremockapi.cloud

POST Create CRA Check Report

curl -s -X POST 'https://vkvk7.wiremockapi.cloud/cra/check_report/create' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Get CRA Check Report base report

curl -s -X POST 'https://vkvk7.wiremockapi.cloud/cra/check_report/base_report/get' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Get CRA Check Report income insights

curl -s -X POST 'https://vkvk7.wiremockapi.cloud/cra/check_report/income_insights/get' \
  -H 'Content-Type: application/json' \
  -d '{}'
Method Path Summary
POST /cashflow_report/get Gets transaction data in cashflow_report
POST /cashflow_report/insights/get Gets insights data in Cashflow Report
POST /cashflow_report/refresh Refresh transaction data in cashflow_report
POST /cashflow_report/transactions/get Gets transaction data in cashflow_report
POST /consumer_report/pdf/get Retrieve a PDF Reports
POST /cra/check_report/base_report/get Retrieve a Base Report
POST /cra/check_report/cashflow_insights/get Retrieve cash flow insights from your user's banking data
POST /cra/check_report/create Refresh or create a Consumer Report
POST /cra/check_report/income_insights/get Retrieve cash flow information from your user's banks
POST /cra/check_report/lend_score/get Retrieve the LendScore from your user's banking data
POST /cra/check_report/network_insights/get Retrieve network attributes for the user
POST /cra/check_report/partner_insights/get Retrieve cash flow insights from partners
POST /cra/check_report/pdf/get Retrieve Consumer Reports as a PDF
POST /cra/check_report/verification/get Retrieve various home lending reports for a user.
POST /cra/check_report/verification/pdf/get Retrieve Consumer Reports as a Verification PDF
POST /cra/credit_profile/report/get Retrieve the credit profile report for a user
POST /cra/loans/applications/register Register loan applications and decisions.
POST /cra/loans/register Register a list of loans to their applicants.
POST /cra/loans/unregister Unregister a list of loans.
POST /cra/loans/update Updates loan data.
POST /cra/monitoring_insights/get Retrieve a Monitoring Insights Report
POST /cra/monitoring_insights/subscribe Subscribe to Monitoring Insights
POST /cra/monitoring_insights/unsubscribe Unsubscribe from Monitoring Insights
POST /cra/partner_insights/get Retrieve cash flow insights from the bank accounts used for income verification
POST /network_insights/report/get Retrieve network insights for the provided access_tokens

Unauthenticated WireMock Cloud demo sandbox for Plaid — not an official Plaid sandbox, and it returns simulated example data only.

What's inside the Consumer Report template

Twenty-five endpoints span Plaid's consumer-reporting stack: check reports and their base-report data, cash-flow and income insights, a LendScore, verification-of-assets reads, loan registration, monitoring subscriptions, and network attributes. The insight bodies carry real analytical texture — income metrics resolve to a monthly gross of 390 against 300 net, the LendScore reads 80 with machine-readable reason codes attached, and the monitoring route reports an AVAILABLE item with its income sources broken out. One convention matters when reading any of it: inflow totals arrive negative, because cash-flow attributes inherit the transactions sign convention in which money entering an account is a negative amount.

  • Check reports — the create acknowledgement and a 365-day base report of cash-flow attributes
  • Scores & insights — the LendScore with reason codes, plus income, cash-flow, and partner insight reads
  • Verification — VOA-style report routes for home-lending flows
  • PDFs — structurally complete single-page documents on both pdf routes
  • Loans — register, update, and unregister acknowledgements for furnishing flows
  • Monitoring & network — subscription minting, an AVAILABLE insights item, and lifetime network attributes

Frequently asked questions

Sign convention, not data damage. Plaid's transaction amounts treat money leaving an account as positive, and the report attributes keep that orientation, so total inflows read as negatives. Aggregation code that assumes positive-equals-income inverts a consumer's cash flow — this fixture is where that mistake surfaces before production data makes it expensive.

The adverse-action vocabulary of credit decisioning — the machine-readable explanations a lender surfaces when a score drives a decline. The fixture pins two codes under a score of 80, which gives decision-letter templating and code-to-text mapping something stable to render.

They serve an actual document: a catalog, a page tree, one page — small, but structurally a complete PDF that viewers open without complaint. Report-delivery features can go a step past download plumbing here and hand the bytes to a renderer, which draws a blank page rather than raising an error.

The Income template models the verification question — is this applicant paid what they claim — while consumer reports assemble the fuller picture a lender pulls under consumer-reporting rules. The income insights here and the bank-income data there describe the same underlying deposits at two different altitudes.

Vendor names identify APIs represented by WireMock template sources. This page does not imply vendor endorsement, certification, partnership, or official integration status.