Contractor Onboarding
Send Contractor Onboarding Link
Sends a contractor onboarding link to the specified contractor’s email in Zeal.
POST
/
sendContractorLink
Send Contractor Onboarding Link
curl --request POST \
--url https://api.zeal.com/sendContractorLink \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "1eeec343485723ee58afef12",
"contractors": [
{
"contractorID": "674759a85785745748e3847a",
"contractor_acct": true,
"id_scan": false,
"paperwork": true,
"paymentMethod": true,
"profile_info": true,
"bank_info": true,
"paycard": false,
"instant_pay": false
},
{
"contractorID": "774759a85785745748e3847b",
"contractor_acct": false,
"id_scan": true,
"paperwork": true,
"paymentMethod": true,
"profile_info": true,
"bank_info": true,
"paycard": false,
"instant_pay": false
}
]
}
'import requests
url = "https://api.zeal.com/sendContractorLink"
payload = {
"companyID": "1eeec343485723ee58afef12",
"contractors": [
{
"contractorID": "674759a85785745748e3847a",
"contractor_acct": True,
"id_scan": False,
"paperwork": True,
"paymentMethod": True,
"profile_info": True,
"bank_info": True,
"paycard": False,
"instant_pay": False
},
{
"contractorID": "774759a85785745748e3847b",
"contractor_acct": False,
"id_scan": True,
"paperwork": True,
"paymentMethod": True,
"profile_info": True,
"bank_info": True,
"paycard": False,
"instant_pay": 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: '1eeec343485723ee58afef12',
contractors: [
{
contractorID: '674759a85785745748e3847a',
contractor_acct: true,
id_scan: false,
paperwork: true,
paymentMethod: true,
profile_info: true,
bank_info: true,
paycard: false,
instant_pay: false
},
{
contractorID: '774759a85785745748e3847b',
contractor_acct: false,
id_scan: true,
paperwork: true,
paymentMethod: true,
profile_info: true,
bank_info: true,
paycard: false,
instant_pay: false
}
]
})
};
fetch('https://api.zeal.com/sendContractorLink', 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/sendContractorLink",
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' => '1eeec343485723ee58afef12',
'contractors' => [
[
'contractorID' => '674759a85785745748e3847a',
'contractor_acct' => true,
'id_scan' => false,
'paperwork' => true,
'paymentMethod' => true,
'profile_info' => true,
'bank_info' => true,
'paycard' => false,
'instant_pay' => false
],
[
'contractorID' => '774759a85785745748e3847b',
'contractor_acct' => false,
'id_scan' => true,
'paperwork' => true,
'paymentMethod' => true,
'profile_info' => true,
'bank_info' => true,
'paycard' => false,
'instant_pay' => 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/sendContractorLink"
payload := strings.NewReader("{\n \"companyID\": \"1eeec343485723ee58afef12\",\n \"contractors\": [\n {\n \"contractorID\": \"674759a85785745748e3847a\",\n \"contractor_acct\": true,\n \"id_scan\": false,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n },\n {\n \"contractorID\": \"774759a85785745748e3847b\",\n \"contractor_acct\": false,\n \"id_scan\": true,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n }\n ]\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/sendContractorLink")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"1eeec343485723ee58afef12\",\n \"contractors\": [\n {\n \"contractorID\": \"674759a85785745748e3847a\",\n \"contractor_acct\": true,\n \"id_scan\": false,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n },\n {\n \"contractorID\": \"774759a85785745748e3847b\",\n \"contractor_acct\": false,\n \"id_scan\": true,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/sendContractorLink")
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\": \"1eeec343485723ee58afef12\",\n \"contractors\": [\n {\n \"contractorID\": \"674759a85785745748e3847a\",\n \"contractor_acct\": true,\n \"id_scan\": false,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n },\n {\n \"contractorID\": \"774759a85785745748e3847b\",\n \"contractor_acct\": false,\n \"id_scan\": true,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"employeeID": "674759a85785745748e3847a",
"link": "https://payroll.your-domain.com/contractoronboarding/10983755744920193854758300657020834"
},
{
"employeeID": "774759a85785745748e3847b",
"link": "https://payroll.your-domain.com/contractoronboarding/20983755744920193854758300657020835"
}
]
}{
"success": false,
"errors": [
{
"message": "Failed to create onboarding link for worker 674759a85785745748e3847a",
"code": 0
}
]
}Authorizations
Body
application/json
⌘I
Send Contractor Onboarding Link
curl --request POST \
--url https://api.zeal.com/sendContractorLink \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "1eeec343485723ee58afef12",
"contractors": [
{
"contractorID": "674759a85785745748e3847a",
"contractor_acct": true,
"id_scan": false,
"paperwork": true,
"paymentMethod": true,
"profile_info": true,
"bank_info": true,
"paycard": false,
"instant_pay": false
},
{
"contractorID": "774759a85785745748e3847b",
"contractor_acct": false,
"id_scan": true,
"paperwork": true,
"paymentMethod": true,
"profile_info": true,
"bank_info": true,
"paycard": false,
"instant_pay": false
}
]
}
'import requests
url = "https://api.zeal.com/sendContractorLink"
payload = {
"companyID": "1eeec343485723ee58afef12",
"contractors": [
{
"contractorID": "674759a85785745748e3847a",
"contractor_acct": True,
"id_scan": False,
"paperwork": True,
"paymentMethod": True,
"profile_info": True,
"bank_info": True,
"paycard": False,
"instant_pay": False
},
{
"contractorID": "774759a85785745748e3847b",
"contractor_acct": False,
"id_scan": True,
"paperwork": True,
"paymentMethod": True,
"profile_info": True,
"bank_info": True,
"paycard": False,
"instant_pay": 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: '1eeec343485723ee58afef12',
contractors: [
{
contractorID: '674759a85785745748e3847a',
contractor_acct: true,
id_scan: false,
paperwork: true,
paymentMethod: true,
profile_info: true,
bank_info: true,
paycard: false,
instant_pay: false
},
{
contractorID: '774759a85785745748e3847b',
contractor_acct: false,
id_scan: true,
paperwork: true,
paymentMethod: true,
profile_info: true,
bank_info: true,
paycard: false,
instant_pay: false
}
]
})
};
fetch('https://api.zeal.com/sendContractorLink', 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/sendContractorLink",
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' => '1eeec343485723ee58afef12',
'contractors' => [
[
'contractorID' => '674759a85785745748e3847a',
'contractor_acct' => true,
'id_scan' => false,
'paperwork' => true,
'paymentMethod' => true,
'profile_info' => true,
'bank_info' => true,
'paycard' => false,
'instant_pay' => false
],
[
'contractorID' => '774759a85785745748e3847b',
'contractor_acct' => false,
'id_scan' => true,
'paperwork' => true,
'paymentMethod' => true,
'profile_info' => true,
'bank_info' => true,
'paycard' => false,
'instant_pay' => 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/sendContractorLink"
payload := strings.NewReader("{\n \"companyID\": \"1eeec343485723ee58afef12\",\n \"contractors\": [\n {\n \"contractorID\": \"674759a85785745748e3847a\",\n \"contractor_acct\": true,\n \"id_scan\": false,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n },\n {\n \"contractorID\": \"774759a85785745748e3847b\",\n \"contractor_acct\": false,\n \"id_scan\": true,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n }\n ]\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/sendContractorLink")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"1eeec343485723ee58afef12\",\n \"contractors\": [\n {\n \"contractorID\": \"674759a85785745748e3847a\",\n \"contractor_acct\": true,\n \"id_scan\": false,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n },\n {\n \"contractorID\": \"774759a85785745748e3847b\",\n \"contractor_acct\": false,\n \"id_scan\": true,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/sendContractorLink")
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\": \"1eeec343485723ee58afef12\",\n \"contractors\": [\n {\n \"contractorID\": \"674759a85785745748e3847a\",\n \"contractor_acct\": true,\n \"id_scan\": false,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n },\n {\n \"contractorID\": \"774759a85785745748e3847b\",\n \"contractor_acct\": false,\n \"id_scan\": true,\n \"paperwork\": true,\n \"paymentMethod\": true,\n \"profile_info\": true,\n \"bank_info\": true,\n \"paycard\": false,\n \"instant_pay\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"employeeID": "674759a85785745748e3847a",
"link": "https://payroll.your-domain.com/contractoronboarding/10983755744920193854758300657020834"
},
{
"employeeID": "774759a85785745748e3847b",
"link": "https://payroll.your-domain.com/contractoronboarding/20983755744920193854758300657020835"
}
]
}{
"success": false,
"errors": [
{
"message": "Failed to create onboarding link for worker 674759a85785745748e3847a",
"code": 0
}
]
}