This API returns a collection of I-9s. Optional page_size and page parameters can be passed in order to limit the results. Results include the I-9 record Guardian ID which can be used in a subsequent GET request to obtain additional details related to the I-9. For additional parameter information access the i9s data model section to review field information.
A maximum of 50 I-9s are returned in the response. The ‘links’ section of the response includes paging information. Use this information to obtain additional collections of I-9 records, e.g. GET https://<server>/v1/i9s?page=2.
Method
GET
Resource Information
| Requires authentication? |
YES |
| Response formats |
JSON |
Parameters
| Parameter |
Required |
Description |
| page |
No |
specifies the page number from where you want to begin accessing records |
| firstName |
string |
Employee’s first name |
| lastName |
string |
Employee’s last name |
| startDate |
date string |
Employee’s I-9 hire date |
| i9Expiration |
date string |
The date I-9 reverification or receipt update is due |
Example
Request Example: GET https://<server>/v1/i9s
Response Example:
{
""searchResult"": [
{
""lastName"": Adams,
""emailAddress"": null,
""id"": 2067713,
""firstName"": Betty
},
{
""lastName"": ""Drummond"",
""emailAddress"": """",
""id"": 1745835,
""firstName"": ""Elise""
},
{
""lastName"": ""Smith"",
""emailAddress"": """",
""id"": 2067702,
""firstName"": ""Michael""
},
{
""lastName"": ""Bronson"",
""emailAddress"": ""ebronson@email.com"",
""id"": 1933290,
""firstName"": ""Ethan""
}
],
""links"": [
{
""href"": ""/v1/i9s"",
""rel"": ""self""
},
{
""href"": ""/v1/i9s?page=1"",
""rel"": ""first""
},
{
""href"": ""/v1/i9s?page=2"",
""rel"": ""last""
},
{
""href"": ""/v1/i9s?page=2"",
""rel"": ""next""
},
{
""href"": ""/v1/i9s?page=2"",
""rel"": ""previous""
}
]
}
Single Record Query String Example
Request Example: GET https://<server>/v1/i9s?firstName=Judy&lastName=Jones
Single Record Response Example:
{
""searchResult"": [
{
""lastName"": ""Jones"",
""emailAddress"": null,
""id"": 1933551,
""firstName"": ""Judy""
}
],
""links"": [
{
""href"": ""/v1/i9s"",
""rel"": ""self""
},
{
""href"": ""/v1/i9s?page=1"",
""rel"": ""first""
},
{
""href"": ""/v1/i9s?page=1"",
""rel"": ""last""
},
{
""href"": ""/v1/i9s?page=1"",
""rel"": ""next""
},
{
""href"": ""/v1/i9s?page=1"",
""rel"": ""previous""
}
]
}
Single Record Request Example
Request: GET https://<server>/v1/i9s/<id>
Single Record Response Example:
{
""translatorLastName"": null,
""translatorZip"": null,
""i9Expiration"": null,
""listA2DocNumber"": null,
""links"": [
{
""href"": ""/v1/i9s/2067713"",
""rel"": ""self""
}
],
""startDate"": null,
""addressStreet"": null,
""listCDocTitle"": null,
""dateCompleted"": null,
""employerFirstName"": null,
""listA3DocIssuer"": null,
""listA1DocNumber"": null,
""listA3DocNumber"": null,
""translatorCity"": null,
""id"": 2067713,
""listA3DocExpiration"": null,
""listCDocIssuer"": null,
""signedDateEmployer"": null,
""signedDateTranslator"": null,
""listA2DocIssuer"": null,
""alienNumber"": null,
""listA1DocExpiration"": null,
""otherName"": null,
""dateDue"": null,
""employerAddress"": null,
""employerState"": null,
""dateOfBirth"": null,
""listCDocNumber"": null,
""workAuthorization"": null,
""phoneNumber"": null,
""firstName"": null,
""signedDateEmployee"": null,
""formType"": 0,
""employerCity"": null,
""foreignPassportCountry"": null,
""listBDocTitle"": null,
""i9Status"": ""Section 1 Incomplete"",
""listA2DocExpiration"": null,
""employerTitle"": null,
""listA3DocTitle"": null,
""i9Notes"": null,
""listBDocIssuer"": null,
""dateCreated"": ""2017-11-01T15:18:34.523953"",
""translatorAddress"": null,
""emailAddress"": null,
""formVersion"": ""8/23/17"",
""employerZip"": null,
""listA1DocTitle"": null,
""addressCity"": null,
""foreignPassportNumber"": null,
""listA2DocTitle"": null,
""admissionNumber"": null,
""listA1DocIssuer"": null,
""listCDocExpiration"": null,
""lastName"": null,
""addressState"": null,
""middleInitial"": null,
""translatorState"": null,
""listBDocExpiration"": null,
""attestation"": null,
""ssn"": null,
""listBDocNumber"": null,
""employerLastName"": null,
""addressApartment"": null,
""employerBusiness"": null,
""dateApproved"": null,
""translatorFirstName"": null,
""addressZip"": null
}