Skip to main content
Mitratech Success Center
Client Support Center

Need help? Click a product group below to select your application and get access to knowledge articles, webinars, training content, and release notes or to contact our support team.

Authorized users - log in to create a ticket, view tickets status and check your success plan details.

 

Tracker I-9 Event Management Integration Guide 07-2026

Feature Summary

When a qualifying event occurs in the Tracker system (see Event Type definitions below), the Tracker system initiates a POST API call to a customer defined endpoint and delivers a predefined JSON payload.  

Each POST call is made on a transactional basis immediately after the event occurs in the Tracker system. For example, when Section 1 of a Form I-9 is initially signed in the Tracker system, the POST API call is invoked for this event.   

Some events are I-9 Record type dependent (see Appendix A: Event Type Id Definitions for more details). For example, there is a specific Event Type that is triggered when a new Historical I-9 record type is created in the UI or Data Import process (Event Type Id 104). Most Events trigger for New I-9 records (I-9s initially created in Tracker). Many Events trigger for Historical I-9 records (I-9s initially created outside of Tracker, converted, and migrated into the Tracker system has Historical I-9 records). Event data is sent for I-9 Resolve records less frequently. 

Each Event Type has an Event Type Id. The Event Type Id provides context to the end user for which event occurred. Which payload attributes are meaningful to the end user may depend upon if and how the event data will be consumed. 

Customer Endpoint Requirements

To receive Event data, customers must provide the following information: 

  1. The customer defined url where the Tracker I-9 system should POST the Event payload 
  2. The API Write Method. Indicate whether you expect to receive a POST or PATCH API call. 
  3. The Authentication Requirements for the customer defined url. Today, the Tracker I-9 system supports the following authentication methods: 
    1. OAuth 2.0 
    2. Basic Authentication (Username/Password) 
  4. Event Management Failure Notifications: Email address(es) where we should send event failure notifications to. 

HTTPS Status Codes and Retry Functionality

The Tracker I-9 Event Management platform handles standard HTTP status codes returned by the client endpoint in the following manner: 

HTTP Status 

Description 

Automated Retry 

200 OK 

The client defined endpoint successfully received the payload 

N/A 

No Response 

The client endpoint is non-response 

Yes 

503 Service Unavailable 

The client endpoint is not able to process the payload 

Yes 

400 Bad Request 

The event was received, but the payload failed to process due to an unexpected formatting or syntax error 

No 

401 Unauthorized 

The client endpoint url or authentication credentials are incorrect 

No 

Tracker I-9's Automated Retry functionality attempts to resend the Event payload to the client endpoint automatically until a 200 OK response is received, or - after multiple attempts - the delivery continues to fail. All failed Event payloads are queued in the messaging service and can be resent again after any issues are resolved.  

400 and 401 errors are not retried and will be troubleshooted by the Mitratech Support and Hosting team and may require assistance from the customer’s technical resources to resolve.  

Logging

The Tracker system logs each event payload and other event metadata per Mitratech's integration logging best practices. The Mitratech Support and/or Hosting team will have access to Event Management logging for support and troubleshooting purposes only. 

Event Payload Delivery Times

The Tracker system sends Event data as soon as they are triggered. Event data payloads traverse across several components our messaging platform, including logic applications, message filtering and data transformation, message queue and bussing (for retries), and logging. As such, Event payloads do not always reach the intended endpoint in real-time. Typically, payloads arrive in near real-time. However, intermittent network latency can sometimes lead to longer than usual delivery times.  

Event Type Definitions

Event Types are organized into logical categories. See Appendix A: Event Type ID Definitions for details. Customers will receive all events. If you do not wish to receive all events then please work with your Tracker I-9 Implementation Manager so that the integration can be set up per your requirements. Please note that new events can be added at any time as part of a scheduled release. Please make sure that you account for this in your design as we would not want any newly added events to negatively impact your event management integration.  

Payload Attributes 

Each payload sent from the Tracker system will include the same set of Metadata/Employee Profile/Form I-9/E-Verify data for each Event Type. Any data syntax or transformation must be performed by the system receiving the payload. The dataset is standardized. Consumers are asked to ignore data in the data set that the user deems unessential. New attributes can be added to the payload at any time as part of a scheduled release. Please make sure that you account for this in your design as we would not want any newly added attributes to negatively impact on your event management integration. See Appendix B: Event Payload Data Definitions for more information. 

