Test the APIs

Introduction

In this page, you will learn how to use our test banks (FinBanks) and test payroll provider (FinPayroll). You will get access to a wide variety of profiles and data to test different types of use case scenarios.

Test profiles are enabled by starting a Connect session and by logging in with specific customer credentials. To understand how to create customers and Connect links, we recommend you read the Quick Start Guide first.

Partners can enroll up to 100 testing customers, with up to 20 accounts per testing customer.

Sign-In Authentication Profiles

Use these profiles to test different authentication and error scenarios when adding customer accounts. The discovery and activation responses can contain several different multi-factor authentication (MFA) challenge questions, depending on the customer’s sign-in information.

Steps:

Finicity Connect for Sign-in Authentication Profiles

Banking UserIdBanking PasswordMFA TypeExpected Behavior
demogo(none)Success
demo123, 125, 127, 128 or 130(none)Fails with the error code used for “Banking Password”
invalid_usergo(none)Returns “Error 103: Invalid Credentials”
tfa_textgoText-based MFAIf the answer to the MFA challenge is “mfa”, then the response is another MFA challenge.
tfa_imagegoImage captchaAny MFA answer is accepted.
tfa_choicegoMultiple text optionsIf the answer to the MFA challenge is fail, the call fails with code 187 (Invalid MFA). [MFA example]
tfa_multigoSame as MFA with image choice (style 1)Any MFA answer is accepted.
demoimagechoiceMFA with image choice (style 1)Any MFA answer is accepted.
demoimagechoice2MFA with image choice (style 2)Any MFA answer is accepted.
discovertimeoutgo(none)Calls to “Add All Accounts” and “Discover Accounts” will take more than 180 seconds, for testing the client app’s asynchronous handling.
activatedtimeoutgo(none)Calls to “Refresh Customer Accounts” and “Accounts” and “Load Historic Transactions” will take more than 180 seconds to test the app’s asynchronous handling.

Bank Account Profiles

Bank account profiles consist of various combinations of account types, such as checking, savings, 401k, and more.

We will use here FinBank Profiles – A and FinBank Profiles – B. Both function the same, this way you can test scenarios where one customer has two accounts located at a different bank.

Steps:

Finicity Connect for Bank Account Profiles

Note about profiles:

  • Profiles 2-8 were created from real financial institution data, but without personal identification information (PII)
  • Profiles 2-9 are for general testing of our product
Banking UserIdBanking PasswordAccount TypesSupported Products
(any)profile_02Savings, IRA, 401k, Credit Cardach, aha, state_agg, trans_agg, voa, voi
(any)profile_03Checking, Personal Investment, 401K, Roth, Savings (Joint Account owners)ach, aha, state_agg, trans_agg, voa, voi
(any)profile_04Checking, 403B, 529, Rollover, Mortgageach, aha, state_agg, trans_agg, voa, voi
(any)profile_05Checking, Investment, Stocks, UGMA, UTMA (Joint Account owners)ach, aha, state_agg, trans_agg, voa, voi
(any)profile_06Checking, Retirement, KEOGH, 457, Credit Cardach, aha, state_agg, trans_agg, voa, voi
(any)profile_07Checking, Stocks, CD, Investment Tax-Deferred, Employee Stockach, aha, state_agg, trans_agg, voa, voi
(any)profile_08Checking, Primary Savings, Money Market, 401A, Line of creditach, aha, state_agg, trans_agg, voa, voi
(any)profile_09Checking, Savings, Checking Failed Report. Errors returned in the report include 102, 103, 185.ach, voa (failed report), voi (failed report)

OAuth Connection Profiles

The profiles below are convenient to test OAuth connections between Finicity and financial institutions who have set up direct connections.

You must register for FinBank OAuth to gain access to the OAuth Connection profiles. Contact your account manager to help you get registered.

Steps:

Finicity Connect for OAuth Connection Profiles

