Start Employee's I-9
Generate employee's embedded I-9 experience
Once you've registered your employer, employee, and administrator(s), and (optionally) configured E-Verify, you are ready to initiate the employee's Form I-9! You will use the API to generate a unique link to the embedded employee experience into the appropriate location in your platform.
Generate I-9 Access
To generate the employee's I-9 access token, make a call to the /employers/{employerId}/employees/{employeeId}/generateToken
GET endpoint, setting the employerId
and employeeId
path parameters in the URL.
Request
curl --location 'https://api.symmetry.com/i9/v1/employers/123456-b29d-75cf-a308-15ca267af31c/employees/12345-86d6-7447-aa2a-6a14c063273a/generateToken' \
--header 'Authorization: Bearer ••••••'
Response
The response contains the token
object, which contains a session-level access token and associated URL that allows the employee to access the embedded I-9 session. Read more about session-level access tokens here.
Below is an example of a successful request.
{
"token": {
"embeddedUri": "https://symmetry.workbright.com/sign_in_with_token?token=1234567890",
"token": "1234567890"
}
}
Response Elements
Below are the elements returned in the token
object.
Element | Type | Description |
---|---|---|
embeddedUri | string | A fully constructed URL to embed within your platform to access the employee's I-9 session. This link embeds the token as a query parameter and can be used to launch the employee's embedded experience. |
token | string | Token used to authenticate the employee into the embedded experience. Valid for 30 minutes. |
Updated 4 days ago