Using Attributes

Partners and Clients use attributes from the Event Management posts to update data in the client’s external system, for example a HR Information System (HRIS) or Applicant Tracking System (ATS). Event Management users typically populate or pull back attributes when creating Employees and I-9s in Tracker using the Tracker API or when populating data using Tracker’s file upload integration. Tracker recommends using the following attributes to update data on the client’s system. ExternalId and IntegrationId are most commonly used by partners/clients. However, ExternalId and IntegrationId are optional attributes that can be defined via the API or file upload integration. I9ID is also a valid option when partners/clients choose not to define ExternalId or. IntegrationId. 

  1. ExternalId – ExternalId is typically associated with an employee ID on a partner/client’s external system (e.g. HRIS). The ExternalId is held at the employee profile level and must be unique. 
  2. IntegrationId – IntegrationId is another employee profile level unique value and is often associated with a Candidate ID on a client’s Applicant Tracking System (ATS).  Clients who have ATS functionality in their HRIS often set the new hire’s employee ID to both the ExternalId and IntegrationId which exposes the employee ID on the employee profile and allows clients to use the duplicate/re-hire logic of the Tracker API. 
  3. I9ID – I9ID is a unique integer value Tracker assigns to each I-9 at the I-9 level. A Tracker employee profile can have multiple I-9s especially in the case of hires and re-hires and the I9ID defines information at the I-9 level. Clients can capture the I9ID by creating an I-9 using the Tracker API and storing the value from the API response. 
  4. UserID – UserID is a unique integer value Tracker assigns to each Employee profile and works similarly to ExternalId and IntegrationId. Clients can capture the UserID by creating an I-9 using the Tracker API and storing the value from the API response. UserID can be used by clients who don’t have an employee ID or candidate ID in their HRIS or ATS. 

If clients populate ExternalId and IntegrationId with different values, re-hire I-9s require additional API calls. Your Tracker Implementation Project Manager can guide you in using the API if ExternalId and IntegrationId are populated with different values. 

Appendix A: Event Type Id Definitions

Event Type Id

Event Type Category 

Event Description 

Applies to Record Type

101 

Form I-9 Change 

Section 1 is signed or amended 

Section 1 Signed: New I-9s; Section 1 Amended: New I-9s, Historical I-9s 

102 

Form I-9 Change 

Section 2 is signed or amended 

Section 2 Signed: New I-9s; Section 2 Amended: New I-9s, Historical I-9s 

103 

Form I-9 Change 

New Supplement B is signed or amended 

All New Supplement Bs for New I-9s, Historical I-9s, Resolve I-9s 

104 

Form I-9 Change 

An I-9 is created, regardless of I-9 record type or creation method. 

New I-9s, Historical I-9s, Resolve I-9s 

105 

Form I-9 Change 

The Reverification Due Date field is updated on a Historical or Resolve I-9 record Tracker UI Summary Tab 

Historical I-9s, Resolve I-9s 

106 

Form I-9 Change 

The Remote Employer Representative Information is entered or edited 

New I-9s 

107 

Form I-9 Change 

The Remote Employer Representative declines the Remote Section 2 request 

New I-9s 

108 

Form I-9 Change 

The Section 2 Start Date changes for a Remote Form I-9 

New I-9s 

109 

Form I-9 Change 

The I-9 Workflow changes (e.g. “Remote Section 1 & 2” changes to “Network Alliance”) 

New I-9s 

110 

Form I-9 Change 

A Remote Section 1 Amendment request is initiated 

New I-9s 

111 

Form I-9 Change 

A Remote Section 1 Amendment request is cancelled or expires 

New I-9s 

112 

Form I-9 Change 

A user invokes the “Next Action Refresh” feature, which recalculates and syncs the I-9/E-Verify status to the correct status 

New I-9s, Historical I-9s, Resolve I-9s 

113 

Form I-9 Change 

A user approves/rejects an I-9 where Section 2 was complete by an Authorized Representative 

New I-9s 

114 

Form I-9 Change 

A user approves/rejects an I-9 where Supplement B was completed by an Authorized Representative 

New I-9s, Historical I-9s, Resolve I-9s 

115 

Form I-9 Change 

A Remote Section 2 Amendment request is initiated 

New I-9s 

116 

Form I-9 Change 

A Remote Section 2 Amendment request is cancelled or expires 