Banking UserIdBanking PasswordAccount TypesSupported Products
profile_02profile_02Savings, IRA, 401k, Credit Cardach, aha, state_agg, trans_agg, voa, voi
profile_03profile_03Checking, Personal Investment, 401K, Roth, Savings (Joint Account owners)ach, aha, state_agg, trans_agg, voa, voi
profile_04profile_04Checking, 403B, 529, Rollover, Mortgageach, aha, state_agg, trans_agg, voa, voi
profile_05profile_05Checking, Investment, Stocks, UGMA, UTMA (Joint Account owners)ach, aha, state_agg, trans_agg, voa, voi
profile_06profile_06Checking, Retirement, KEOGH, 457, Credit Cardach, aha, state_agg, trans_agg, voa, voi
profile_07profile_07Checking, Stocks, CD, Investment Tax-Deferred, Employee Stockach, aha, state_agg, trans_agg, voa, voi
profile_08profile_08Checking, Primary Savings, Money Market, 401A, Line of creditach, aha, state_agg, trans_agg, voa, voi
profile_09profile_09Checking, Savings, Checking Failed Report. Errors returned in the report include 102, 103, 185.ach, voa (failed report), voi (failed report)

Payroll Profiles

Use these profiles to test products that contain payroll data. For that:

  • 1

    Create a consumer with the SSN and DOB from the table below

  • 2

    Use the same SSN and DOB in the payroll products/APIs

Borrower NameSSNDOB (MM-DD-YYYY)Description
Homer Loanseeke99960111107-04-19701 active employment; salary, base
Jess Sea99900114707-05-19801 active employment; salary, base
Ann Sea99900906607-06-19861 active employment; commission only
Suzi Builder99960666607-07-19952 active employments; salary, base + overtime
Alice Firstimer99191999112-27-19921 active employment; salary, base + overtime
Lorraine Purchaser99956567805-02-19851 active employment; hourly, base
Patrick Purchaser99912123409-09-19871 active employment; hourly, base
Andy Freddie99030000308-06-19901 active employment; salary, base + bonus + overtime + commissions, 1 terminated employment
Dan Freddie99100001008-02-19701 active employment; salary, base + bonus
Patrick Freddie99050000508-09-19801 active employment; base, semi-monthly, salary
Amy Freddie99040000408-07-19801 active employment; base + bonus, bi-weekly, salary
Suzi Freddie99070000708-06-19902 active employments; base; semi-monthly, monthly
Mom Freddie99011001108-04-19702 active employments; base + bonus + overtime + commissions, bi-weekly
Alice Freddie99008000808-05-19901 terminated employment; base, semi-monthly
John Freddie99010000108-01-19701 active employment w/ payroll; base + bonus + commission + overtime + weekly. Child support, military, VA benefits, alimony.

Note: Only base, bonus, commission, and overtime are on the payroll report.

Nomoni Freddie12345678801-01-2000No payroll data (test 404 error)
Nomula Frannie12345678701-01-2000No payroll data (test 404 error)

Paystub Profiles

To test our APIs that use paystub data, click “Download ⤓” links in the table below and download some of the test paystubs.

For products that use digitized paystub data to compare against the customer’s deposited payroll transactions, follow the following steps:

Finicity Connect for Paystub Profiles

Borrower NameBanking UserId / Banking PasswordDescription Paystub
Jess Seaprofile_25131 active employment; salary, baseDownload ⤓
Ann Seaprofile_25141 active employment; commission onlyDownload ⤓
Alice Firstimerproflle_10191 active employment; salary, base + overtimeDownload ⤓
Lorraine Purchaserprofile_10201 active employment; hourly, baseDownload ⤓
Patrick Purchaserprofile_10211 active employment; hourly, baseDownload ⤓
David Burtonprofile_10271 active employment; split direct depositDownload ⤓
Andy Millerprofile_10181 active employment; salary, baseDownload ⤓
Andy Freddieprofile_25111 active employment; salary, base + bonus + overtime + commissionsDownload ⤓
Dan Freddieprofile_5401 active employment; salary, base + bonusDownload ⤓
Suzi Freddieprofile_25122 active employments; base; semi-monthly, monthlyDownload ⤓

