Skip to main content
The Symmetry I-9 API manages employers, employees, form submissions, and E-Verify cases for Form I-9 completion. The endpoint reference in this section is generated from the I-9 OpenAPI specification.

Environments and base URLs

Always develop and test against the staging environment before pointing your integration at production.

Authentication

Make a request to the /authentication endpoint using your API key. This returns a valid access token, which you then send on every other request.
Access token versus API keyYour access token is not the same as your API key. The API key is used for initial authentication to obtain an access token from the /authentication endpoint. The access token is then used to authorize and interact with the other I-9 API endpoints securely.

Try it live with Swagger

For interactive, authenticated calls against the running service, use the hosted Swagger UI. It mirrors the endpoints in the API reference and lets you execute real requests.

Production Swagger

Live API explorer for every I-9 endpoint.

Step 1: Generate an access token

Make a request to the /authentication endpoint using your API key. This returns a valid access token.

Step 2: Authorize in Swagger

  • Select the Authorize button on the right side of the Swagger UI.
  • Paste your access token into the dialog box.
  • Select Authorize.
Once authorized, an unlocked icon appears next to each endpoint, indicating that you can now send requests.

Step 3: Try out endpoints

  • Select an endpoint.
  • Select Try it out.
  • Select Execute.
Swagger displays the API’s response.

Next steps

Postman

Download the I-9 Postman collection and environment directly from the API.

Endpoints

Full reference for every employer, employee, admin, and E-Verify endpoint.