New I-9s 

117 

Form I-9 Change 

The I-9 Pro Appointment is scheduled, or the appointment status is changed 

New I-9s 

301 

E-Verify Change 

An E-Verify case is created or updated, or the Tracker system checks the E-Verify system for an update on an existing E-Verify case 

New I-9s, Historical I-9s, Resolve I-9s 

302 

E-Verify Change 

An I-9 Manager changes the E-Verify Options (on/off) radio button value on the Form I-9 Summary Tab 

New I-9s, Historical I-9s, Resolve I-9s 

401 

Employee Profile Change 

A change to the Employee Profile input fields is saved (First Name, Middle Name, Last Name, Other Last Name, SSN, DOB, Employee Email Address, Employee ID (External), Employer, Worksite, and/or I-9 Manager) 

All Employee Profiles 

402 

Employee Profile Puge/Delete 

The Employee Profile is deleted via the UI, Form I-9 Purge Report, or Empty Profile Deletion Report 

All Employee Profiles 

501 

Form I-9 Purge/Delete 

The Form I-9 Termination Date change via the UI 

New I-9s, Historical I-9s, Resolve I-9s 

502 

Form I-9 Purge/Delete 

The Form I-9 is deleted via the UI 

New I-9s, Historical I-9s, Resolve I-9s 

503 

Form I-9 Purge/Delete 

A New Supplement B is deleted via the UI 

All New Supplement Bs for New I-9s, Historical I-9s, Resolve I-9s 

504 

Form I-9 Purge/Delete 

A purge eligible Form I-9 is purged from Tracker 

New I-9s, Historical I-9s, Resolve I-9s 

Appendix B: Event Payload Data Definitions 

The first data set that appears in the JSON payload (see Appendix C) pertains to the Employee Profile associated with the Form I-9/E-Verify case that changed. 

Next, the second data set pertains to the Form I-9 Section 1 and Section 2 data, and E-Verify data (if present), associated with the Event that triggered the sending of the payload. 

Finally, if any Supplement B data associated to the Form I-9 appears. 

The definitions below mirror the definitions found in the Tracker API Integration Guide for I-9 Complete. 

Record

Argument 

Format 

Notes 

N/A 

EventTypeId 

integer 

See EventTypeID Descriptions (Appendix A) 

N/A 

EventDateTime 

Date/time 

Event Date/time stamp. Format YYYY-MM-DDTHH:MM:SS 

Employee Profile 

Id 

integer 

Tracker Internal Employee Profile ID 

Employee Profile 

FirstName 

string (50) 

Employee’s first name on Employee Profile. 

Employee Profile 

LastName 

string (50) 

Employee’s last name on Employee Profile. 

Employee Profile 

MiddleName 

string (50) 

Employee’s middle name on Employee Profile. 

Employee Profile 

OtherName 

string (50) 

Employee’s other legal name on Employee Profile. 

Employee Profile 

Email 

string (100) 

Employee’s email address on the Employee Profile. 

Employee Profile 

ExternalId 

string (100) 

Identifier set by client to identify an employee.  Must be unique. Appears on Employee Profile UI as “Employee ID” 

Employee Profile 

IntegrationId 

string (255) 

Additional employee profile ID set by client. Required for Duplicate/Rehire check. 

Employee Profile 

ClientName 

string (255) 

Name of the Client that the employee is associated with. 

Employee Profile 

ClientId 

integer 

Identifier set by the Tracker system to identify a client. 

Employee Profile 

ExternalClientId 

string (255) 

Identifier set by Tracker or a Distributor to identify a client. 

Employee Profile 

EmployerName 

string (255) 

Name of the Employer that the employee is associated with. 

Employee Profile 

EmployerId 

integer 

Identifier set by the Tracker system to identify an employer. Found at the end of the URL when selecting an employer in the Client Admin employer setup page.  

Employee Profile 

ExternalEmployerId

string (50) 

Identifier set by client to identify an employer.  

Employee Profile 

WorkSiteId 

integer 

Identifier set by the Tracker system to identify a worksite. Found at the end of the URL when selecting a worksite in the Client Admin worksite setup page.  

Employee Profile 

ExternalWorksiteId 

string (50) 

Identifier set by client to identify a worksite.  

Employee Profile 

UserId 

integer 

Identifier assigned by the Tracker system to record the I-9 Manager whose action in the application triggered the event.  

