HRMS · US Employment Forms
Form I-9
Employment eligibility: Section 1 is the employee’s, by their first day; Section 2 is yours, within three business days of it; Supplement B when a work authorization expires. Overdue forms come first. Numbers are sealed and shown as their last four. Retain until the later of 3 years after the first day and 1 year after employment ends.
/api/hrms/i9-recordsPublished as /api/v1/i9-recordsOverview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Form I-9 on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | hr.i9_records · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
14 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/i9-recordsList form i-9
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"record_no": "REC-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tax_form_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"first_day": "2026-10-30",
"section1_due": "2026-10-30",
"section2_due": "2026-10-30",
"status": "draft",
"last_name": "Example",
"first_name": "Example",
"middle_initial": "text",
"other_last_names": "Example",
"address_line": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/i9-records?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/i9-records/{id}Read one form i-9
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"record_no": "REC-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"tax_form_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"first_day": "2026-10-30",
"section1_due": "2026-10-30",
"section2_due": "2026-10-30",
"status": "draft",
"last_name": "Example",
"first_name": "Example",
"middle_initial": "text",
"other_last_names": "Example",
"address_line": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/i9-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/i9-records/guideGuide
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/i9-records/guide" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/i9-records/remindersReminders
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/i9-records/reminders" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/i9-records/startStart
Request body
The keys this action reads (* = required; "one of" lists the only values):
employeeId, employee_id, firstDayResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/i9-records/start" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employeeId":"value","employee_id":"value","firstDay":"value"}'POST/api/hrms/i9-records/{id}/section2Section2
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
documentChoice, document_choice, attest, signerTitle, signer_title, firstDay, lateReason, employerName, employerAddress, altProcedure, alt_procedure, additionalInfoResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/i9-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/section2" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"documentChoice":"value","document_choice":"value","attest":"value","signerTitle":"value","signer_title":"value","firstDay":"value"}'POST/api/hrms/i9-records/{id}/reverifyReverify
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
list, title, issuer, number, expires, file, attest, newLastName, newFirstName, rehireDate; list one of A|CResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/i9-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reverify" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"list":"value","title":"value","issuer":"value","number":"value","expires":"value","file":"value"}'POST/api/hrms/i9-records/{id}/voidVoid
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
reason*Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/i9-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/void" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'GET/api/hrms/i9-records/{id}/pdfPdf
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/i9-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/pdf" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/i9-records/{id}/documentsDocuments
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/i9-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/documents" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/i9-recordsPost form i-9
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/i9-records" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/i9-records/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/i9-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/hrms/i9-records/{id}Put form i-9
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/i9-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/i9-records/{id}Delete form i-9
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/i9-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a form i-9, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
record_no | text | read only | Record no |
employee_id | uuid | read only | Employee id |
tax_form_id | uuid | read only | Tax form id |
first_day | date | read only | First day |
section1_due | date | read only | Section1 due |
section2_due | date | read only | Section2 due |
status | text | read only | Status |
last_name | text | read only | Last name |
first_name | text | read only | First name |
middle_initial | text | read only | Middle initial |
other_last_names | text | read only | Other last names |
address_line | text | read only | Address line |
apt_number | text | read only | Apt number |
city | text | read only | City |
state_code | text | read only | State code |
postal_code | text | read only | Postal code |
date_of_birth | date | read only | Date of birth |
ssn_last4 | text | read only | Ssn last4 |
email | text | read only | |
phone | text | read only | Phone |
citizenship_status | text | read only | Citizenship status |
a_number_cipher | bytea | read only | A number cipher |
a_number_last4 | text | read only | A number last4 |
uscis_number_cipher | bytea | read only | Uscis number cipher |
uscis_number_last4 | text | read only | Uscis number last4 |
i94_number_cipher | bytea | read only | I94 number cipher |
i94_number_last4 | text | read only | I94 number last4 |
passport_number_cipher | bytea | read only | Passport number cipher |
passport_number_last4 | text | read only | Passport number last4 |
passport_country | text | read only | Passport country |
work_auth_expires | date | read only | Work auth expires |
preparer_used | boolean | read only | Preparer used |
preparers | jsonb | read only | Preparers |
s1_signed_name | text | read only | S1 signed name |
s1_signed_at | timestamp with time zone | read only | S1 signed at |
s1_signed_ip | text | read only | S1 signed ip |
s1_sha256 | text | read only | S1 sha256 |
document_choice | text | read only | Document choice |
s2_first_day | date | read only | S2 first day |
s2_signer_id | uuid | read only | S2 signer id |
s2_signer_name | text | read only | S2 signer name |
s2_signer_title | text | read only | S2 signer title |
s2_employer_name | text | read only | S2 employer name |
s2_employer_address | text | read only | S2 employer address |
s2_signed_at | timestamp with time zone | read only | S2 signed at |
s2_sha256 | text | read only | S2 sha256 |
alt_procedure | boolean | read only | Alt procedure |
additional_info | text | read only | Additional info |
reverification_due | date | read only | Reverification due |
late_reason | text | read only | Late reason |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Form I-9 for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.