Implementation Guide
Plaid Exchange Implementation guide
Scoping and implementation setup
Review the Plaid Exchange API Reference documentation
Prepare one or more test accounts for each type of account you support (checking, savings, credit card, loan, 401k, etc.) Ensure that:
- All accounts have balance data.
- All accounts have contact data.
- Depository, loan, and investment accounts have transaction data.
- Depository accounts have payment networks data.
- Negative test accounts (accounts in a bad state).
IP allowlist
1["54.208.59.10", "54.88.74.128", "54.88.202.28", "52.88.82.239", "52.41.247.19"]If in testing, also add the following
1["104.131.160.201", "3.80.88.60"]Building and testing
Develop and test authentication
- Issue Plaid a Client ID and Secret.
- Build / Test OAuth flow according to guidelines.
Note: Plaid Exchange can support MFA/OTP authorization patterns, but it is not recommended.
Develop and test Plaid Exchange Endpoints
Use the Plaid Exchange API Reference to guide endpoint creation.
/oauth2/auth: OAuth 2.0 Auth flow/oauth2/token: OAuth 2.0 Token flow/users/{user_id}: Retrieve account and identity information/users/{user_id}/transactions: Retrieve transaction history
Go-live
Get ready for production
Confirm your organization's name, logo, and URL. Plaid uses this information to populate your organization's details in Plaid Link. Your logo file must be a 96x96 circular PNG and under 2MB If you would like to make an external launch announcement, reach out to our Plaid team to finalize plans
Pilot and migrate
(Note: This section only applies to existing Plaid partners)
If your institution is already supported in Plaid Link or you are a platform provider with numerous institutions, we will partner together to develop a pilot and migration plan. Migrations typically have 4 phases:
| Phase | Description | Timeline | |
|---|---|---|---|
| 1 | Friends and Family Testing | imited access, internal user traffic | ~ 2 weeks |
| 2 | Pilot Cohort | Enable new connections in production for pilot cohort, monitor health and resolve issues | ~ 2 weeks |
| 3 | Remaining Cohorts | Enable new connections in production for pilot cohort, monitor health and resolve issues # of cohorts is partner dependent | ~ 2-3 weeks |
| 4 | Existing User Migration | After integration health is validated, Plaid will begin a process to migrate all existing items over to the OAuth + API connection. | ~120 days |
- Timeline illustrative. Speed contingent on ability to validate institutional health, address any open issues etc.
Ongoing management
We will continue to partner together to ensure integration quality after you go live on API connectivity with Plaid. Key integration health metrics Plaid monitors include: conversion, data access success rate, data availability and accuracy.
Update the Plaid team with the correct point of contact to support ongoing integration health Log the variables below to help troubleshoot any potential issues with the integration:
- OAuth flow: log
oauth_state_id - API connections: log
FI_UNIQUE_ID