Integrate Symmetry I-9 into your platform in a few simple steps using the API and embeddable experiences for employees and employer administrators. The API gives you full customizability to integrate into your existing employee onboarding workflows.

Setup

Step 1: Use the API to configure employers

The main object in Symmetry I-9 is the Employer. All other elements of the API are related to an employer. An employer is a discrete business entity that your platform services (often referred to as a business or company). Use the API to manage all employers for whom you want to enable fast, compliant I-9 processing.

Key endpoints:

• Register employer
• Get employers (full list or by ID)
• Update employer information
• Delete an employer

When registering employers, you will also:

• Specify the location where you will receive completed I-9 data (postback URL)
• Specify the location where you will receive webhook events (webhook URL)

Refer to the documentation linked above for full details.

Step 2: Use the API to configure employees and administrators

Once you have configured an employer, you will add employees (new hires) and employer administrators (HR, Compliance, or other executive functions at the employer) to the employer. Employees and administrators can be added at any time. Employees must be configured before starting an I-9 for that employee.

Key endpoints:

• Employee
  • Register employee
  • Get employees (full list or by ID)
  • Delete employee
• Administrator
  • Register administrator
  • Get administrators (full list or by ID)
  • Delete administrators

When registering employees, you will also:

• Specify if an employee should not be eligible for Remote I-9 Section 2 Verification (note: this is only applicable if you have Remote I-9 enabled by default).

Step 3: Configure E-Verify using the embeddable administrator experience

The last setup step is to configure E-Verify for any employer that will be using the E-Verify program as part of the I-9 process. Using a valid administrator created in the previous step, generate a link to the embedded E-Verify configuration page and embed this into the appropriate location in your platform. Once the administrator has completed the fields on this form, E-Verify will be configured and every I-9 that is completed for this employer will automatically create an E-Verify case.

Key endpoint:

• Generate E-Verify configuration page

Start an Employee’s I-9

Once you have configured employers, employees, administrators, and (optionally) E-Verify, you are ready to initiate your first employee I-9!

Getting started is easy. When you are ready to create the employee’s I-9 experience (typically on or before the employee’s first day of work), use the API to generate a unique link to the embedded employee experience and embed this into the appropriate location in your platform. Note that we do not do any direct communication to the employee that this has happened. Notifying the employee and directing them to the I-9 experience is your platform’s responsibility.

Key endpoint:

• Generate employee access token

Using this embedded experience, the employee can complete Section 1 and, if Remote I-9 is enabled, Section 2 with no employer intervention.

Administrative Action on an I-9, including Section 2 Employer Authorization

Now that you are directing newly hired employees to the embeddable experience to complete Forms I-9, there will be cases where employer administrators will need to monitor or take action. Common examples are employers who are completing section 2, employers who are generating reports based on employee completion rates, or employers who need to intervene to resolve an E-Verify case.

Use the API to generate a unique link to the embedded administrator experience and embed this into the appropriate location in your platform. The administrator homepage is “I-9 Mission Control” and administrators can dig deeper as necessary to take the appropriate action.

Key endpoint:

• Generate administrator access token

We recommend also using Webhooks to receive real-time events for when an administrator may need to take action so that your platform can notify administrators accordingly.

Receive Completed I-9 Data

Once an employee has completed Form I-9, regardless of which section 2 verification method was used, Symmetry will return all relevant Form I-9 data as a JSON object posted to the postback URL that you configured on the relevant employer. Postback data includes a full audit log associated with that I-9 as well as an encoded PDF.

🚧

You Are Responsible for Storing Completed I-9 Metadata and Forms

You are responsible for appropriately storing completed I-9 metadata and forms based on your platform’s requirements. Symmetry does not and will not act as the source of truth for completed I-9 data.

Key data structure:

• I-9 submission object and Postback schema

Congratulations!

You have now completed a core integration with Symmetry I-9 powered by Workbright. Be sure to review the full API documentation to learn about other functionality like webhooks and submissions.