Skip to main content
Mortgage implementations use Verifications to order payroll, banking, and Doc VOI products through one lifecycle. The same user can complete multiple verification types as a loan moves from application through closing.

​
Choose verification products

Payroll

Use payroll data borrowers share for income and employment reports.

Banking

Use banking data borrowers share for asset, income, and transaction reports.

Doc VOI

Use documents borrowers upload for mortgage income reports.

​
Implementation workflow

1

Create or reuse the borrower

Maintain one Argyle user for each borrower. Store the user ID with your application or loan record, and use external_id when you need to find the borrower by an identifier from your system.
2

Order each verification

Create a verification for each required report type. Provide the user details required by that product before placing the order.
3

Start the borrower experience

Create a session when the borrower needs to connect a payroll or bank account or upload documents. Launch the returned URL through the appropriate embedded or hosted experience.
4

Track the lifecycle

Subscribe to the verifications.updated webhook with config.include_resource = true. Use verification status for backend decisions; Link callbacks are for the immediate frontend experience.
5

Retrieve the result

When the verification reaches completed or completed_with_errors, download the PDF or JSON from the authenticated URLs in the verification resource.

​
Returning borrowers

Do not create another user when a borrower returns later in the loan. Reuse the original user and choose the return path that matches the request:
  • Use instant refresh when the existing connection or uploaded documents can support a new report.
  • Create a new active verification and session when the borrower needs to connect another account or provide new documents.
  • Create another session for the same active verification if the borrower left before completing the original session.
See Recovery and Errors for invalid user details, incomplete sessions, and other recovery paths.

​
Reports and source documents

Treat the verification webhook as the report-readiness signal. If you also need paystubs or payroll documents, use the employment IDs in the report JSON to limit those requests to employments included in the report. Start with the Verifications Quickstart for complete request examples.