Refresh without user action
The refresh endpoint supports payroll, banking, and Doc VOI verifications. It returns a new verification ID and report.
POST /v2/verifications/refresh to create a new payroll or banking verification without the user needing to reconnect, as long as a valid connection is still available. For Doc VOI, use the same endpoint with report.type = doc-voi-mortgage to generate a new report from the user’s existing uploaded documents without uploading additional documents.
Track the new verification through verifications.updated webhooks. Retrieve its report when the status reaches completed or completed_with_errors. See Verification Statuses.
Reconnection required
If a previously completed payroll or banking verification needs updated data and the connection is no longer valid, the user must reconnect. The same path applies when the user needs to connect another account.- Order a new verification for the existing
userwithPOST /v2/verifications. - Create a session for the new verification.
- Return the user to Link for payroll or the banking connection experience to complete the required connection steps.
- Track the new verification’s status and retrieve its completed report.
If the verification is still active, create another session for that verification instead. An expired session or a request for MFA does not by itself require a new verification. See Recovery and Errors.
Doc VOI with new documents
To refresh a Doc VOI report with additional or updated documents, order a newdoc-voi-mortgage verification for the same user with POST /v2/verifications. The request shape is the same as a new document verification, including the employments requirements.
Previously uploaded documents for the user remain available as the baseline for the new verification. After the new verification is created:
- Upload each net-new document for the same
userwithPOST /v2/user-uploads. - Listen for
verifications.updatedwebhooks as the verification moves through document processing. - Retrieve the refreshed report from
report.file_urlorreport.json_urlwhen the verification is complete.