Employee Profile 

ExternalUserId 

string (255) 

Identifier assigned by the Client to record the I-9 Manager whose action in the application triggered the event. 

Form I-9 

NextActionLink 

url 

The link to the Form I-9 page in the Tracker Application that corresponds to Next Action. For example, when the Next Action = Complete Section 2, the NextActionLink will navigate to the Section 2 page in the Tracker Application. See Appendix H in the Tracker API Integration Guide for a list of Next Action strings and Next Action IDs. When the Next Action = None, the NextActionLink navigates the user to the Form I-9 Summary tab. 

The Next Action Link url construction will follow this design: 

/employee/navtonextaction/[Tracker Internal Employee ID]?i9Id=[Tracker Internal I9 ID] 

NOTES: 

  • The Next Action Link value will be empty for EventTypeID 401 (Employee Profile Change) since this event is triggered by a change to the Employee Profile and not a Form I-9. 

The Next Action Link value will be Null when Form I-9 is deleted as a result of the EventTypeID that was triggered. EventTypeIDs 502 and 504 delete the Form I-9. 

Employee Profile 

EmployeeProfileLink 

url 

The link to the Employee Profile page in the Tracker Application. 

Employee Profile url construction will follow this design: 

/employee/profile/[Tracker Internal Employee ID] 

Form I-9 

Id 

integer  

Tracker Internal Form I-9 ID 

Section 1 

FirstName 

string (50) 

Employee’s first name on Section 1 of the Form I-9 

Section 1 

LastName 

string (50) 

Employee’s last name on Section 1 of the Form I-9 

Section 1 

MiddleInitial 

string (50) 

Employee’s middle name on Section 1 of the Form I-9 

Section 1 

OtherNames 

string (50) 

Employee’s other legal name on Section 1 of the Form I-9 

Section 1 

Street 

string (255) 

Employee’s street address 

Section 1 

AptNumber 

string (100) 

Employee’s apartment number 

Section 1 

City 

string (100) 

Employee’s City of residence 

Section 1 

State 

string (25) 

Employee’s State of residence 

Section 1 

Zip 

string (5) 

Employee’s zip code 

Section 1 

Email 

string (100) 

Employee’s email address 

Section 1 

EmploymentStatus 

integer 

The Citizenship Status selected in Section 1 of the Form I-9. 

 

1 = Citizen of the United States  

2 = Lawful Permanent Resident  

3 = Alien Authorized to Work  

4 = Noncitizen National of the US  

null = Undefined 

There are two use cases for when Section 1 Citizenship Status is undefined: 

  1. The field value is undefined for a Historical or I-9 Resolve record 
  2. The field value is undefined for a new Form I-9 when Section 1 is not complete 

Form I-9 

NextActionId 

integer 

The Tracker Next Action ID. See Appendix H in the Tracker API Integration Guide 

Form I-9 

NextAction 

string 

The Tracker Next Action ID. See Appendix H in the Tracker API Integration Guide 

Form I-9 

NextActionDueDate  

date/time 

The date of the Next Action is due. Format YYYY-MM-DDTHH:MM:SS 

Form I-9 

RemoteAccessType 

integer 

See Appendix I in the Tracker API Integration Guide 

Section 2 

StartDate 

date 

Section 2 Start Date. Format “YYYY-MM-DD” 

Section 2 

ExternalUserId 

string 

When Section 2 is signed by an I-9 Manager, the Identifier is set by the client to identify the I-9 Manager. 

Section 2 

Username 

string 

When Section 2 is signed by an I-9 Manager, the username of the I-9 Manager. 

Section 2 

UserId 

integer 

When Section 2 is signed by an I-9 Manager, the Identifier set by the Tracker system to identify the I-9 Manager. 

Section 2 

S2SignatureFirstName 

string 

The First Name of the Section 2 signatory. 

Section 2 

S2SignatureLastName 

string 

The Last Name of the Section 2 signatory. 

Section 2 

S2SignatureType 

integer 

1 = Electronic Signature  

2 = Paper Signature 

null = Undefined 

There are two use cases for when Section 2 signature is undefined: 

  1. The field value is undefined for a Historical or I-9 Resolve record 
  2. The field value is undefined for a new Form I-9 when Section 2 is not complete 

Form I-9 

IsTerminated  

boolean 

Termination Flag for the Form I-9 

