The Sandbox testing environment for banking supports a maximum of 500 users. To stay within this limit, implement user-management workflows and remove inactive users when they are no longer needed.
In the request body, include the following requireduser fields (only required for banking reports):
Required user fields for banking reports:
The top-level (root) object should contain user details (user being the borrower in most cases).
If all fields cannot be populated, speak to your Argyle representative.
The external_metadata object should contain details about the person or entity making the lending decision.
The external_metadata object is optional.
Required user fields for banking reports:
Report incorrect code
Copy
Ask AI
{ "first_name": "Bob", "last_name": "Jones", "email": "[email protected]", "phone_number": "555-111-2222", // must be 10 or 11 digits (with or without hyphens) — e.g. 5551112222 or 555-111-2222 or 15551112222 or 1-555-111-2222 "ssn": "123456789", // must be 9 digits (with or without hyphens) — e.g. 123456789 or 123-45-6789 "address": { "city": "New York", "line1": "759 Victoria Plaza", "line2": null, "state": "New York", "country": "US", "postal_code": "10014" }, "birth_date": { "year": 1980, // integer (must be 1900 or later) "month": 12, // integer (must be between 1 and 12) "day": 3 // integer (must be between 1 and 31) }, "external_metadata": { // this object & all its properties are optional "open_banking": { "end_user": { "name": "Loan Officer", "address": "759 Victoria Plaza", "city": "New York", "state": "NY", "zip": "10014", "phone": "7778889999" // must be 10 or 11 digits (with or without hyphens) — e.g. 5551112222 or 555-111-2222 or 15551112222 or 1-555-111-2222 } } }}
Create a Connect URL — a temporary link that allows the user to securely authorize access to their bank data.
In the request body, make sure to specify via the webhook field where to receive Connect Event webhooks.
Each environment (Sandbox and Production) requires its own webhook. Subscriptions do not transfer between environments.
Share the Connect URL with the user directly, or embed the bank connection experience within your application.
Contact your Argyle customer success manager to manually register a webhook URL where you will receive Connect Events.
Each environment (Sandbox and Production) requires its own webhook. Subscriptions do not transfer between environments.
Review the following customization options.
Customize the invite and banking experience.
Go to the Flows section of Console. Select “New Flow” and “Email/SMS Template” — (alternatively, an existing “Email/SMS Template” can be edited.)
In the “Landing page” flow step, make sure the “Connect bank account” toggle is ON.
If you want to customize the banking experience, your Argyle customer success manager will provide an Experience ID that can be entered at the bottom of the same page under “Integration reference”.
Save the Flow in Console and copy the Flow ID (will be used in the next step).
Your Argyle customer success manager can help provide the following customizations:
Your company name and logo shown to borrowers can be adjusted.
Which financial institutions are shown by default on the home screen.
After the borrower connects a financial institution, they will be shown a list of detected accounts (e.g. checking, savings, 401k).
You can exclude any of the following account types from being selectable by borrowers:
In the request body, only user_id and flow_id are required.
user_id is returned after creating an Argyle user.
flow_id is obtained after customizing the invite and banking experience.
By default the name, email, and phone number provided when creating an Argyle user will be used. You can optionally override any of these contact values by also specifying them in the request body:
When you receive a Connect Event webhook with "event_type": "done" a banking report can be generated — this event signifies the user has connected their banking accounts and successfully authorized the related connections.
(Optional) Specify via the webhook field where to receive the Connect Event webhook notifying you that the report has been generated.
Save the file_url and json_url values returned in the response after generating a report.
If the user only connected account types (e.g. Line of credit) that are not eligible for the specified report type, the API will return a 400 (Bad Request) response:
For mortgage use cases, the reference number for Day 1 Certainty® or AIM is provided in the portfolio field returned after calling GET{json_url}. In Encompass®, this reference number can be submitted in the Finicity Borrower field:
When you’re ready to begin testing, contact your Argyle Customer Success Manager to enable banking permissions.
The Sandbox testing environment for banking supports a maximum of 500 users. To stay within this limit, implement user-management workflows and remove inactive users when they are no longer needed.
The following sample test profiles can be connected to:
Sandbox — the FinBank Profiles A or FinBank Profiles B financial institutions
Production — the FinBank Billable or FinBank Oauth Billable financial institutions
Username
Password
Account Types
Supported Products
profile_02
profile_02
Savings, IRA, 401k, Credit Card
voa, voi, voai
profile_03
profile_03
Checking, Personal Investment, 401K, Roth, Savings (Joint Account owners)
For specific scenario testing, the following sample test users are also available:
Sue Wealthy
River Paycheck
Alex Student
Username
sue_wealthy
river_paycheck
alex_student
Password
profile_700
profile_703
profile_704
Description
Sue is working as a Product Manager with a good steady income, a mortgage, and multiple investment accounts. She has a loan account and leases a car. Sue travels a few times a year. She has typical expenses like groceries, clothes, entertainment, gym membership, car expenses, and she has a pet.
River works in construction. He rents an apartment and has typical expenses like groceries, clothes, entertainment, household and car expenses. He has some savings but no investments, no loans and no credit cards. In some months, River’s expenses exceed his income.
Alex is working full-time with a good salary but she is still paying off her student loan. She makes regular monthly repayments, but she still has over $30,000 to pay off. Alex has typical expenses like groceries, clothes, entertainment, household, and car expenses. She has limited savings and she has started an investment account.
