Plaid logo
Docs
ALL DOCS

Sandbox

  • Overview
  • Sandbox institutions
  • Test credentials
  • Customize test data
Plaid logo
Docs
Plaid.com
Get API keys

Sandbox test credentials

Simulate different flows using Sandbox credentials

Sandbox simple test credentials

The easiest approach to create Items in the Sandbox is by using the username user_good. This gives you some limited control over Sandbox Item creation flow. It is not as flexible as the custom Sandbox, as Item details such as accounts and transactions are hardcoded.

1username: user_good
2password: pass_good
3pin: credential_good (when required)

Sandbox multi-factor credentials

You can trigger any multi-factor authentication (MFA) flow that Plaid supports when creating an Item by using username user_good and modifying the password.

Bank of America and U.S. Bank cannot be used as test institutions when triggering MFA flows with modified passwords. Instead, these banks will always launch on Sandbox with an MFA flow.

Multi-factor device OTP
1username: 'user_good'
2password: 'mfa_device'
3
4# Code for all devices: 1234
5code: 1234
Multi-factor questions
1# n-rounds of m-questions per round, where 0 <= i, j < 9
2username: 'user_good'
3password: 'mfa_questions_<n>_<m>'
4
5# answer_<i>_<j>, for j-th question in i-th round.
6answer: 'answer_<i>_<j>'
Multi-factor selections
1username: 'user_good'
2password: 'mfa_selections'
3
4answer: 'Yes'
1# n-rounds of m-questions with o-answers per question
2# 0 < n, m < 10 and 2 <= o < 10
3username: 'user_good'
4password: 'mfa_selections_<n>_<m>_<o>'
5
6# answer_<n>_<m>_0, for m-th question in n-th round.
7answer: 'answer_1_1_0'

ReCAPTCHA testing credentials

You may trigger a reCAPTCHA in Plaid Link in the Sandbox environment by customizing the test account password. Possible values are good or bad. A value of good will result in successful Item creation and bad will result in a RECAPTCHA_BAD error to simulate a failed reCAPTCHA. Both values require the reCAPTCHA to be manually solved within Plaid Link.

1username: user_good
2password: {"recaptcha":"bad"}

Error testing credentials

You can trigger several ITEM_ERROR or INSTITUTION_ERROR errors that you may encounter when creating an Item by using username user_good and modifying the password.

1error_[ERROR_CODE]

For example, the password error_ITEM_LOCKED allows you to simulate an ITEM_LOCKED error.

The list of errors that can be simulated in this way is below:

1"COUNTRY_NOT_SUPPORTED"
2"INSTITUTION_DOWN"
3"INSTITUTION_NOT_RESPONDING"
4"INSTITUTION_NO_LONGER_SUPPORTED"
5"INSUFFICIENT_CREDENTIALS"
6"INTERNAL_SERVER_ERROR"
7"INVALID_CREDENTIALS"
8"INVALID_MFA"
9"INVALID_SEND_METHOD"
10"ITEM_LOCKED"
11"ITEM_NOT_SUPPORTED"
12"MFA_NOT_SUPPORTED"
13"NO_ACCOUNTS"
14"PAYMENT_INVALID_RECIPIENT"
15"PRODUCTS_NOT_SUPPORTED"
16"USER_SETUP_REQUIRED"

Auth micro-deposit testing credentials

For automated micro-deposit testing, use the username user_good with the password microdeposits_good. For more details, see Institution details for Auth testing.

Was this helpful?
Developer community
Github logo
StackOverflow logo
Twitter logo