API Reference

Simulate Plaid Link (sandbox only)

post
https://api.sb.spidrsrv.com/ztm/v1/linked-institution/session/simulate-link

Simulates a user completing the Plaid Link flow by generating a sandbox public token. This endpoint is for sandbox/non-production environments only.

Use this endpoint to test the linked institution flow without requiring a user to go through the Plaid Link UI.

Flow:

  1. Call session/create to get a linkedInstitutionSessionId
  2. Call this endpoint (session/simulate-link) to get a publicToken
  3. Call session/complete with the publicToken

Note: This endpoint will fail in production environments or when configured with a non-sandbox Plaid URL.

Body Params

POST /v1/linked-institution/session/simulate-link Request body

string
required

The linked institution session's unique ID within Spidr

string
Defaults to ins_109508

The Plaid institution ID to simulate linking with. Defaults to 'ins_109508' (First Platypus Bank - sandbox test bank).

boolean
Defaults to false

Link as Plaid's user_transactions_dynamic sandbox user instead of the default user_good. Required when you plan to inject synthetic transactions via simulate-transactions: Plaid's sandbox/transactions/create only materializes transactions on dynamic-transaction items — on the default canned user the call succeeds but the transactions never appear.

Responses

Updated 3 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago