MCP
A2AUpdate 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"
}
}
'import requests
url = "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}"
payload = {
"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" }
}
headers = {
"x-account-id": "<x-account-id>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-account-id': '<x-account-id>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'}
})
};
fetch('https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"x-account-id: <x-account-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}"
payload := strings.NewReader("{\n \"document\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"My Document\",\n \"category\": \"templates, forms, backups, etc.\",\n \"contents\": [\n {\n \"url\": \"https://example.com/file.pdf\",\n \"unified_url\": \"https://api.stackone.com/unified/hris/employees/12345/documents/67890/download\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n }\n ],\n \"category_id\": \"6530\",\n \"created_at\": \"2021-01-01T01:01:01.000Z\",\n \"updated_at\": \"2021-01-02T01:01:01.000Z\",\n \"remote_url\": \"https://example.com/file.pdf\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n },\n \"issued_by\": {\n \"value\": \"US\",\n \"source_value\": \"<string>\"\n },\n \"number\": \"1234567890\",\n \"sub_type\": \"H1B\",\n \"type\": \"visa\",\n \"valid_from\": \"2021-01-01T00:00:00.000Z\",\n \"valid_to\": \"2021-01-01T00:00:00.000Z\",\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-account-id", "<x-account-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}")
.header("x-account-id", "<x-account-id>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"document\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"My Document\",\n \"category\": \"templates, forms, backups, etc.\",\n \"contents\": [\n {\n \"url\": \"https://example.com/file.pdf\",\n \"unified_url\": \"https://api.stackone.com/unified/hris/employees/12345/documents/67890/download\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n }\n ],\n \"category_id\": \"6530\",\n \"created_at\": \"2021-01-01T01:01:01.000Z\",\n \"updated_at\": \"2021-01-02T01:01:01.000Z\",\n \"remote_url\": \"https://example.com/file.pdf\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n },\n \"issued_by\": {\n \"value\": \"US\",\n \"source_value\": \"<string>\"\n },\n \"number\": \"1234567890\",\n \"sub_type\": \"H1B\",\n \"type\": \"visa\",\n \"valid_from\": \"2021-01-01T00:00:00.000Z\",\n \"valid_to\": \"2021-01-01T00:00:00.000Z\",\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"My Document\",\n \"category\": \"templates, forms, backups, etc.\",\n \"contents\": [\n {\n \"url\": \"https://example.com/file.pdf\",\n \"unified_url\": \"https://api.stackone.com/unified/hris/employees/12345/documents/67890/download\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n }\n ],\n \"category_id\": \"6530\",\n \"created_at\": \"2021-01-01T01:01:01.000Z\",\n \"updated_at\": \"2021-01-02T01:01:01.000Z\",\n \"remote_url\": \"https://example.com/file.pdf\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n },\n \"issued_by\": {\n \"value\": \"US\",\n \"source_value\": \"<string>\"\n },\n \"number\": \"1234567890\",\n \"sub_type\": \"H1B\",\n \"type\": \"visa\",\n \"valid_from\": \"2021-01-01T00:00:00.000Z\",\n \"valid_to\": \"2021-01-01T00:00:00.000Z\",\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 412,
"message": "Precondition failed",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Update Employee Work Eligibility Request
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"
}
}
'import requests
url = "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}"
payload = {
"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" }
}
headers = {
"x-account-id": "<x-account-id>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-account-id': '<x-account-id>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'}
})
};
fetch('https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"x-account-id: <x-account-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}"
payload := strings.NewReader("{\n \"document\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"My Document\",\n \"category\": \"templates, forms, backups, etc.\",\n \"contents\": [\n {\n \"url\": \"https://example.com/file.pdf\",\n \"unified_url\": \"https://api.stackone.com/unified/hris/employees/12345/documents/67890/download\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n }\n ],\n \"category_id\": \"6530\",\n \"created_at\": \"2021-01-01T01:01:01.000Z\",\n \"updated_at\": \"2021-01-02T01:01:01.000Z\",\n \"remote_url\": \"https://example.com/file.pdf\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n },\n \"issued_by\": {\n \"value\": \"US\",\n \"source_value\": \"<string>\"\n },\n \"number\": \"1234567890\",\n \"sub_type\": \"H1B\",\n \"type\": \"visa\",\n \"valid_from\": \"2021-01-01T00:00:00.000Z\",\n \"valid_to\": \"2021-01-01T00:00:00.000Z\",\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-account-id", "<x-account-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}")
.header("x-account-id", "<x-account-id>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"document\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"My Document\",\n \"category\": \"templates, forms, backups, etc.\",\n \"contents\": [\n {\n \"url\": \"https://example.com/file.pdf\",\n \"unified_url\": \"https://api.stackone.com/unified/hris/employees/12345/documents/67890/download\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n }\n ],\n \"category_id\": \"6530\",\n \"created_at\": \"2021-01-01T01:01:01.000Z\",\n \"updated_at\": \"2021-01-02T01:01:01.000Z\",\n \"remote_url\": \"https://example.com/file.pdf\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n },\n \"issued_by\": {\n \"value\": \"US\",\n \"source_value\": \"<string>\"\n },\n \"number\": \"1234567890\",\n \"sub_type\": \"H1B\",\n \"type\": \"visa\",\n \"valid_from\": \"2021-01-01T00:00:00.000Z\",\n \"valid_to\": \"2021-01-01T00:00:00.000Z\",\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document\": {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"My Document\",\n \"category\": \"templates, forms, backups, etc.\",\n \"contents\": [\n {\n \"url\": \"https://example.com/file.pdf\",\n \"unified_url\": \"https://api.stackone.com/unified/hris/employees/12345/documents/67890/download\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n }\n ],\n \"category_id\": \"6530\",\n \"created_at\": \"2021-01-01T01:01:01.000Z\",\n \"updated_at\": \"2021-01-02T01:01:01.000Z\",\n \"remote_url\": \"https://example.com/file.pdf\",\n \"file_format\": {\n \"value\": \"pdf\",\n \"source_value\": \"application/pdf\"\n }\n },\n \"issued_by\": {\n \"value\": \"US\",\n \"source_value\": \"<string>\"\n },\n \"number\": \"1234567890\",\n \"sub_type\": \"H1B\",\n \"type\": \"visa\",\n \"valid_from\": \"2021-01-01T00:00:00.000Z\",\n \"valid_to\": \"2021-01-01T00:00:00.000Z\",\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 412,
"message": "Precondition failed",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
The account identifier
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"
Body
application/json
Show child attributes
Show child attributes
The country code of the issued by authority
Show child attributes
Show child attributes
Example:
"1234567890"
Example:
"H1B"
Show child attributes
Show child attributes
Example:
"visa"
Example:
"2021-01-01T00:00:00.000Z"
Example:
"2021-01-01T00:00:00.000Z"
Value to pass through to the provider
Example:
{ "other_known_names": "John Doe" }
Response
Was this page helpful?
⌘I