TRANXACT.AI Help

Employee Self Service · My Workspace

My I-9

Form I-9 Section 1, by your first day: your citizenship or immigration status, signed online. And any E-Verify notice for you.

Type REST5 operationsBase path /api/ess/my-i9

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

Overview

PackageEmployee Self Service
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 Employee Self Service › My 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

5 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ess/my-i9Read my i-9

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ess/my-i9" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ess/my-i9/startStart

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/ess/my-i9/start" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ess/my-i9/section1Section1

Request body

The keys this action reads (* = required; "one of" lists the only values):

signedName, attest, ssn

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/ess/my-i9/section1" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"signedName":"value","attest":"value","ssn":"value"}'
POST/api/ess/my-i9/verifications/{id}/decisionVerifications decision

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):

contest

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/ess/my-i9/verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decision" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"contest":"value"}'
GET/api/ess/my-i9/verifications/{id}/noticeVerifications notice

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/ess/my-i9/verifications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/notice" \
  -H "Authorization: Bearer $TOKEN"

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 Employee Self Service › My 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.