Form I-9 

TerminationDate 

date 

Termination Date for the Form I-9. Format “YYYY-MM-DD” 

E-Verify 

EVerifyCaseStateId  

integer 

Tracker E-Verify Case State ID for the most recent E-Verify case associated with the Form I-9. See Appendix G in the Tracker API Integration Guide 

E-Verify 

EVerifyCaseStateString 

string 

Tracker E-Verify Case State String value for the most recent E-Verify case associated to the Form I-9. See Appendix G in the Tracker API Integration Guide 

E-Verify 

EVerifyCaseNumber 

string 

The E-Verify Case Number for the most recent E-Verify case associated with the Form I-9 

E-Verify 

EVerifyClosureCode 

string 

The E-Verify Case Closure Code for the most recent E-Verify case associated with the Form I-9. See Appendix L in the Tracker API Integration Guide. 

Section 1 

RemoteSection1AmendmentStatusID 

integer 

The Remote Section 1 Amendment Status ID for the most recent Remote Section 1 Amendment Status request (will be null when there are no Remote Section 1 Amendment requests for the I-9) 

1 = Pending 
2 = Expired 
3 = Cancelled 
4 = Completed 

Section 1 

RemoteSection1AmendmentStatus 

string 

The Remote Section 1 Amendment Status string for the most recent Remote Section 1 Amendment Status request (will be null when there are no Remote Section 1 Amendment requests for the I-9) 

Section 1 

RemoteSection1AmendmentInstructionalText 

string 

The text value entered in the Remote Section 1 Amendment Instructions to employee text box for the most recent Remote Section 1 Amendment Status request (will be null when there are no Remote Section 1 Amendment requests for the I-9) 

Section 1 

RemoteSection1AmendmentLink 

url 

The url to the Remote Section 1 amendment page for the most recent Remote Section 1 Amendment Status request (will be null when there are no Remote Section 1 Amendment requests for the I-9) 

Section 1 

RemoteSection1Link 

url 

The url to the Remote Section 1 page (will be null when Record Access Type is not 2800, 2801, 2808, 2810 or 2811) 

Section 2 

RemoteAccessSect2Link 

url 

The url to the Remote Section 2 page (will be null when Remote Access Type is not 2801, 2808, 2810 or 2811) 

Section 2 

RemoteSection2AmendmentLink 

url 

The url to the Remote Section 2 amendment page for the most recent Remote Section 2 Amendment Status request (will be null when there are no Remote Section 2 Amendment requests for the I-9) 

Section 2 

RemoteSect2AmendmentStatusId 

integer 

The Remote Section 2 Amendment Status ID for the most recent Remote Section 2 Amendment Status request (will be null when there are no Remote Section 2 Amendment requests for the I-9) 

1 = Pending 
2 = Expired 
3 = Cancelled 
4 = Completed 

Section 2 

RemoteSect2AmendmentStatus 

 

string 

The Remote Section 2 Amendment Status string for the most recent Remote Section 2 Amendment Status request (will be null when there are no Remote Section 2 Amendment requests for the I-9) 

Section 2 

RemoteSect2AmendmentText 

string 

The text value entered in the Remote Section 2 Amendment Instructions to employer representative text box for the most recent Remote Section 2 Amendment Status request (will be null when there are no Remote Section 2 Amendment requests for the I-9) 

Form I-9 

CalendarId 

integer 

A unique ID representing the I-9 Pro appointment 

Form I-9 

AppointmentDateTimeStaff 

string 

Date and Time of the I-9 Pro appointment. 

Ex., Monday, Oct 28, 2024, at 10:05 AM EDT 

Form I-9 

StaffFullName 

string 

Full name of the Mitratech resource assigned to the I-9 Pro appointment. 

Form I-9 

StaffEmail 

string 

Email address of the Mitratech resource assigned to the I-9 Pro appointment. 

Form I-9 

Status 

string 

I-9 Pro appointment status (OPEN, COMPLETED, NO_SHOW, CANCELLED) 

Form I-9 

Substatus 

string 

I-9 Pro appointment substatus (OPEN, IN PROGRESS, CONFIRMED, CHECKEDIN, NO_SHOW, CREDIT, COMPLETED, ABUSE, CANCELLED) 

Form I-9 

TransactionID 

string 

A unique ID for Event Payload 

Form I-9 

Environment 

string 

