Skip to main content
Before generating a report:
  • To ensure full data availability, we recommend subscribing to the reports.ready webhook, which is sent when sufficient data has been retrieved to generate a verification report.
  • Depending on the data retrieval speed limits of the underlying payroll platform, it can take from a few seconds up to several minutes after a new account connection before enough data has been synced to generate a complete report.
    • Visit the data availability section of our API Guide for more information on the timing of data retrieval.
After generating a report:
  • A new report object is created. Its file_url property contains a link to the PDF report, and the accounts array lists which accounts were used to generate the report.
  • The PDF report will also appear and can be downloaded within Console.
  • You can retrieve the content of a PDF report in JSON format.
Example reports:
PDFReport PDF
Image of Argyle's Verification of Employment (VOE) report.
{
  "report_id": "6c3fa756-2e76-43e1-55f6-e29fc6ae535d",
  "type": "voe",
  "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
  "external_id": "March Connection",
  "created_at": "2023-03-26T09:19:08.916Z",
  "last_synced_at": "2023-03-24T12:41:21.576Z",
  "metadata": {},
  "employments": [
    {
      "employment": "0186a27d-e5c6-735a-a359-6315b34d544c",
      "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
      "last_synced_at": "2023-03-24T12:41:21.576Z",
      "source": "Worknight",
      "first_name": "Bob",
      "last_name": "Jones",
      "full_name": "Bob Jones",
      "ssn": "522-09-1191",
      "employer": "Whole Goods",
      "employer_address": {
        "line1": "852 North W St",
        "line2": null,
        "city": "New York",
        "state": "NY",
        "postal_code": "10014",
        "country": "US"
      },
      "status": "active",
      "employment_type": "full-time",
      "job_title": "Store Manager",
      "start_date": "2020-08-28",
      "original_hire_date": "2020-08-28",
      "end_date": null,
      "length_of_work": {
        "years": "2",
        "months": "6"
      },
      "last_pay_period_end_date": "2023-03-22",
      "last_paystub_date": "2023-03-24"
    },
    {
      "employment": "0185a31d-e2c8-991c-a251-5977e36a418c",
      "account": "018728a2-2fe0-cdb4-9486-70b2fe9834f9",
      "last_synced_at": "2023-03-01T05:10:59.558Z",
      "source": "Bullseye",
      "first_name": "Bob",
      "last_name": "Jones",
      "full_name": "Bob Jones",
      "ssn": "522-09-1191",
      "employer": "Bullseye",
      "employer_address": {
        "line1": "119 Green Ridge",
        "line2": null,
        "city": "New York",
        "state": "NY",
        "postal_code": "10014",
        "country": "US"
      },
      "status": "active",
      "employment_type": "part-time",
      "job_title": "Clerk",
      "start_date": "2020-06-29",
      "original_hire_date": "2020-06-29",
      "end_date": null,
      "length_of_work": {
        "years": "2",
        "months": "9"
      },
      "last_pay_period_end_date": "2023-02-23",
      "last_paystub_date": "2023-02-24"
    }
  ]
}
PDFReport PDF
Image of Argyle's Verification of Income and Employment (VOIE) report.
{
  "report_id": "6da4c9a3-2e63-95e5-8be3-f9a52ddc489a",
  "type": "voie",
  "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
  "external_id": "March Connection",
  "created_at": "2023-03-26T09:20:06.081Z",
  "last_synced_at": "2023-03-24T12:41:25.069Z",
  "metadata": {},
  "employments": [
    {
      "employment": "0186a27d-e5c6-735a-a359-6315b34d544c",
      "account": "018728a3-afee-5288-8e8a-c68ceb591359",
      "last_synced_at": "2023-03-24T12:41:25.069Z",
      "source": "Worknight",
      "first_name": "Bob",
      "last_name": "Jones",
      "full_name": "Bob Jones",
      "birth_date": "1980-10-10",
      "ssn": "522-09-1191",
      "phone_number": "+18009000010",
      "email": "[email protected]",
      "employee_address": {
        "line1": "342 Fence Rd",
        "line2": null,
        "city": "New York",
        "state": "NY",
        "postal_code": "10014",
        "country": "US"
      },
      "employer": "Whole Goods",
      "employer_address": {
        "line1": "852 North W St",
        "line2": null,
        "city": "New York",
        "state": "NY",
        "postal_code": "10014",
        "country": "US"
      },
      "status": "active",
      "employment_type": "full-time",
      "job_title": "Store Manager",
      "base_pay": {
        "amount": "75372.62",
        "currency": "USD",
        "period": "annual"
      },
      "pay_cycle": "monthly",
      "start_date": "2020-08-28",
      "original_hire_date": "2020-08-28",
      "end_date": null,
      "length_of_work": {
        "years": "2",
        "months": "6"
      },
      "last_pay_period_end_date": "2023-03-22",
      "last_paystub_date": "2023-03-24",
      "income": [
        {
          "period": "2023",
          "currency": "USD",
          "gross_pay": {
            "total": "25124.20",
            "base": "25124.20",
            "overtime": "0.00",
            "commission": "0.00",
            "bonus": "0.00",
            "other": "0.00"
          },
          "reimbursements": "8.13",
          "deductions": "816.53",
          "taxes": "5715.75",
          "fees": "0.00",
          "net_pay": "18600.05"
        },
        {
          "period": "2022",
          "currency": "USD",
          "gross_pay": {
            "total": "82866.32",
            "base": "81653.65",
            "overtime": "0.00",
            "commission": "881.09",
            "bonus": "331.58",
            "other": "0.00"
          },
          "reimbursements": "4.35",
          "deductions": "3266.12",
          "taxes": "14948.85",
          "fees": "0.00",
          "net_pay": "64655.70"
        }
      ],
      "monthly_income:": {
        "argyle": {
          "total": "7102.33",
          "base": "6902.55",
          "overtime": "165.94",
          "bonus": "5.22",
          "commission": "28.62",
          "other": "0.00"
        }
      }
    },
    {
      "employment": "0185a31d-e2c8-991c-a251-5977e36a418c",
      "account": "018728a2-2fe0-cdb4-9486-70b2fe9834f9",
      "last_synced_at": "2023-03-01T05:10:59.558Z",
      "source": "Bullseye",
      "first_name": "Bob",
      "last_name": "Jones",
      "full_name": "Bob Jones",
      "birth_date": "1980-10-10",
      "ssn": "522-09-1191",
      "phone_number": "+18009000010",
      "email": "[email protected]",
      "employee_address": {
        "line1": "342 Fence Rd",
        "line2": null,
        "city": "New York",
        "state": "NY",
        "postal_code": "10014",
        "country": "US"
      },
      "employer": "Bullseye",
      "employer_address": {
        "line1": "119 Green Ridge",
        "line2": null,
        "city": "New York",
        "state": "NY",
        "postal_code": "10014",
        "country": "US"
      },
      "status": "active",
      "employment_type": "part-time",
      "job_title": "Clerk",
      "base_pay": {
        "amount": "61030.57",
        "currency": "USD",
        "period": "annual"
      },
      "pay_cycle": "monthly",
      "start_date": "2020-06-29",
      "original_hire_date": "2020-06-29",
      "end_date": null,
      "length_of_work": {
        "years": "2",
        "months": "9"
      },
      "last_pay_period_end_date": "2023-02-23",
      "last_paystub_date": "2023-02-24",
      "income": [
        {
          "period": "2023",
          "currency": "USD",
          "gross_pay": {
            "total": "20848.92",
            "base": "20343.52",
            "overtime": "0.00",
            "commission": "0.00",
            "bonus": "505.40",
            "other": "0.00"
          },
          "reimbursements": "0.00",
          "deductions": "915.48",
          "taxes": "4475.58",
          "fees": "0.00",
          "net_pay": "15457.86"
        },
        {
          "period": "2022",
          "currency": "USD",
          "gross_pay": {
            "total": "68070.08",
            "base": "66116.44",
            "overtime": "0.00",
            "commission": "777.54",
            "bonus": "1176.10",
            "other": "0.00"
          },
          "reimbursements": "18.40",
          "deductions": "2034.40",
          "taxes": "13274.18",
          "fees": "0.00",
          "net_pay": "52779.90"
        }
      ],
      "monthly_income": {
        "argyle": {
          "total": "5683.51",
          "base": "5512.92",
          "overtime": "0.00",
          "bonus": "119.51",
          "commission": "51.08",
          "other": "0.00"
        }
      }
    }
  ],
  "income_totals": [
    {
      "period": "2023",
      "currency": "USD",
      "gross_pay": {
        "total": "45973.12",
        "base": "45467.72",
        "overtime": "0.00",
        "commission": "0.00",
        "bonus": "505.40",
        "other": "0.00"
      },
      "reimbursements": "8.13",
      "deductions": "1732.01",
      "taxes": "10191.33",
      "fees": "0.00",
      "net_pay": "34057.91"
    },
    {
      "period": "2022",
      "currency": "USD",
      "gross_pay": {
        "total": "150936.4",
        "base": "147770.09",
        "overtime": "0.00",
        "commission": "1658.63",
        "bonus": "1507.68",
        "other": "0.00"
      },
      "reimbursements": "22.75",
      "deductions": "5300.52",
      "taxes": "28223.03",
      "fees": "0.00",
      "net_pay": "117435.60"
    }
  ]
}

