Skip to main content
GET
/
partner
/
commenda-os
/
customers
/
{customerId}
/
persons
List persons for a customer
curl --request GET \
  --url https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/{customerId}/persons \
  --header 'x-api-key: <api-key>'
{
  "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",
      "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"
    }
  ],
  "count": 2
}
List people for one of your customers across their business entities. If the person you need does not exist yet, create them with Create a person. Person responses include residentialAddress as a top-level field. They do not include a person locations array; Location resources are business-entity addresses.

Authorizations

x-api-key
string
header
required

Path Parameters

customerId
integer
required

Commenda customer identifier.

Response

Persons retrieved successfully

persons
object[]
required
count
integer
required
Example:

2