Bulk create investors
curl --request POST \
--url https://sandbox-api.zestequity.com/v1/investors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"investors": [
{
"partnerInvestorId": "acme-inv-7341",
"email": "alice@example.com",
"firstName": "Alice",
"lastName": "Liddell",
"dateOfBirth": "1985-04-12",
"countryOfResidence": "AE"
}
]
}
'import requests
url = "https://sandbox-api.zestequity.com/v1/investors"
payload = { "investors": [
{
"partnerInvestorId": "acme-inv-7341",
"email": "alice@example.com",
"firstName": "Alice",
"lastName": "Liddell",
"dateOfBirth": "1985-04-12",
"countryOfResidence": "AE"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
investors: [
{
partnerInvestorId: 'acme-inv-7341',
email: 'alice@example.com',
firstName: 'Alice',
lastName: 'Liddell',
dateOfBirth: '1985-04-12',
countryOfResidence: 'AE'
}
]
})
};
fetch('https://sandbox-api.zestequity.com/v1/investors', 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://sandbox-api.zestequity.com/v1/investors",
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([
'investors' => [
[
'partnerInvestorId' => 'acme-inv-7341',
'email' => 'alice@example.com',
'firstName' => 'Alice',
'lastName' => 'Liddell',
'dateOfBirth' => '1985-04-12',
'countryOfResidence' => 'AE'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://sandbox-api.zestequity.com/v1/investors"
payload := strings.NewReader("{\n \"investors\": [\n {\n \"partnerInvestorId\": \"acme-inv-7341\",\n \"email\": \"alice@example.com\",\n \"firstName\": \"Alice\",\n \"lastName\": \"Liddell\",\n \"dateOfBirth\": \"1985-04-12\",\n \"countryOfResidence\": \"AE\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://sandbox-api.zestequity.com/v1/investors")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"investors\": [\n {\n \"partnerInvestorId\": \"acme-inv-7341\",\n \"email\": \"alice@example.com\",\n \"firstName\": \"Alice\",\n \"lastName\": \"Liddell\",\n \"dateOfBirth\": \"1985-04-12\",\n \"countryOfResidence\": \"AE\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.zestequity.com/v1/investors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"investors\": [\n {\n \"partnerInvestorId\": \"acme-inv-7341\",\n \"email\": \"alice@example.com\",\n \"firstName\": \"Alice\",\n \"lastName\": \"Liddell\",\n \"dateOfBirth\": \"1985-04-12\",\n \"countryOfResidence\": \"AE\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"partnerInvestorId": "<string>",
"status": "<string>",
"zestPersonId": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"field": "<string>"
}
}
]
}{
"code": "<string>",
"detail": "ex: Something went wrong",
"errorId": "<string>",
"validationErrors": [
{
"attribute": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "ex: Something went wrong",
"errorId": "<string>",
"validationErrors": [
{
"attribute": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "ex: Something went wrong",
"errorId": "<string>",
"validationErrors": [
{
"attribute": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Investors
Bulk create investors
Creates one or more investor records. Always returns 200 with a per-row result keyed by partnerInvestorId. Idempotent across replays: a repeated partnerInvestorId returns the existing Zest person id. Idempotency-Key is optional and provides response-level caching.
POST
/
v1
/
investors
Bulk create investors
curl --request POST \
--url https://sandbox-api.zestequity.com/v1/investors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"investors": [
{
"partnerInvestorId": "acme-inv-7341",
"email": "alice@example.com",
"firstName": "Alice",
"lastName": "Liddell",
"dateOfBirth": "1985-04-12",
"countryOfResidence": "AE"
}
]
}
'import requests
url = "https://sandbox-api.zestequity.com/v1/investors"
payload = { "investors": [
{
"partnerInvestorId": "acme-inv-7341",
"email": "alice@example.com",
"firstName": "Alice",
"lastName": "Liddell",
"dateOfBirth": "1985-04-12",
"countryOfResidence": "AE"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
investors: [
{
partnerInvestorId: 'acme-inv-7341',
email: 'alice@example.com',
firstName: 'Alice',
lastName: 'Liddell',
dateOfBirth: '1985-04-12',
countryOfResidence: 'AE'
}
]
})
};
fetch('https://sandbox-api.zestequity.com/v1/investors', 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://sandbox-api.zestequity.com/v1/investors",
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([
'investors' => [
[
'partnerInvestorId' => 'acme-inv-7341',
'email' => 'alice@example.com',
'firstName' => 'Alice',
'lastName' => 'Liddell',
'dateOfBirth' => '1985-04-12',
'countryOfResidence' => 'AE'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://sandbox-api.zestequity.com/v1/investors"
payload := strings.NewReader("{\n \"investors\": [\n {\n \"partnerInvestorId\": \"acme-inv-7341\",\n \"email\": \"alice@example.com\",\n \"firstName\": \"Alice\",\n \"lastName\": \"Liddell\",\n \"dateOfBirth\": \"1985-04-12\",\n \"countryOfResidence\": \"AE\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://sandbox-api.zestequity.com/v1/investors")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"investors\": [\n {\n \"partnerInvestorId\": \"acme-inv-7341\",\n \"email\": \"alice@example.com\",\n \"firstName\": \"Alice\",\n \"lastName\": \"Liddell\",\n \"dateOfBirth\": \"1985-04-12\",\n \"countryOfResidence\": \"AE\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.zestequity.com/v1/investors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"investors\": [\n {\n \"partnerInvestorId\": \"acme-inv-7341\",\n \"email\": \"alice@example.com\",\n \"firstName\": \"Alice\",\n \"lastName\": \"Liddell\",\n \"dateOfBirth\": \"1985-04-12\",\n \"countryOfResidence\": \"AE\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"partnerInvestorId": "<string>",
"status": "<string>",
"zestPersonId": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"field": "<string>"
}
}
]
}{
"code": "<string>",
"detail": "ex: Something went wrong",
"errorId": "<string>",
"validationErrors": [
{
"attribute": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "ex: Something went wrong",
"errorId": "<string>",
"validationErrors": [
{
"attribute": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "ex: Something went wrong",
"errorId": "<string>",
"validationErrors": [
{
"attribute": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
Show child attributes
Show child attributes
Response
Successful Response
Show child attributes
Show child attributes
⌘I