GET
/
unified
/
hris
/
employees
/
{id}
/
work_eligibility
/
{subResourceId}
curl --request GET \
  --url https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'
{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "type": "visa",
    "sub_type": "H1B",
    "document": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "My Document",
      "path": "/path/to/file",
      "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": "abc"
          }
        }
      ],
      "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": "abc"
      }
    },
    "valid_from": "2021-01-01T00:00.000Z",
    "valid_to": "2021-01-01T00:00.000Z",
    "issued_by": {
      "value": "US",
      "source_value": "<string>"
    },
    "number": "1234567890"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

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

Path Parameters

id
string
required
subResourceId
string
required

Query Parameters

raw
boolean | null
default:false

Indicates that the raw request result is returned

proxy
object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields
string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number"

Response

200
application/json
The work eligibility of the employee with the given identifiers was retrieved.
data
object
required
raw
object[] | null