v1

latestOpenAPI 3.1.02026-07-1274177461.2 KB

Employees

Work Eligibility

Create Employee Work Eligibility Request

post/unified/hris/employees/{id}/work_eligibility

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

numberstring nullable

sub_typestring nullable

valid_fromstring date-time nullable

valid_tostring date-time nullable

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "document": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "My Document",
    "contents": [
      {
        "url": "https://example.com/file.pdf",
        "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download",
        "file_format": {
          "value": "pdf"
        }
      }
    ],
    "category_id": "6530",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-02T01:01:01.000Z",
    "remote_url": "https://example.com/file.pdf",
    "file_format": {
      "value": "pdf"
    }
  },
  "issued_by": {
    "value": "US"
  },
  "number": "1234567890",
  "sub_type": "H1B",
  "valid_from": "2021-01-01T00:00:00.000Z",
  "valid_to": "2021-01-01T00:00:00.000Z",
  "passthrough": {
    "other_known_names": "John Doe"
  }
}

Response

Record created successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}