Plaid logo
Docs
ALL DOCS

Sandbox

  • Overview
  • Sandbox institutions
  • Test credentials
  • Customize test data
Plaid logo
Docs
Close search modal
Ask Bill!
Ask Bill!
Hi! I'm Bill! You can ask me all about the Plaid API. Try asking questions like:
    Note: Bill isn't perfect. He's just a robot platypus that reads our docs for fun. You should treat his answers with the same healthy skepticism you might treat any other answer on the internet. This chat may be logged for quality and training purposes. Please don't send Bill any PII -- he's scared of intimacy. All chats with Bill are subject to Plaid's Privacy Policy.
    Plaid.com
    Log in
    Get API Keys
    Open nav

    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.

    Note that error testing credentials are not compatible with institutions that use OAuth. If you are not sure whether an institution uses OAuth flows, see the list of Sandbox institutions to find an institution that is guaranteed not to use OAuth.

    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_INPUT_TIMEOUT"
    17"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.

    Monitor and Identity Verification testing users

    Monitor and Identity Verification have product-specific Sandbox users that can be used for testing. For more details, see Testing Monitor and Testing Identity Verification.

    Bank Income testing credentials

    For Bank Income testing, use the username user_bank_income with the password {}. For more details, see Testing Bank Income.

    Transactions dynamic testing credentials

    For a test user with simulated realistic transaction activity, including the creation of new transactions that begin in a pending state and move to posted, use username user_transactions_dynamic with any non-blank password. For more details, see Testing pending and posted transactions.

    Was this helpful?
    Developer community
    GitHub
    GitHub
    Stack Overflow
    Stack Overflow
    YouTube
    YouTube
    Discord
    Discord