Mortgages Endpoint

Let Argyle's API calculate payout statement YTD values for you.

This guide introduces the /mortgages endpoint with calculated YTD values for all monetary fields from your users' payout statements.

By utilizing this endpoint, you can increase the speed of implementation and reduce the complexity of your mortgage applications:

• Argyle provides an automated and structured way to collect employment and income data compliant with Fannie Mae 1005 and VA Form 26-8497 (VOE), as well as all of the income data and documentation necessary to compliantly verify income. Our /mortgages endpoint goes one step further, producing standard reusable calculations like YTD income, tenure, basic monthly pay calculations, and more.
• Reduce your team's manual effort and achieve a seamless re-verification process without borrower engagement by utilizing continuous access to the data provided by Argyle. You can subscribe to webhooks to get the latest employment status of borrowers during the application process and gain access to a structured JSON output of W-2 and 1099 forms through our /payroll-documents endpoint.

Endpoint attributes#

Income#

The income object contains:

• A ytd object, with all available monetary fields for the current year.
• When available, additional objects representing previous years with the same monetary fields.

1{
2    "income": {
3        "ytd": {
4            "gross": "21231.02",
5            "bonus": "1231.12",
6            "commissions": "12312.01",
7            "overtime": "123.12",
8            "currency": "USD"
9        },
10        "2022": {
11            "gross": "21231.02",
12            "bonus": "1231.12",
13            "commissions": "12312.01",
14            "overtime": "123.12",
15            "currency": "USD"
16        },
17        "2021": {
18            "gross": "21231.02",
19            "bonus": "1231.12",
20            "commissions": "12312.01",
21            "overtime": "123.12",
22            "currency": "USD"
23        }
24    }
25}

Definitions:

• gross — The amount of gross pay received in this calendar year.
• bonus — Additional amount added to the base pay.
• commission — A fee paid to a user for transacting a piece of business, like closing a sale or making a deal.
• overtime — The amount of pay that is generated during overtime work hours.
• currency — Currency of the payouts. The values of this field follow the ISO 4217 format, for example, USD.

Tenure#

• The tenure object shows whether the user has spent two years in their currently active employment, and indicates the number of days in that tenure.
• The value for tenure can be null if no active employment is found for this account, or the employment data does not have any values for hire_datetime.

1{
2   "tenure":{
3      "twoyears": true,
4      "length": 755
5   }
6}

Definitions:

• twoyears — Indicates whether the user has spent two years in currently active employment. Available only when start_datetime is present in the employment data.
• length — Indicates the number of days the user has been employed in their currently active employment. Available only when start_datetime is present in the employment data.

Retrieving mortgage calculations#

Use this request to return calculated YTD values for the account with the provided account ID:

GET /v1/mortgages?account={id}

The resulting income object contains YTD objects grouped by year. The tenure object contains the employment history required for a mortgage application.

1{
2  results: [
3        {
4            "account": "470be45a-a5c7-40ec-9fb8-a6bf7306fd69",
5            "income": {
6                "ytd": {
7                    "gross": "21231.02",
8                    "bonus": "1231.12",
9                    "commissions": "12312.01",
10                    "overtime": "123.12",
11                    "currency": "USD"
12                },
13                "2022": {
14                    "gross": "21231.02",
15                    "bonus": "1231.12",
16                    "commissions": "12312.01",
17                    "overtime": "123.12",
18                    "currency": "USD"
19                },
20                "2021": {
21                    "gross": "21231.02",
22                    "bonus": "1231.12",
23                    "commissions": "12312.01",
24                    "overtime": "123.12",
25                    "currency": "USD"
26                }
27            },
28            "tenure": {
29                "twoyears": false,
30                "length": 123
31            }
32        }
33    ]
34}

If no results are found, then an empty results array is returned.