Skip to main content
PATCH
/
unified
/
hris
/
employees
/
{id}
/
work_eligibility
/
{subResourceId}
Update Employee Work Eligibility Request
curl --request PATCH \
  --url https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "document": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "My Document",
    "category": "templates, forms, backups, etc.",
    "contents": [
      {
        "url": "https://example.com/file.pdf",
        "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download",
        "file_format": {
          "value": "pdf",
          "source_value": "application/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",
      "source_value": "application/pdf"
    }
  },
  "issued_by": {
    "value": "US",
    "source_value": "<string>"
  },
  "number": "1234567890",
  "sub_type": "H1B",
  "type": "visa",
  "valid_from": "2021-01-01T00:00:00.000Z",
  "valid_to": "2021-01-01T00:00:00.000Z",
  "passthrough": {
    "other_known_names": "John Doe"
  }
}
'
{
  "statusCode": 400,
  "message": "Bad Request",
  "timestamp": "2023-05-30T00:00:00.000Z",
  "data": {
    "statusCode": 400,
    "message": "Bad Request",
    "headers": {
      "content-type": "application/json",
      "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
    }
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.provider.com/v1/resource",
      "raw": {
        "message": "Invalid input parameters"
      },
      "headers": {
        "content-type": "application/json",
        "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.stackone.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

​
Prefer
string

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

Example:

"heartbeat"

Path Parameters

​
id
string
required
​
subResourceId
string
required

Body

application/json
​
document
object
​
issued_by
object

The country code of the issued by authority

​
number
string | null
Example:

"1234567890"

​
sub_type
string | null
Example:

"H1B"

​
type
object
Example:

"visa"

​
valid_from
string<date-time> | null
Example:

"2021-01-01T00:00:00.000Z"

​
valid_to
string<date-time> | null
Example:

"2021-01-01T00:00:00.000Z"

​
passthrough
object

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }

Response