v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB

Merchants

List People for Merchant

get/v1/merchants/{merchant-id}/people

Path parameters

merchant-idstring required

Unique identifier for the merchant

Example:MERCHANTID456

Response

List of People associated with the merchant

relationshipType'DIRECTOR' | 'ULTIMATE_BENEFICIAL_OWNER' required

The relationship type of the person in relation to the business (e.g., DIRECTOR, ULTIMATE_BENEFICIAL_OWNER)

Example response

[
  {
    "relationshipType": "ULTIMATE_BENEFICIAL_OWNER",
    "person": {
      "id": "person_abcdefghijklmno123456",
      "externalPersonReference": "REF123",
      "firstName": "John",
      "lastName": "Doe",
      "address": {
        "street": "123 Main St",
        "city": "Anytown",
        "region": "CA",
        "postalCode": "12345",
        "country": "US"
      },
      "birthDate": "2000-01-01",
      "email": "john.doe@ppro.com",
      "createdAt": "2023-01-01T00:00:00Z",
      "updatedAt": "2023-01-01T00:00:00Z"
    }
  }
]