API template library

Plaid Assets mock API and live sandbox

A WireMock simulation of Plaid's REST API — covering asset-report creation and refresh, PDF retrieval, audit copies, and partner relay sharing.

Vendor
Plaid
Functionality
Asset reports and audit copies
Spec version
2020-09-14_1.688.6
Endpoints
15
Stubs
16
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 Assets

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

Base URL
https://5e3ez.wiremockapi.cloud

POST Create Asset Report

curl -s -X POST 'https://5e3ez.wiremockapi.cloud/asset_report/create' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Refresh Asset Report

curl -s -X POST 'https://5e3ez.wiremockapi.cloud/asset_report/refresh' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Filter Asset Report

curl -s -X POST 'https://5e3ez.wiremockapi.cloud/asset_report/filter' \
  -H 'Content-Type: application/json' \
  -d '{}'
Method Path Summary
POST /asset_report/audit_copy/create Create Asset Report Audit Copy
POST /asset_report/audit_copy/get Retrieve an Asset Report Audit Copy
POST /asset_report/audit_copy/pdf/get Retrieve a PDF Asset Report Audit Copy
POST /asset_report/audit_copy/remove Remove Asset Report Audit Copy
POST /asset_report/create Create an Asset Report
POST /asset_report/filter Filter Asset Report
POST /asset_report/get Retrieve an Asset Report
POST /asset_report/pdf/get Retrieve a PDF Asset Report
POST /asset_report/refresh Refresh an Asset Report
POST /asset_report/remove Delete an Asset Report
POST /credit/relay/create Create a relay token to share an Asset Report with a partner client
POST /credit/relay/get Retrieve the reports associated with a relay token that was shared with you
POST /credit/relay/pdf/get Retrieve the pdf reports associated with a relay token that was shared with you (beta)
POST /credit/relay/refresh Refresh a report of a relay token
POST /credit/relay/remove Remove relay token

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

What's inside the Assets template

Fifteen endpoints cover asset-report operations end to end, and the write side hands back something newly coined at every turn: /asset_report/create, /refresh, and /filter each answer with a fresh assets-report token and report id, audit-copy creation coins its own audit-copy token for the share-with-lender flow, and the /credit/relay family does the same for partner handoffs. The read side is narrower on purpose — the report JSON stays behind /asset_report/get's INVALID_ASSET_REPORT_TOKEN response, while the PDF routes deliver an application/pdf byte stream and both remove routes confirm with removed:true.

  • Report operations — create, refresh, and filter, each issuing a fresh token-and-id pair
  • PDF retrieval — application/pdf responses on the report and audit-copy pdf routes
  • Audit copies — token creation and removal for sharing a report with a lender
  • Partner relay — the /credit/relay family for handing reports to another client
  • Removal — removed:true confirmations on both delete routes

Frequently asked questions

The get route is wired as the product's error path — token not found, whatever token you present, including one coined seconds earlier. That makes this instance a fixture for the retry-and-alert branch of a report-polling loop; the report JSON itself, with its per-account historical balances and transactions, needs a WireMock Cloud copy with a success stub on this route.

No. /asset_report/audit_copy/get and /credit/relay/get fail with a 500 on every request — their response templates render an empty report field, which breaks the JSON before it leaves the stub. Treat both as known-broken on the shared instance and work with the create, refresh, and remove routes around them; a private copy can replace the two bodies outright.

The literal header of a PDF and nothing more, under the correct content type. It exists so the fetch side of a report pipeline — the poll, the save-to-storage step, the handoff to an underwriting UI — has genuine bytes to move; a renderer given the body will show an empty document rather than an error.

Asset reports increasingly travel as one input to Plaid's consumer-report products, and the Consumer Report template models that destination — check reports, cash-flow insights, a scored decision layer, and a PDF route that serves a structurally complete document where this one stops at the header line.

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