Document Verifications

Implementation guide for document-based income verifications.

Overview#

Receive Freddie Mac monthly income calculations from uploaded paystubs and W2s.

• Upload paystubs and W-2s when borrower cannot connect via Argyle with a direct payroll login
• Generate an Argyle Doc VOI report with rep & warrant determination for income and employment

Supported report types#

• Verification of Income (Doc VOI)

Workflow#

Argyle's Postman collection contains examples of the document upload and verification endpoints mentioned below.

Subscribe to webhook#

1. Subscribe to the verifications.updated webhook.
   When subscribing, it is recommended to set include_resource to true to receive the full verification object in the webhook payload, which includes the verification's status state.

Request a verification#

1. Order a verification through the /verifications API endpoint.

In your request, at minimum you are required to provide:

• Borrower details: first name, last name, and ssn
• Employment details: employer name(s), employment status, hire date, and termination date (for previous employments)
  One year and one month of previous employment history is required.

2. After ordering a verification, an Argyle user will be created automatically. The user id will be returned in the API response.
   Ordering verifications for existing users is not supported at this time.

Upload documents#

3. Upload documents for the user through the /user-uploads API endpoint.
   Most recent paystub and previous year W-2s or December paystubs for each employment are typically required.
   — Contact your Argyle customer success manager for more information.

Retrieve Doc VOI report#

1. When a verifications.updated webhook is received and the status state is COMPLETED, a Doc VOI report can be retrieved via:
   • file_url — retrieves PDF report
   • json_url — retrieves report in JSON format

Testing#

Sandbox#

Production#

FAQs#