API template library

Plaid Consent mock API and live sandbox

A WireMock simulation of Plaid's REST API — covering the historical log of consent events on a linked bank Item.

Vendor
Plaid
Functionality
Consent event history
Spec version
2020-09-14_1.688.6
Endpoints
1
Stubs
1
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 Consent

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

Base URL
https://kv8v0.wiremockapi.cloud

POST Static - /consent/events/get

curl -s -X POST 'https://kv8v0.wiremockapi.cloud/consent/events/get' \
  -H 'Content-Type: application/json' \
  -d '{}'
Method Path Summary
POST /consent/events/get List a historical log of item consent events

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

What's inside the Consent template

One endpoint, one response — and the response is a story told in five entries. /consent/events/get replays a complete consent arc for a single Item at Platypus bank: four CONSENT_GRANTED events minutes apart, stepping through the event codes USER_AGREEMENT, USE_CASES, DATA_SCOPES, and ACCOUNT_SCOPES, then a CONSENT_REVOKED entry dated a year later that closes the record. Each event fills in only the array its code governs — the use-case entry lists human-readable purposes like "Send and receive money", the data-scope entry names account_balance_info, contact_info, and account_routing_number, and the account-scope entry attaches the consented checking account complete with mask, type, and subtype — so a timeline renderer meets every payload variant the schema defines in one read.

  • Grant sequence — the four-step consent choreography from user agreement through account selection
  • Scope payloads — use-case strings, named data scopes, and the consented account object, each on its own event
  • Revocation — the CONSENT_REVOKED terminus that ends the Item's consent record

Frequently asked questions

Consent-audit surfaces: the "here's what you agreed to and when" screens data-privacy rules increasingly require, compliance exports, and any handler that switches on event_code. Because the four grant codes populate four different arrays, a renderer that assumes one uniform event shape fails on this log the same way it would on production data.

No — the log is a frozen narrative, not the output of live consent machinery. The same five events return on every call, in the same order, with the same timestamps. Treat it as the read-model of a consent system: what changes consent state in the Plaid world is Link and the dashboard, neither of which this surface models.

The envelope names Platypus bank under ins_123456 — a different institution id than the ins_109508 directory entry the other Plaid sandboxes anchor on. Keep that in mind when joining this log to fixtures from sibling templates: match on account rather than institution id, since the consented account is the familiar checking fixture.

Through the connected-application routes — scope updates, unlinks, and the per-app disclosure records — which belong to the Permissions Manager template. Its activity-log route answers with empty arrays on its own sandbox, so the populated consent history lives here and the management controls live there.

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