API template library

Plaid Partner mock API and live sandbox

A WireMock simulation of Plaid's REST API — covering end-customer creation, production enablement, and OAuth-institution registration for Plaid resellers.

Vendor
Plaid
Functionality
Reseller customer management
Spec version
2020-09-14_1.688.6
Endpoints
5
Stubs
8
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 Partner

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

Base URL
https://q4eje.wiremockapi.cloud

POST Create - /partner/customer/create

curl -s -X POST 'https://q4eje.wiremockapi.cloud/partner/customer/create' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST Static - /partner/customer/oauth_institutions/get

curl -s -X POST 'https://q4eje.wiremockapi.cloud/partner/customer/oauth_institutions/get' \
  -H 'Content-Type: application/json' \
  -d '{}'
Method Path Summary
POST /partner/customer/create Creates a new end customer for a Plaid reseller.
POST /partner/customer/enable Enables a Plaid reseller's end customer in the Production environment.
POST /partner/customer/get Returns a Plaid reseller's end customer.
POST /partner/customer/oauth_institutions/get Returns OAuth-institution registration information for a given end customer.
POST /partner/customer/remove Removes a Plaid reseller's end customer.

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

What's inside the Partner template

The Partner endpoints are what a Plaid reseller automates against — platforms that provision Plaid access for their own customers — and this sandbox runs their bookkeeping for real. /partner/customer/create registers a new end customer under a freshly minted client_id; get, enable, and remove all consult that registry, honoring ids it issued and answering 400 with Plaid's CUSTOMER_NOT_FOUND envelope for ids it didn't; and remove strikes the record permanently. Around the store, /partner/customer/oauth_institutions/get reports a three-institution registration picture with Chase processing, Capital One enabled, and Bank of America stopped on a logo-required registration error.

  • End-customer store — minted client ids that get, enable, and remove genuinely track
  • Enablement — the production-activation route, gated on the same registry
  • Secrets handling — a sandbox/production secret pair on create, and the production secret again on enable
  • OAuth institutions — per-bank registration states — processing, enabled, and attention-required

Frequently asked questions

The id and nothing else. Reads echo the client_id the registry assigned, but the record body is canonical — company_name Plaid, status ACTIVE — regardless of what the create request contained. Provisioning code should treat the id as the source of truth and the descriptive fields as scenery on this instance.

The create response is the only place the full pair appears — sandbox and production secrets together — while get returns the record without them and enable re-serves just the production secret. That mirrors how real platforms treat credentials as show-once material, and it lets onboarding code practice capturing secrets at the single moment they're offered.

The failure leg of OAuth-institution registration: status ATTENTION_REQUIRED with a PARTNER_ERROR of code OAUTH_REGISTRATION_ERROR and the message that an application logo is required. With Chase mid-process and Capital One fully enabled in the same response, a partner dashboard renders its entire status vocabulary from one call.

Until someone removes them or the instance resets, yes — and the registry is common to every visitor, so treat it as a public scratchpad: invent company data rather than pasting a real customer's, and finish test runs by removing the records they created. The institution directory those OAuth registrations refer to is browsable in the Institutions template.

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