API template library

Plaid Beacon mock API and live sandbox

A WireMock simulation of Plaid's REST API — covering Beacon users, fraud reports, report syndication, duplicate analysis, and account-risk evaluation.

Vendor
Plaid
Functionality
Fraud reporting and screening
Spec version
2020-09-14_1.688.6
Endpoints
13
Stubs
17
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 Beacon

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

Base URL
https://y0w0v.wiremockapi.cloud

POST Create - /beacon/user/create

curl -s -X POST 'https://y0w0v.wiremockapi.cloud/beacon/user/create' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Get - /beacon/user/get

curl -s -X POST 'https://y0w0v.wiremockapi.cloud/beacon/user/get' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Update - /beacon/user/update

curl -s -X POST 'https://y0w0v.wiremockapi.cloud/beacon/user/update' \
  -H 'Content-Type: application/json' \
  -d '{}'
Method Path Summary
POST /beacon/account_risk/v1/evaluate Evaluate risk of a bank account
POST /beacon/duplicate/get Get a Beacon Duplicate
POST /beacon/report_syndication/get Get a Beacon Report Syndication
POST /beacon/report_syndication/list List Beacon Report Syndications for a Beacon User
POST /beacon/report/create Create a Beacon Report
POST /beacon/report/get Get a Beacon Report
POST /beacon/report/list List Beacon Reports for a Beacon User
POST /beacon/user/account_insights/get Get Account Insights for a Beacon User
POST /beacon/user/create Create a Beacon User
POST /beacon/user/get Get a Beacon User
POST /beacon/user/history/list List a Beacon User's history
POST /beacon/user/review Review a Beacon User
POST /beacon/user/update Update the identity data of a Beacon User

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

What's inside the Beacon template

Beacon is Plaid's shared fraud network, and the sandbox models both halves of membership. Contribution is recorded: users and fraud reports created here receive fresh ids and then genuinely appear in the history and listing routes, which accumulate entries across visitors. Consumption stays canonical: the get and review routes answer with the network's reference user in cleared status, the duplicate route lays out a seven-field analysis with every field matching, and account-risk evaluation returns the connection-history attributes — days since first Plaid connection, connection counts across time windows — that velocity rules consume.

  • Beacon users — minted creations, a cleared canonical record, and the review and update routes
  • Fraud reports — first-party report creation and a listing that accumulates entries
  • Syndication — the report-syndication records other network programs receive
  • Duplicates — the all-fields-match analysis a confirmed duplicate produces
  • Account risk — the connection-history attribute set behind velocity scoring
  • Insights & history — bank-account insights and the user version-history list

Frequently asked questions

They land in a store every visitor shares — the history and report listings replay them until the sandbox resets. Useful for observing the accumulate-then-list behavior, and a firm reason to keep payloads synthetic: the fixture identities already carry test SSNs, and nothing anyone posts to this instance is private.

Reads are canonical by design — whatever id you present, the response is the network's reference user with its cleared status and program id. The store's memory shows in the list routes instead, so point shape assertions at get and existence assertions at history/list.

The ceiling case: the same user on both sides, and all seven compared fields — name, date of birth, address, email, phone, ID number, IP — reporting match. Threshold logic that reads per-field results gets the strongest possible input; partial-match cases are an edited stub away in a private copy.

They gate different risks. The Identity Verification template decides whether a person is real and is who they claim; Beacon asks whether that person has already defrauded another member of the network. Onboarding stacks typically run one and then the other.

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