> ## Documentation Index
> Fetch the complete documentation index at: https://docs.symmetry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman collection and environment for I-9 API

> Download the Symmetry I-9 Postman collection and environment directly from the API, set your credentials, and send sample requests to every I-9 endpoint.

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.                                       |

<Card title="Postman endpoints in Swagger" icon="paper-plane" href="https://api.symmetry.com/i9/docs#/Postman">
  Jump to the Postman section of the Swagger UI to execute both endpoints and save each response.
</Card>

<Info>
  **Both endpoints require authorization**

  Authorize with an access token returned from the `/authentication` endpoint, not your API key. See [Symmetry I-9 API overview](/i9/api-reference/overview) for how to request one.
</Info>

## Import into Postman

<Steps>
  <Step title="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.
  </Step>

  <Step title="Import both files into Postman">
    In Postman, select **Import**, then add the collection file and the environment file you downloaded.
  </Step>

  <Step title="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.
  </Step>
</Steps>

## 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](https://support.symmetry.com). |
| `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.