​
The report object

​
id
string<uuid>

Unique ID of the report object.

Also the "Reference #" on the report PDF.

​
user
string<uuid>

ID of the user associated with the report.

​
reference_id
string<uuid>
deprecated

Report PDF identifier.

​
generated_at
string<date-time>
deprecated

Timestamp (ISO 8601) when the report was requested.

​
created_at
string<date-time>

Timestamp (ISO 8601) when the report was requested.

​
type
enum<string>

The type of report.

  • voie - Verification of Income and Employment
  • voe - Verification of Employment
  • voie-mortgage - Verification of Income and Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)
  • voe-mortgage - Verification of Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)
Available options:
voe,
voie,
voe-mortgage,
voie-mortgage
​
status
enum<string>

Progress of report generation.

  • waiting_for_sync: Data from the connected payroll account is still being retrieved.
  • generating: The report is being generated.
  • generated: The report is ready to download.
  • failed: A system error occurred, preventing report generation.
Available options:
waiting_for_sync,
generating,
generated,
failed
​
file_url
string

Download link to the report PDF.

This static URL redirects to a download page that requires Argyle authentication headers. See the dropdown below for more information.

Implementation requirements for client-side applications:

​
json_url
string

Download link to the report in JSON.

This static URL redirects to a download page that requires Argyle authentication headers. See the dropdown below for more information.

​
last_synced_at
string<date-time>

Timestamp (ISO 8601) when the account used to generate the report was last scanned for new data before the report was generated. If multiple accounts were used, the more recent timestamp.

Used to populate the "Data as of" date on the report PDF.

​
accounts
object[]

The accounts used to generate the report.

​
metadata
object

Any metadata for internal use added when generating the report.

​
external_id
string

The external_id of the user, otherwise null.