MVS Profiles

Use information in the table below to test the MVS Financial, Payroll, and Paystub apps altogether in one Connect session or test them individually in a single Connect session.

Steps:

  • 3

    Search for FinBank Profiles – A

  • 4

    When asked for a username and password, use user IDs and passwords from the table below

  • 5

    Create a consumer with the SSN and DOB from the table below

  • 6

    Use the same SSN and DOB in the payroll products/APIs

  • 7

    Click “Download ⤓” links to download the test paystubs

Finicity Connect for MVS Profiles

MVS Test Profiles and GSEs Borrower Information Banking UserId / Banking Password Pay Data
Profile Number Description GSE Name SSN DOB (MM-DD-YYYY) Paystub Payroll
MVS-1
FR1
1 active employment w/payroll; salary, base Fannie Homer Loanseeker 999601111 07-04-1970 profile_2509 (n/a)
MVS-1
FPR2
1 active employment w/payroll or paystub; salary, base Fannie Jess Sea 999001147 07-05-1980 profile_2513 Download ⤓
MVS-1
FPR3
1 employment w/payroll or paystub; commission only Fannie Ann Sea 999009066 07-06-1986 proflle_2514 Download ⤓
MVS-1
FR4
2 active employment w/payroll; salary, base + overtime Fannie Suzi Builder 999606666 07-07-1995 profile_2510 (n/a)
MVS-1
FPR5
1 active employment w/payroll or paystub; salary, base + overtime Fannie Alice Firstimer 991919991 12-27-1992 profile_1019 Download ⤓
MVS-1
FPR6
1 active employment w/payroll or paystub; hourly, base Fannie Lorraine Purchaser 999565678 05-02-1985 profile_1020 Download ⤓
MVS-1
FPR7
1 active employment w/payroll or paystub; hourly, base Fannie Patrick Purchaser 999121234 09-09-1987 profile_1021 Download ⤓
MVS-1
FP8
1 active employment w/paystub; split direct deposit David Burton 444556666 05-04-1980 profile_1027 Download ⤓
MVS-1
FP9
1 active employment w/payroll or paystub; salary, base Andy Miller 881110010 05-05-1980 profile_1018 Download ⤓
MVS-2
FPR10
1 active employment w/payroll or paystub; salary, base + bonus + overtime + commissions.

1 terminated employment w/payroll

Freddie Andy Freddie 990300003 08-06-1990 profile_2511 Download ⤓
MVS-2
FPR11
1 active employment w/payroll or paystub; base + bonus Freddie Dad Freddie 991000010 08-02-1970 profile_540 Download ⤓
MVS-2
R12
1 active employment w/payroll; base, semi-monthly, salary Freddie Patrick Freddie 990500005 08-09-1980 (n/a) (n/a)
MVS-2
R13
1 active employment w/payroll; base + bonus, bi-weekly, salary Freddie Amy Freddie 990400004 08-07-1980 (n/a) (n/a)
MVS-2
FPR14
2 active employments w/payroll or paystub; base, semi-monthly, monthly Freddie Suzi Freddie 990700007 08-06-1990 profile_2512 Download ⤓
MVS-2
R15
2 active employments w/ payroll; base + bonus + overtime + commissions, bi-weekly Freddie Mom Freddie 990110011 08-04-1970 (n/a) (n/a)
MVS-2
R16
1 terminated employment w/payroll; base, semi-monthly Freddie Alice Freddie 990080008 08-05-1990 (n/a) (n/a)
MVS-2
FR17
1 active employment w/payroll; base + bonus + overtime, weekly, commissions, child support, military, VA benefits, and alimony.

Note: Only base, bonus, overtime, and commissions are on the payroll report.

Freddie John Freddie 990100001 08-01-1970 profile_2260 (n/a)
MVS-2
R18
No payroll (test 404 error) Fannie Nomula Frannie 123456787 01-01-2000 (n/a) (n/a)
MVS-2
R19
No payroll (test 404 error) Freddie Nomoni Freddie 123456788 01-01-2000 (n/a) (n/a)