Plaid logo
Docs
ALL DOCS

Auth

  • Introduction to Auth
  • Add Auth to your app
  • Money movement partnerships
  • Increasing pay-by-bank adoption
  • Additional Auth flows
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

    Testing Auth flows

    Testing Instant Match and micro-deposit flows

    Sandbox configuration

    To test in the Sandbox environment, you need to set the Link configuration environment to "sandbox":

    1Plaid.create({
    2 // ...
    3 env: 'sandbox',
    4});

    You will also want to direct any backend API requests to the sandbox URL:

    1https://sandbox.plaid.com

    Testing Instant Match

    Test credentials
    Sandbox inputSuccessful credentialsErroneous credentials
    Institution NameHoundstooth Bank (ins_109512)––
    Usernameuser_good––
    Passwordpass_good––
    Account SelectionPlaid Savings (****1111)––
    Routing number021000021Any other routing number
    Account number1111222233331111Any other account number
    Entering the Link flow
    • Search for “Houndstooth Bank” in Link.
    • Use the input data in the table above to simulate the desired outcome.

    Testing Instant Micro-deposits

    You can also test this flow in Sandbox with no code by using the Link Demo.

    Sandbox inputSuccessful credentialsErroneous credentials
    Institution nameWindowpane Bank (ins_135858)––
    Routing number333333334Any other value (if testing upgrade path)
    Account number1111222233330000––
    Deposit codeABCAny other value
    Entering the primary Link flow
    • Search for "Windowpane Bank" in Link.
    • When prompted, use the input data in the table above to simulate the desired outcome.
    • For all other fields, you can use any values.
    Testing the upgrade path from Same Day Micro-deposits to Instant Micro-deposits
    • If you have enabled Same Day Micro-deposits, enter gibberish into the search bar to ensure no institutions will be found, then click on Link with account numbers.
    • If you have configured Same Day Micro-deposits with Auth Type Select, choose "Manually" from the menu.
    • When prompted, enter the input data in the table above. For all other fields, you can use any values.
    • Note that, unlike the primary Instant Micro-deposits flow, the routing and account number entries will be on separate panes.

    Testing Database Match

    You can also test this flow in Sandbox with no code by using the Link Demo.

    Test credentials

    To simulate a database_matched result:

    Sandbox inputCredentials
    Routing number110000000
    Account number1111222233331111
    NameJohn Smith

    Any other input will simulate no match and proceed with Same Day Micro-deposits, e.g.:

    Sandbox inputCredentials
    Routing number110000000
    Account number1111222233332222
    NameJohn Smith
    Entering the Link flow
    • If you have enabled Database Match, enter gibberish into the search bar to ensure no institutions will be found, then click on Link with account numbers.
    • If you have configured Database Match with Auth Type Select, choose "Manually" from the menu.
    • Use the input data in the table above to simulate different outcomes.

    Testing Database Auth or Database Insights

    You can also test this flow in Sandbox with no code by using the Link Demo.

    Test credentials (US-based sessions)

    To simulate a database_insights_pass result:

    Sandbox inputCredentials
    Routing numberAny routing number (e.g. 110000000)
    Account number1111222233331111

    To simulate a database_insights_pass_with_caution result:

    Sandbox inputCredentials
    Routing numberAny routing number (e.g. 110000000)
    Account number1111222233333333

    Any other account number will simulate a database_insights_fail result, e.g.:

    Sandbox inputCredentials
    Routing numberAny routing number (e.g. 110000000)
    Account number1111222233332222
    Test credentials (CA-based sessions)

    To simulate a database_insights_pass result:

    Sandbox inputCredentials
    Institution number110
    Branch number11111
    Account number11223311

    To simulate a database_insights_pass_with_caution result:

    Sandbox inputCredentials
    Institution number110
    Branch number11111
    Account number11223333

    Any other input will simulate a database_insights_fail result, e.g.:

    Sandbox inputCredentials
    Institution number110
    Branch number11111
    Account number11223322
    Entering the Link flow
    • If you have configured Database Auth or Database Insights with Auth Type Select, choose "Manually" from the menu.
    • If you have configured Database Auth or Database Insights with Embedded Search, choose "Connect Manually".
    • If you have enabled Database Auth or Database Insights without either of the above options, enter gibberish into the search bar to ensure no institutions will be found, then click on "Link with account numbers".
    • Use input data from the table above to simulate various outcomes.

    Testing Automated Micro-deposits

    You can also test this flow in Sandbox with no code by using the Link Demo.

    Test credentials
    Sandbox inputSuccessful credentialsErroneous credentials
    Institution NameHoundstooth Bank (ins_109512)––
    Usernameuser_good––
    Passwordmicrodeposits_good––
    Account SelectionPlaid Checking (****0000)––
    Routing number021000021Any other routing number
    Account number1111222233330000Any other account number
    Entering the Link flow
    • Search for “Houndstooth Bank” in Link.
    • Use the input data in the table above to simulate the desired outcome.

    The micro-deposit verification will automatically succeed after twenty-four hours. To test a failed micro-deposit, or to skip the twenty-four hour waiting period, use the /sandbox/item/set_verification_status endpoint to manually control the Item's micro-deposit verification status.

    Testing Same Day Micro-deposits

    You can also test this flow with no code by using the Link Demo.

    Test credentials
    Sandbox inputSuccessful credentialsErroneous credentials
    Routing number110000000––
    Account number1111222233330000––
    Deposit codeABCAny other value
    Initiating micro-deposits in Link
    • If you have configured Same Day Micro-deposits with Auth Type Select, choose "Manually" from the menu
    • If you have enabled Same Day Micro-deposits without Auto Type Select, enter gibberish into the search bar to ensure no institutions will be found, then click on "Link with account numbers".
    • Use the input data in the table above to simulate the desired outcome.
    Verifying micro-deposits in Link
    • Call /item/public_token/exchange with your public_token from the Link session in previous step to receive an access_token.
    • Call /link/token/create and provide the access_token from the previous step to receive a link_token.
    • Open Link with your link_token.
    • In the deposit code field, enter ABC

    Testing micro-deposit events

    Micro-deposits that are generated in Sandbox will never be posted by default. In order to generate a posted event that you can see when you query /bank_transfer/event/sync, you can use the /sandbox/bank_transfer/simulate endpoint.

    Simulating a posted event in Sandbox does not generate a webhook. You will need to call /sandbox/bank_transfer/fire_webhook each time you want a webhook to be published for testing.

    Testing Identity Match with Same Day micro-deposit Items

    Sandbox inputSuccessful credentialsErroneous credentials
    Routing number011401533110000000
    Account number11112222333300001111222233330000
    Deposit codeABCABC
    • Complete the Same Day Micro-deposits flow as detailed above
    • Call /identity/match using any variation of data in order to test the matching algorithm
    • The identity data of the test user is as follows:
    FieldSandbox identity
    NameAlberta Bobbeth Charleson
    Emailaccountholder0@example.com
    Phone1112223333
    Street2992 Cameron Road
    CityMalakoff
    RegionNY
    CountryUS
    Postal Code14236
    Was this helpful?
    Developer community
    GitHub
    GitHub
    Stack Overflow
    Stack Overflow
    YouTube
    YouTube
    Discord
    Discord