TRANXACT.AI Help

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.

Type REST14 operationsBase path /api/hrms/i9-recordsPublished as /api/v1/i9-records

Download specification (OpenAPI 3.1) Screen: Form I-9

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablehr.i9_records · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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, firstDay

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

NameTypeDescription
idstring (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, additionalInfo

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

NameTypeDescription
idstring (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|C

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
record_notextread onlyRecord no
employee_iduuidread onlyEmployee id
tax_form_iduuidread onlyTax form id
first_daydateread onlyFirst day
section1_duedateread onlySection1 due
section2_duedateread onlySection2 due
statustextread onlyStatus
last_nametextread onlyLast name
first_nametextread onlyFirst name
middle_initialtextread onlyMiddle initial
other_last_namestextread onlyOther last names
address_linetextread onlyAddress line
apt_numbertextread onlyApt number
citytextread onlyCity
state_codetextread onlyState code
postal_codetextread onlyPostal code
date_of_birthdateread onlyDate of birth
ssn_last4textread onlySsn last4
emailtextread onlyEmail
phonetextread onlyPhone
citizenship_statustextread onlyCitizenship status
a_number_cipherbytearead onlyA number cipher
a_number_last4textread onlyA number last4
uscis_number_cipherbytearead onlyUscis number cipher
uscis_number_last4textread onlyUscis number last4
i94_number_cipherbytearead onlyI94 number cipher
i94_number_last4textread onlyI94 number last4
passport_number_cipherbytearead onlyPassport number cipher
passport_number_last4textread onlyPassport number last4
passport_countrytextread onlyPassport country
work_auth_expiresdateread onlyWork auth expires
preparer_usedbooleanread onlyPreparer used
preparersjsonbread onlyPreparers
s1_signed_nametextread onlyS1 signed name
s1_signed_attimestamp with time zoneread onlyS1 signed at
s1_signed_iptextread onlyS1 signed ip
s1_sha256textread onlyS1 sha256
document_choicetextread onlyDocument choice
s2_first_daydateread onlyS2 first day
s2_signer_iduuidread onlyS2 signer id
s2_signer_nametextread onlyS2 signer name
s2_signer_titletextread onlyS2 signer title
s2_employer_nametextread onlyS2 employer name
s2_employer_addresstextread onlyS2 employer address
s2_signed_attimestamp with time zoneread onlyS2 signed at
s2_sha256textread onlyS2 sha256
alt_procedurebooleanread onlyAlt procedure
additional_infotextread onlyAdditional info
reverification_duedateread onlyReverification due
late_reasontextread onlyLate reason
created_byuuidread onlyCreated by
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Form I-9 for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.