List persons for a business entity
curl --request GET \
--url https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons \
--header 'x-api-key: <api-key>'import requests
url = "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons', 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.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"persons": [
{
"id": 12,
"firstName": "Jane",
"lastName": "Founder",
"dateOfBirth": "1990-04-18",
"email": "jane@acme.com",
"kycIds": [
{
"type": "US_SSN",
"name": "Social Security Number",
"value": "<string>",
"documentId": "<string>",
"doesNotHaveKYCId": true,
"decryptedValue": "<string>"
}
],
"residentialAddress": {
"addressLine1": "1 Raffles Place",
"city": "Singapore",
"country": "SG",
"addressLine2": "Suite 21045",
"addressLine3": "<string>",
"postalCode": "048616",
"state": "<string>"
},
"stakeholderId": "stk_123",
"phoneNumber": "+14155550123",
"sharePercentage": 75,
"governanceRelationships": {
"DIRECTOR": {
"startDate": "2020-01-15",
"endDate": null,
"isResidentDirector": true
},
"BENEFICIAL_OWNER": {
"isBeneficialOwner": true
}
},
"gender": "<string>",
"nationalities": [
"<string>"
],
"onboardingInfo": {},
"employmentStartDate": "<string>",
"directorIdentificationNumber": "00012345",
"jobTitle": [
"<string>"
],
"startDateOfEmployment": "2025-01-01",
"isResidentDirector": true
}
],
"count": 2
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Persons
List persons for a business entity
List people associated with a customer’s business entity.
GET
/
partner
/
commenda-os
/
customers
/
{customerId}
/
business-entities
/
{businessEntityId}
/
persons
List persons for a business entity
curl --request GET \
--url https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons \
--header 'x-api-key: <api-key>'import requests
url = "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons', 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.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/business-entities/{businessEntityId}/persons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"persons": [
{
"id": 12,
"firstName": "Jane",
"lastName": "Founder",
"dateOfBirth": "1990-04-18",
"email": "jane@acme.com",
"kycIds": [
{
"type": "US_SSN",
"name": "Social Security Number",
"value": "<string>",
"documentId": "<string>",
"doesNotHaveKYCId": true,
"decryptedValue": "<string>"
}
],
"residentialAddress": {
"addressLine1": "1 Raffles Place",
"city": "Singapore",
"country": "SG",
"addressLine2": "Suite 21045",
"addressLine3": "<string>",
"postalCode": "048616",
"state": "<string>"
},
"stakeholderId": "stk_123",
"phoneNumber": "+14155550123",
"sharePercentage": 75,
"governanceRelationships": {
"DIRECTOR": {
"startDate": "2020-01-15",
"endDate": null,
"isResidentDirector": true
},
"BENEFICIAL_OWNER": {
"isBeneficialOwner": true
}
},
"gender": "<string>",
"nationalities": [
"<string>"
],
"onboardingInfo": {},
"employmentStartDate": "<string>",
"directorIdentificationNumber": "00012345",
"jobTitle": [
"<string>"
],
"startDateOfEmployment": "2025-01-01",
"isResidentDirector": true
}
],
"count": 2
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}List people associated with a customer’s business entity.
Person responses include
residentialAddress as a top-level field. They do not include a person locations array; Location resources are business-entity addresses.Authorizations
Path Parameters
Commenda customer identifier.
Commenda business-entity identifier for the specified customer.
Was this page helpful?
⌘I