Instance of the Tracker application that originated the event 

Supplement B 

LastName 

string (50) 

Supplement B Employee’s New Last Name 

Supplement B 

FirstName 

string (50) 

Supplement B Employee’s New First Name 

Supplement B 

MiddleInitial 

string (50) 

Supplement B Employee’s New Middle Initial 

Supplement B 

RehireDate 

date 

Supplement B Employee’s Rehire Date. Format “YYYY-MM-DD” 

Appendix C: Sample Payload 

The example below provides a sample JSON payload associated with an event. 

{ 

"EventTypeId": 103, 
  "EventDateTime": "2024-04-16T16:24:18", 
  "Id": 54032, 
  "FirstName": "chandanqqqwe", 
  "LastName": "chandanqqqwe", 
  "MiddleName": null, 
  "OtherName": null, 
  "Email": null, 
  "ExternalId": null, 
  "IntegrationId": null, 
  "ClientName": "COE test1", 
  "ClientId": 3272, 
  "ExternalClientId": "12121", 
  "EmployerName": "COE test employer1 EV ON", 
  "EmployerId": 200003386, 
  "ExternalEmployerId": "test", 
  "WorkSiteId": 400126609, 
  "ExternalWorksiteId": "ewidev26", 
  "UserId": 4024, 
  "ExternalUserId": "fwe93i", 
  "NextActionLink": "https://sb01-dev.i9complete.com/employee/navtonextaction/54032?i9Id=55376", 
  "EmployeeProfileLink": "https://sb01-dev.i9complete.com/employee/profile/54032", 
  "I9": { 
    "Id": 55376, 
    "FirstName": "chandanqqqwe", 
    "LastName": "chandanqqqwe", 
    "MiddleInitial": "N/A", 
    "OtherNames": "N/A", 
    "Street": "asdfaf", 
    "AptNumber": "asfasd", 
    "City": "asda", 
    "State": "Alabama", 
    "Zip": "23232", 
    "Email": "N/A", 
    "EmploymentStatus": 3, 
    "NextActionId": 4, 
    "NextAction": "Reverification Due", 
    "NextActionDueDate": "2024-11-03T00:00:00", 
    "RemoteAccessType": 0, 
    "StartDate": "2023-03-31T00:00:00", 
    "ExternalUserId": "twet235256", 
    "Username": "coe_karina_advev", 
    "UserId": 3942, 
    "S2SignatureFirstName": "COE", 
    "S2SignatureLastName": "user", 
    "S2SignatureType": 1, 
    "IsTerminated": false, 
    "TerminationDate": null, 
    "EVerifyCaseStateId": 28, 
    "EVerifyCaseStateString": "Case Closed", 
    "EverifyCaseNumber": "2023061111847DJ", 
    "EverifyClosureCode": "EA_AUTO_CLOSE", 
    "Section3": { 
      "LastName": "N/A", 
      "FirstName": "N/A", 
      "MiddleInitial": "N/A", 
      "RehireDate": null 
    }, 
    "RemoteSection1AmendmentStatusID": null, 
    "RemoteSection1AmendmentStatus": null, 
    "RemoteSection1AmendmentInstructionalText": null, 
    "RemoteSection1AmendmentLink": null, 
    "RemoteSection1Link": null, 
    "RemoteAccessSect2Link": null, 
    "RemoteSection2AmendmentLink": null, 
    "RemoteSect2AmendmentStatusId": null, 
    "RemoteSect2AmendmentStatus": null, 
    "RemoteSect2AmendmentText": null, 

    "CalendarId": null, 
    "AppointmentDateTimeStaff": null, 

       "StaffFullName": null, 
    "StaffEmail": null, 
    "Status": null, 
    "SubStatus": null 

  }, 
  "TransactionID": "22630d9b-33da-426c-b33d-757d5e3480d2", 
  "ClientPartner": "Basic", 
  "Environment": "DEV-SB01", 
  "EventManagementId": 2532 
} 

Revision History  

 Author  

Version  

Date  

Notes 

Brian Fancher  

V 1.0  

2019-04-04  

Initial Version 

Brian Fancher 

V 1.1 

2019-04-17 

  • Removed Remote Access Amendment EventType IDs and payload parameters.  
  • Removed DOB and SSN parameters. 
  • Other minor changes.  

Brian Fancher 

V 1.1 

