Update a person
curl --request PATCH \
--url https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "Jane",
"lastName": "Founder",
"email": "jane@acme.com",
"dateOfBirth": "1990-04-18",
"countryOfCitizenship": "SG",
"residentialAddress": {
"addressLine1": "1 Raffles Place",
"city": "Singapore",
"postalCode": "048616",
"country": "SG"
}
}
'import requests
url = "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId}"
payload = {
"firstName": "Jane",
"lastName": "Founder",
"email": "jane@acme.com",
"dateOfBirth": "1990-04-18",
"countryOfCitizenship": "SG",
"residentialAddress": {
"addressLine1": "1 Raffles Place",
"city": "Singapore",
"postalCode": "048616",
"country": "SG"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: 'Jane',
lastName: 'Founder',
email: 'jane@acme.com',
dateOfBirth: '1990-04-18',
countryOfCitizenship: 'SG',
residentialAddress: {
addressLine1: '1 Raffles Place',
city: 'Singapore',
postalCode: '048616',
country: 'SG'
}
})
};
fetch('https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId}', 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}/persons/{personId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => 'Jane',
'lastName' => 'Founder',
'email' => 'jane@acme.com',
'dateOfBirth' => '1990-04-18',
'countryOfCitizenship' => 'SG',
'residentialAddress' => [
'addressLine1' => '1 Raffles Place',
'city' => 'Singapore',
'postalCode' => '048616',
'country' => 'SG'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId}"
payload := strings.NewReader("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Founder\",\n \"email\": \"jane@acme.com\",\n \"dateOfBirth\": \"1990-04-18\",\n \"countryOfCitizenship\": \"SG\",\n \"residentialAddress\": {\n \"addressLine1\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<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.patch("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Founder\",\n \"email\": \"jane@acme.com\",\n \"dateOfBirth\": \"1990-04-18\",\n \"countryOfCitizenship\": \"SG\",\n \"residentialAddress\": {\n \"addressLine1\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"Jane\",\n \"lastName\": \"Founder\",\n \"email\": \"jane@acme.com\",\n \"dateOfBirth\": \"1990-04-18\",\n \"countryOfCitizenship\": \"SG\",\n \"residentialAddress\": {\n \"addressLine1\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n }\n}"
response = http.request(request)
puts response.read_body{
"person": {
"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",
"businessEntitiesInfo": [
{
"businessEntityId": 44,
"businessEntityName": "Acme Holdings LLC",
"sharePercentage": 75,
"governanceRelationships": {
"DIRECTOR": {
"startDate": "2020-01-15",
"endDate": null,
"isResidentDirector": true
},
"BENEFICIAL_OWNER": {
"isBeneficialOwner": true
}
},
"jobTitle": [
"<string>"
],
"startDateOfEmployment": "2025-01-01",
"isResidentDirector": true
}
],
"gender": "<string>",
"nationalities": [
"<string>"
],
"onboardingInfo": {},
"employmentStartDate": "2025-01-01",
"directorIdentificationNumber": "00012345"
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Persons
Update a person
Partially update a reusable Commenda OS person. Omitted fields are left unchanged. For Singapore residential address requirements, include residentialAddress.
PATCH
/
partner
/
commenda-os
/
customers
/
{customerId}
/
persons
/
{personId}
Update a person
curl --request PATCH \
--url https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "Jane",
"lastName": "Founder",
"email": "jane@acme.com",
"dateOfBirth": "1990-04-18",
"countryOfCitizenship": "SG",
"residentialAddress": {
"addressLine1": "1 Raffles Place",
"city": "Singapore",
"postalCode": "048616",
"country": "SG"
}
}
'import requests
url = "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId}"
payload = {
"firstName": "Jane",
"lastName": "Founder",
"email": "jane@acme.com",
"dateOfBirth": "1990-04-18",
"countryOfCitizenship": "SG",
"residentialAddress": {
"addressLine1": "1 Raffles Place",
"city": "Singapore",
"postalCode": "048616",
"country": "SG"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: 'Jane',
lastName: 'Founder',
email: 'jane@acme.com',
dateOfBirth: '1990-04-18',
countryOfCitizenship: 'SG',
residentialAddress: {
addressLine1: '1 Raffles Place',
city: 'Singapore',
postalCode: '048616',
country: 'SG'
}
})
};
fetch('https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId}', 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}/persons/{personId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => 'Jane',
'lastName' => 'Founder',
'email' => 'jane@acme.com',
'dateOfBirth' => '1990-04-18',
'countryOfCitizenship' => 'SG',
'residentialAddress' => [
'addressLine1' => '1 Raffles Place',
'city' => 'Singapore',
'postalCode' => '048616',
'country' => 'SG'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId}"
payload := strings.NewReader("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Founder\",\n \"email\": \"jane@acme.com\",\n \"dateOfBirth\": \"1990-04-18\",\n \"countryOfCitizenship\": \"SG\",\n \"residentialAddress\": {\n \"addressLine1\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<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.patch("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Founder\",\n \"email\": \"jane@acme.com\",\n \"dateOfBirth\": \"1990-04-18\",\n \"countryOfCitizenship\": \"SG\",\n \"residentialAddress\": {\n \"addressLine1\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons/{personId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"Jane\",\n \"lastName\": \"Founder\",\n \"email\": \"jane@acme.com\",\n \"dateOfBirth\": \"1990-04-18\",\n \"countryOfCitizenship\": \"SG\",\n \"residentialAddress\": {\n \"addressLine1\": \"1 Raffles Place\",\n \"city\": \"Singapore\",\n \"postalCode\": \"048616\",\n \"country\": \"SG\"\n }\n}"
response = http.request(request)
puts response.read_body{
"person": {
"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",
"businessEntitiesInfo": [
{
"businessEntityId": 44,
"businessEntityName": "Acme Holdings LLC",
"sharePercentage": 75,
"governanceRelationships": {
"DIRECTOR": {
"startDate": "2020-01-15",
"endDate": null,
"isResidentDirector": true
},
"BENEFICIAL_OWNER": {
"isBeneficialOwner": true
}
},
"jobTitle": [
"<string>"
],
"startDateOfEmployment": "2025-01-01",
"isResidentDirector": true
}
],
"gender": "<string>",
"nationalities": [
"<string>"
],
"onboardingInfo": {},
"employmentStartDate": "2025-01-01",
"directorIdentificationNumber": "00012345"
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Partially update a reusable Commenda OS person for one of your customers.
Omitted fields are left unchanged. The response returns the updated person.
Use incorporation participant and document endpoints for incorporation-specific roles and documents.
This stores the address on the person. Person read responses return it as the top-level
Residential address
Some incorporation requirements validate fields on the referenced person resource. For Singapore individual directors and shareholders,participants.{participantId}.resource.residentialAddress is satisfied by updating the referenced person with the top-level residentialAddress field.
{
"residentialAddress": {
"addressLine1": "1 Raffles Place",
"city": "Singapore",
"postalCode": "048616",
"country": "SG"
}
}
residentialAddress field. It does not create a Commenda OS Location; Location resources are business-entity addresses, such as a partner-provided registered office address.Authorizations
Path Parameters
Commenda customer identifier.
Commenda OS person identifier for the specified customer.
Body
application/json
Partial update payload for a reusable Commenda OS person. Omitted fields are left unchanged.
Example:
"Jane"
Example:
"Founder"
Example:
"jane@acme.com"
Example:
"+14155550123"
Person residential address. Use this for participant resource requirements such as participants.{participantId}.resource.residentialAddress.
Show child attributes
Show child attributes
Example:
"2025-01-01"
Example:
"1990-04-18"
Example:
"SG"
SSN or ITIN, when applicable.
Example:
"123-45-6789"
Example:
false
Director Identification Number (DIN) assigned to Indian directors.
Example:
"00012345"
Response
Person updated successfully
Show child attributes
Show child attributes
Was this page helpful?
⌘I