Skip to main content
Government benefits programs can use payroll records, banking reports, or a standardized government payroll report. Reuse the same Argyle user when an applicant completes more than one path.

Choose the program inputs

Payroll Data APIs

Retrieve identities, paystubs, and payroll documents for program-specific rules.

Banking

Order income, asset, or transaction reports from financial accounts applicants connect.

Government Report

Generate a payroll income report with optional applicant self-certification.

Shared workflow

  1. Create or reuse an Argyle user for the applicant and retain the ID with the case record.
  2. Start the appropriate payroll or banking connection, or order the government report.
  3. Let the applicant connect every account needed for the program determination.
  4. Track Data API readiness with account and resource webhooks. Track report-based requests with the verifications.updated webhook.
  5. Retrieve the records or completed reports required by your eligibility system.

Payroll data

For program-specific calculations, retrieve the underlying records directly:
  • Identities for employer and employment information.
  • Paystubs for earnings, deductions, taxes, and pay-period data.
  • Payroll Documents for source documents available from connected accounts.
Use the paystubs.partially_synced webhook when the program needs a defined history window. Use the users.fully_synced webhook only when the workflow must wait for all initial data from every newly connected payroll account.

Banking

Banking uses the same user but a separate verification and session. Choose the banking report type required by the program, listen for verification status changes, and retrieve the completed PDF or JSON from the verification resource.

Government report

Set report.type to voie-government when ordering the verification. Applicant self-certification is enabled by default in the standard workflow. Set report.self_certification to false when applicant review and confirmation are not required.
Applicant self-certification flow for a government payroll report.
When self-certification is enabled, the verification can enter awaiting_certification after the applicant connects the required accounts. The applicant reviews the available income information in Link before submitting it.

Exceptions and returning applicants

  • Track each payroll account separately so one incomplete connection does not hide records available from another.
  • Monitor the accounts.updated webhook for connections that require applicant action.
  • Return the existing user to Reconnect an Account rather than creating another case identity.
  • Add Document Uploads when the program accepts documents as an alternate source.
See Data Delivery and Readiness for direct payroll data, Verification Statuses for report-based requests, and the Government VOIE example for the report structure.