2019-04-26 

  • Removed EventTypeID 110 (Remote Form I-9 Rejected) because it was duplicate. Rejected remote I-9s are deleted, which is covered by EventTypeID 502 
  • Added Employee Profile link parameter to payload. 
  • Clarified that only the most recent Section 3 data (if any) will be included in the payload 
  • Clarified that only the most recent E-Verify case data (if any) will be included in the payload. 
  • Added column to EventTypeID table that identifies the Form I-9 Records types that are considered for the specific event. 

Brian Fancher 

V 1.1 

2019-04-30 

Payload Data Definition Changes 

  • Changed EventID to EventTypeID 
  • Changed payload parameter AptNum to AptNumber 
  • Added EVerifyCaseNumber 
  • Added EVerifyClosureCode 

Example JSON Updates 

  • Moved ClientID and ExternalClientID down in the payload  
  • Updated AptNum to AptNumber 
  • Added EVerifyCaseNumber 
  • Added EVerifyClosureCode 

Brian Fancher 

V 1.2 

2019-05-28 

Added the following attributes to the push event payload 

  • Section 1 Citizenship Status 
  • Section 2 Signatory External User ID 
  • Section 2 Signatory Username 
  • Section 2 Signatory Tracker User ID 
  • Section 2 Signatory First Name 
  • Section 2 Signatory Last Name 
  • Section 2 Signature Type 

Brian Fancher 

V 1.3 

2019-06-24 

Added the following EventTypeIDs 

  • 110 Remote Section 1 Amendment Initiated 
  • 111 Remote Section 1 Amendment cancelled or expired 

Added the following attributes to the push event payload 

  • Remote Section 1 Link 
  • Remote Section 1 Amendment Status ID 
  • Remote Section 1 Amendment Status string 
  • Remote Section 1 Amendment Instructional Text string 
  • Remote Section 1 Amendment Link 

Brian Fancher 

V 1.4 

2019-09-27 

Added the following attribute to the push event payload 

  • TransactionID  

Brian Fancher 

V 1.5 

2022-05-11 

Added a new Event Type ID  

  • Event Type ID 112 will be sent whenever the user invokes the “Next Action Refresh” feature, which recalculates and syncs the I-9/E-Verify status to the correct status 

Added Client Endpoint Requirements section 

Added Retry section 

Brian Fancher 

V 1.6 

2022-08-11 

Removed reference to SAML 2.0 authentication support. SAML 2.0 is no longer supported.  

Paul McKenna 

V 1.7 

2024-02-14 

Added the following EventTypeIDs 

  • 113 Remote Section 2 approved/rejected 
  • 114 Remote Section 3 approved/rejected 
  • 115 Remote Section 2 Amendment initiated 
  • 116 Remote Section 2 Amendment cancelled or expired 

Added the following attributes to the push event payload 

  • Remote Section 2 Link 
  • Remote Section 2 Amendment Link 
  • Remote Section 2 Amendment Status ID 
  • Remote Section 2 Amendment Status string 
  • Remote Section 2 Amendment Instructional Text string 

Paul McKenna 

V 1.8 

2024-04-29 

  • Changed the Event Description associated with Event Type ID 104.  
  • Added the following arguments to the push event payload: 
  • ClientName 
  • Email (Employee’s email address from the Employee Profile record) 
  • EmployerName (Employer Name from the Employee Profile record) 
  • Email (Employee’s email address from Section 1) 

Paul McKenna 

V 1.9 

2024-11-07 

Added the following EventTypeID: 

  • 117: The I-9 Pro Appointment is scheduled, or the appointment status is changed 

Added the following attributes to the push event payload: 

  • CalendarId 
  • AppointmentDateTimeStaff 
  • Status 
  • SubStatus 

Paul McKenna 

V 1.10 

2025-01-13 

Added the following attributes to the push event payload: 

  • StaffFullName 
  • StaffEmail 

Paul McKenna 

V 1.10 

2025-09-08 

Added the following EventTypeID: 

  • 402: The Employee Profile is deleted via the UI, Form I-9 Purge Report, or Empty Profile Deletion Report 

Updated the Notes field associated with the following arguments: 

  • UserId 
  • ExternalUserId 

Paul McKenna 

V 1.11 

July 2026 

Replaced Section 3 terminology with Supplement B to align with upcoming 113_2026 release scheduled for end of August. 

  • Was this article helpful?