Banking Overview Guide

Implementation guide for banking reports.

Overview#

Verify assets and income and generate verification reports by allowing users to directly connect their financial institutions.

Supported report types#

• Verification of Assets (VOA)
• Verification of Income (VOI)
• Verification of Assets & Income (VOAI)

Workflow#

Create an Argyle user#

1. Create or update an Argyle user.
2. In the request body, include the following required user fields (only required for banking reports):

   Required user fields for banking reports:

Create a Connect URL#

1. Create a Connect URL — a temporary link that allows the user to securely authorize access to their bank data.
2. In the request body, make sure to specify via the webhook field where to receive Connect Event webhooks, which will be used for implementation routing.

Initiate connection flow#

1. Share the Connect URL with the user directly, or embed the bank connection experience within your application.

Generate a banking report#

1. 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.
2. Generate a banking report and specify the report type in the request.
   Optionally specify via the webhook field where to receive the Connect Event webhook notifying you that the report has been generated.

3. 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:

   1{
   2    "detail": "INVALID_ARGUMENT: Code: 5030, error: No matching account types apply"
   3}
   

Retrieve report PDFs and JSONs#

1. When you receive a Connect Event webhook with "event_name": "done" a banking report has been successfully generated and can be retrieved.
2. To retrieve a PDF version of the report, call GET {file_url} — make sure to include Argyle authentication headers.
3. To retrieve a JSON version of the report, call GET {json_url} — make sure to include Argyle authentication headers.

Day 1 Certainty® and AIM#

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:

Connect events#

Connect Event webhooks are sent:

• When the user completes certain steps of the connection process.
• When a report is being and has been successfully generated.

Most common Connect Event webhooks (examples):

Related endpoints#

• The reports endpoint can be used to retrieve reports by user or report ID.
• The bank accounts endpoint can be used to retrieve a list of the user's bank accounts.
• The financial institutions endpoint can be used to search for supported financial institutions.

Testing profiles#

The following sample test profiles can be connected to the FinBank Profiles A or FinBank Profiles B financial institutions.

For specific scenario testing, the following sample test users are also available: