Contractor Onboarding
Set Onboarded Status to True
Set a contractor as onboarded once all legally required information has been provided.
POST
/
contractors
/
setOnboardedStatusToTrue
cURL
curl --request POST \
--url https://api.zeal.com/contractors/setOnboardedStatusToTrue \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"contractorID": "<string>",
"companyID": "<string>"
}
'import requests
url = "https://api.zeal.com/contractors/setOnboardedStatusToTrue"
payload = {
"contractorID": "<string>",
"companyID": "<string>"
}
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({contractorID: '<string>', companyID: '<string>'})
};
fetch('https://api.zeal.com/contractors/setOnboardedStatusToTrue', 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/contractors/setOnboardedStatusToTrue",
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([
'contractorID' => '<string>',
'companyID' => '<string>'
]),
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/contractors/setOnboardedStatusToTrue"
payload := strings.NewReader("{\n \"contractorID\": \"<string>\",\n \"companyID\": \"<string>\"\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/contractors/setOnboardedStatusToTrue")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contractorID\": \"<string>\",\n \"companyID\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/contractors/setOnboardedStatusToTrue")
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 \"contractorID\": \"<string>\",\n \"companyID\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {}
}{
"success": false,
"errors": [
{
"message": "<string>",
"code": 123
}
]
}Set onboarded status to
true if the contractor has all the legally required information. If the contractor does not have the aforementioned properties, Zeal will return an array of errors stating which properties are missing.⌘I
cURL
curl --request POST \
--url https://api.zeal.com/contractors/setOnboardedStatusToTrue \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"contractorID": "<string>",
"companyID": "<string>"
}
'import requests
url = "https://api.zeal.com/contractors/setOnboardedStatusToTrue"
payload = {
"contractorID": "<string>",
"companyID": "<string>"
}
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({contractorID: '<string>', companyID: '<string>'})
};
fetch('https://api.zeal.com/contractors/setOnboardedStatusToTrue', 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/contractors/setOnboardedStatusToTrue",
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([
'contractorID' => '<string>',
'companyID' => '<string>'
]),
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/contractors/setOnboardedStatusToTrue"
payload := strings.NewReader("{\n \"contractorID\": \"<string>\",\n \"companyID\": \"<string>\"\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/contractors/setOnboardedStatusToTrue")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contractorID\": \"<string>\",\n \"companyID\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/contractors/setOnboardedStatusToTrue")
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 \"contractorID\": \"<string>\",\n \"companyID\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {}
}{
"success": false,
"errors": [
{
"message": "<string>",
"code": 123
}
]
}