Employee Onboarding
Create Custom Paperwork Link (Early Access)
Create a link for an employee to complete custom paperwork in Zeal.
POST
/
employees
/
custom_paperwork
Create Custom Paperwork Link (Early Access)
curl --request POST \
--url https://api.zeal.com/employees/custom_paperwork \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "<string>",
"employeeID": "<string>",
"formTemplateIDs": [
"<string>"
],
"send_to_worker": false
}
'import requests
url = "https://api.zeal.com/employees/custom_paperwork"
payload = {
"companyID": "<string>",
"employeeID": "<string>",
"formTemplateIDs": ["<string>"],
"send_to_worker": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '<string>',
employeeID: '<string>',
formTemplateIDs: ['<string>'],
send_to_worker: false
})
};
fetch('https://api.zeal.com/employees/custom_paperwork', 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.zeal.com/employees/custom_paperwork",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '<string>',
'employeeID' => '<string>',
'formTemplateIDs' => [
'<string>'
],
'send_to_worker' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.zeal.com/employees/custom_paperwork"
payload := strings.NewReader("{\n \"companyID\": \"<string>\",\n \"employeeID\": \"<string>\",\n \"formTemplateIDs\": [\n \"<string>\"\n ],\n \"send_to_worker\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.post("https://api.zeal.com/employees/custom_paperwork")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"<string>\",\n \"employeeID\": \"<string>\",\n \"formTemplateIDs\": [\n \"<string>\"\n ],\n \"send_to_worker\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employees/custom_paperwork")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"<string>\",\n \"employeeID\": \"<string>\",\n \"formTemplateIDs\": [\n \"<string>\"\n ],\n \"send_to_worker\": false\n}"
response = http.request(request)
puts response.read_body{
"data": "https://zeal-prod.embedpayroll.com/employee-information?accessToken=...",
"success": true,
"testMode": true
}{
"errors": [
{
"message": "The following formTemplateIDs: (3b1d9b0e-a146-4b48-a77d-c02ae5e5c35d) are not applicable to this worker. Please remove them from the request and try again.",
"code": 13,
"status": 400,
"correlationId": "5d5544f9-fb8b-4c81-a8cc-68415bc214e0"
}
],
"success": false,
"testMode": true
}Authorizations
Body
application/json
⌘I
Create Custom Paperwork Link (Early Access)
curl --request POST \
--url https://api.zeal.com/employees/custom_paperwork \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "<string>",
"employeeID": "<string>",
"formTemplateIDs": [
"<string>"
],
"send_to_worker": false
}
'import requests
url = "https://api.zeal.com/employees/custom_paperwork"
payload = {
"companyID": "<string>",
"employeeID": "<string>",
"formTemplateIDs": ["<string>"],
"send_to_worker": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '<string>',
employeeID: '<string>',
formTemplateIDs: ['<string>'],
send_to_worker: false
})
};
fetch('https://api.zeal.com/employees/custom_paperwork', 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.zeal.com/employees/custom_paperwork",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '<string>',
'employeeID' => '<string>',
'formTemplateIDs' => [
'<string>'
],
'send_to_worker' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.zeal.com/employees/custom_paperwork"
payload := strings.NewReader("{\n \"companyID\": \"<string>\",\n \"employeeID\": \"<string>\",\n \"formTemplateIDs\": [\n \"<string>\"\n ],\n \"send_to_worker\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.post("https://api.zeal.com/employees/custom_paperwork")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"<string>\",\n \"employeeID\": \"<string>\",\n \"formTemplateIDs\": [\n \"<string>\"\n ],\n \"send_to_worker\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employees/custom_paperwork")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"<string>\",\n \"employeeID\": \"<string>\",\n \"formTemplateIDs\": [\n \"<string>\"\n ],\n \"send_to_worker\": false\n}"
response = http.request(request)
puts response.read_body{
"data": "https://zeal-prod.embedpayroll.com/employee-information?accessToken=...",
"success": true,
"testMode": true
}{
"errors": [
{
"message": "The following formTemplateIDs: (3b1d9b0e-a146-4b48-a77d-c02ae5e5c35d) are not applicable to this worker. Please remove them from the request and try again.",
"code": 13,
"status": 400,
"correlationId": "5d5544f9-fb8b-4c81-a8cc-68415bc214e0"
}
],
"success": false,
"testMode": true
}