Postman collection and environment for I-9 API

A Postman collection has been established to make testing the Symmetry I-9 API endpoints simple and intuitive. Symmetry serves the Postman files from the API itself rather than as static downloads, so the collection always reflects the current endpoints.

Download from Swagger

Both files come from the Postman endpoints, and both require authorization.

Endpoint	What it returns
`GET /postman/collection`	Sample requests for all employer, employee, account, administrator, and E-Verify endpoints.
`GET /postman/environment`	The environment variables used across those requests.

Postman endpoints in Swagger

Jump to the Postman section of the Swagger UI to execute both endpoints and save each response.

Both endpoints require authorizationAuthorize with an access token returned from the /authentication endpoint, not your API key. See Symmetry I-9 API overview for how to request one.

Import into Postman

Authorize in Swagger and download both files

Authorize in the Swagger UI, then execute GET /postman/collection and GET /postman/environment and save each response as a file.

Import both files into Postman

In Postman, select Import, then add the collection file and the environment file you downloaded.

Select the environment and set your credentials

Activate the Symmetry I-9 environment, then supply your own apiKey and point apiDomain at the environment you’re testing against.

Environment variables

Variable	Value
`apiKey`	Provided by Symmetry’s Client Success team. If you are unsure of your company’s `apiKey`, reach out to Client Success within the Client Support Center.
`apiDomain`	The base domain for your target environment: `https://api.symmetry.com` for production, `https://api-staging.symmetry.com` for staging.
`accessToken` *	Provided in the response from the `/authentication/login` endpoint.
`employerId`	The unique identifier of the employer.
`employeeId`	The unique identifier of the employee.
`adminId`	The unique identifier of the company administrator.
`submissionId`	The unique identifier of the employee’s I-9 submission. Retrieved from the `/employers/{employerId}/employees/{employeeId}/submissions` GET endpoint.
`everifyId`	The unique identifier of the E-Verify case.
`apiVersion`	Endpoint version. Symmetry I-9 is currently on `v1`.

* Set automatically in Postman. The authentication request includes a script that writes the returned token into the active environment.

​Download from Swagger

Postman endpoints in Swagger

​Import into Postman

​Environment variables

Download from Swagger

Import into Postman

Environment variables