GuidesAPI ReferenceChangelog
Log In

Verify Webhook Events

verification_reports.refreshed

Verification reports for a user have been refreshed. Use end_user_id in the payload to query either GET /v1/end_users/{id}/verification_reports/voe or GET /v1/end_users/{id}/verification_reports/voie to fetch the most up-to-date verification report data.

Payload Schema

Payload ParamTypeDescription
end_user_idstringThe user identifier you specified when the user initially connected to the payroll account, if provided.
availabilityobjectSee child attributes for details.
availability.voeobjectAvailability of the Verification of Employment report. See Availability Schema below for object structure.
availability.voieobjectAvailability of the Verification of Income and Employment report. See Availability Schema below for object structure.
Availability Schema
ParameterTypeDescription
statusstringEither available, if the verification report is able to be retrieved, or unavailable, if the report is not available due to missing required data.
updated_atstringISO 8601 timestamp of when the verification report most recently had a data change (e.g., the user received a new paystub which increases their gross pay for the year).
refreshed_atstringISO 8601 timestamp of when the data underlying the verification report was most recently checked for changes.

Sample Webhook Event

{
  "event": "verification_reports.refreshed",
  "event_id": "5a141122-4235-4fa1-bd76-0628573880b0",
  "payload": {
    "end_user_id": "my_user_12345",
    "availability": {
      "voe": {"status": "available", "updated_at": "2021-01-12T02:36:01.287148+00:00", "refreshed_at": "2021-01-12T02:36:01.287148+00:00"},
      "voie": {"status": "available", "updated_at": "2021-01-12T02:36:01.287148+00:00", "refreshed_at": "2021-01-12T02:36:01.287148+00:00"}
    }
  }
}