API template library

Plaid Income mock API and live sandbox

A WireMock simulation of Plaid's REST API — covering bank income, payroll income, employment verification, and employer search.

Vendor
Plaid
Functionality
Income verification data
Spec version
2020-09-14_1.688.6
Endpoints
19
Stubs
19
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 Income

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

Base URL
https://jy8yy.wiremockapi.cloud

POST Get Credit Bank Income

curl -s -X POST 'https://jy8yy.wiremockapi.cloud/credit/bank_income/get' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Get Credit Bank Income PDF

curl -s -X POST 'https://jy8yy.wiremockapi.cloud/credit/bank_income/pdf/get' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Refresh Credit Bank Income

curl -s -X POST 'https://jy8yy.wiremockapi.cloud/credit/bank_income/refresh' \
  -H 'Content-Type: application/json' \
  -d '{}'
Method Path Summary
POST /credit/bank_income/get Retrieve information from the bank accounts used for income verification
POST /credit/bank_income/pdf/get Retrieve information from the bank accounts used for income verification in PDF format
POST /credit/bank_income/refresh Refresh a user's bank income information
POST /credit/bank_income/webhook/update Subscribe and unsubscribe to proactive notifications for a user's income profile
POST /credit/bank_statements/uploads/get Retrieve data for a user's uploaded bank statements
POST /credit/employment/get Retrieve a summary of an individual's employment information
POST /credit/payroll_income/get Retrieve a user's payroll information
POST /credit/payroll_income/parsing_config/update Update the parsing configuration for a document income verification
POST /credit/payroll_income/precheck Check income verification eligibility and optimize conversion
POST /credit/payroll_income/refresh Refresh a digital payroll income verification
POST /credit/payroll_income/risk_signals/get Retrieve fraud insights for a user's manually uploaded document(s).
POST /credit/sessions/get Retrieve Link sessions for your user
POST /employers/search Search employer database
POST /employment/verification/get (Deprecated) Retrieve a summary of an individual's employment information
POST /income/verification/create (Deprecated) Create an income verification instance
POST /income/verification/documents/download (Deprecated) Download the original documents used for income verification
POST /income/verification/paystubs/get (Deprecated) Retrieve information from the paystubs used for income verification
POST /income/verification/precheck (Deprecated) Check digital income verification eligibility and optimize conversion
POST /income/verification/taxforms/get (Deprecated) Retrieve information from the tax documents used for income verification

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

What's inside the Income template

Nineteen endpoints span both generations of Plaid's income product: the current /credit family and five deprecated /income/verification routes kept answering beside it. Bank income reports a SALARY-category EMPLOYER PAYROLL source on the First Platypus checking account; the employment route returns an active W2 record — software engineer at Acme Corp since 2020, platform ids included — and employer search resolves Acme Corp at full confidence. The richest document payload sits on the legacy side, where the paystub route serves a complete stub-level paystub: biweekly pay period, 5,000 gross, employer address, deductions, and net pay.

  • Bank income — the account-and-source income report, its PDF variant, refresh, and webhook subscription
  • Payroll income — a READY-status report with precheck, parsing-config, and risk-signal routes around it
  • Employment — the active W2 verification record with employer, title, and platform identifiers
  • Employer search — the employers database lookup answering with a scored Acme Corp match
  • Legacy verification — five deprecated income-verification routes, paystubs and tax forms among them

Frequently asked questions

A twenty-byte body reading "%PDF-1.4 placeholder", served with a genuine application/pdf content type. That's enough to test download plumbing — content-type routing, file persistence, attachment handling — while rendering or text-extracting the document is out of scope for the sandbox.

The modern payroll route reports READY processing status but keeps pay_stubs, w2s, and form1099s empty, while the deprecated paystubs route carries the fully-detailed document. Code that needs populated earnings and deductions can read the legacy shape, or graft that detail onto the modern route in a private copy.

They're stubbed on purpose — teams migrating from /income/verification to the /credit family can run both generations against one host and diff their handling. For new integrations, treat the legacy routes as reference material rather than a target; Plaid's spec marks every one of them deprecated.

In production, from transaction streams — recurring deposits scored as income — which is why the source here names EMPLOYER PAYROLL yet its transactions array stays empty. Deposit-pattern logic itself is better exercised on the Transactions template, whose fixtures include the raw transaction objects this product summarizes.

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