Contractors
Upload Contractor Government ID
Upload a base64-encoded government ID (driver’s license, social security card, or passport) for a contractor.
POST
/
contractors
/
id
Upload Contractor Government ID
curl --request POST \
--url https://api.zeal.com/contractors/id \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"contractorID": "618036cbee0d53002343911b",
"companyID": "fc23jk12bae46aa8a082f3577eacfa",
"id_type": "passport",
"id_base64": "iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq"
}
'import requests
url = "https://api.zeal.com/contractors/id"
payload = {
"contractorID": "618036cbee0d53002343911b",
"companyID": "fc23jk12bae46aa8a082f3577eacfa",
"id_type": "passport",
"id_base64": "iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq"
}
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: '618036cbee0d53002343911b',
companyID: 'fc23jk12bae46aa8a082f3577eacfa',
id_type: 'passport',
id_base64: 'iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq'
})
};
fetch('https://api.zeal.com/contractors/id', 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/id",
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' => '618036cbee0d53002343911b',
'companyID' => 'fc23jk12bae46aa8a082f3577eacfa',
'id_type' => 'passport',
'id_base64' => 'iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq'
]),
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/id"
payload := strings.NewReader("{\n \"contractorID\": \"618036cbee0d53002343911b\",\n \"companyID\": \"fc23jk12bae46aa8a082f3577eacfa\",\n \"id_type\": \"passport\",\n \"id_base64\": \"iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq\"\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/id")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contractorID\": \"618036cbee0d53002343911b\",\n \"companyID\": \"fc23jk12bae46aa8a082f3577eacfa\",\n \"id_type\": \"passport\",\n \"id_base64\": \"iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/contractors/id")
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\": \"618036cbee0d53002343911b\",\n \"companyID\": \"fc23jk12bae46aa8a082f3577eacfa\",\n \"id_type\": \"passport\",\n \"id_base64\": \"iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"_id": "627d2581aa61ff002824264e"
}{
"success": false,
"errors": [
{
"message": "id_type 'pasport' is not valid, it must be one of: drivers_license, passport",
"code": 47
}
]
}Authorizations
Body
application/json
ID of the Contractor
ID of the Company
type of the ID to be uploaded, current options are drivers_license, social_security_card and passport
Available options:
drivers_license, social_security_card, passport base64 image of the ID to be uploaded
⌘I
Upload Contractor Government ID
curl --request POST \
--url https://api.zeal.com/contractors/id \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"contractorID": "618036cbee0d53002343911b",
"companyID": "fc23jk12bae46aa8a082f3577eacfa",
"id_type": "passport",
"id_base64": "iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq"
}
'import requests
url = "https://api.zeal.com/contractors/id"
payload = {
"contractorID": "618036cbee0d53002343911b",
"companyID": "fc23jk12bae46aa8a082f3577eacfa",
"id_type": "passport",
"id_base64": "iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq"
}
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: '618036cbee0d53002343911b',
companyID: 'fc23jk12bae46aa8a082f3577eacfa',
id_type: 'passport',
id_base64: 'iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq'
})
};
fetch('https://api.zeal.com/contractors/id', 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/id",
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' => '618036cbee0d53002343911b',
'companyID' => 'fc23jk12bae46aa8a082f3577eacfa',
'id_type' => 'passport',
'id_base64' => 'iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq'
]),
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/id"
payload := strings.NewReader("{\n \"contractorID\": \"618036cbee0d53002343911b\",\n \"companyID\": \"fc23jk12bae46aa8a082f3577eacfa\",\n \"id_type\": \"passport\",\n \"id_base64\": \"iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq\"\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/id")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contractorID\": \"618036cbee0d53002343911b\",\n \"companyID\": \"fc23jk12bae46aa8a082f3577eacfa\",\n \"id_type\": \"passport\",\n \"id_base64\": \"iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/contractors/id")
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\": \"618036cbee0d53002343911b\",\n \"companyID\": \"fc23jk12bae46aa8a082f3577eacfa\",\n \"id_type\": \"passport\",\n \"id_base64\": \"iVBORw23goAAAANSUhEUgAAAtsAAABdCAYAAAB0Bq\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"_id": "627d2581aa61ff002824264e"
}{
"success": false,
"errors": [
{
"message": "id_type 'pasport' is not valid, it must be one of: drivers_license, passport",
"code": 47
}
]
}