--- title: "List Persons" method: GET path: "/v1/merchants/{merchant_code}/persons" tags: ["Merchants"] --- # List Persons `GET /v1/merchants/{merchant_code}/persons` Returns the Persons related to a Merchant. ## Path parameters - `merchant_code` string, required ## Query parameters - `version` string ## Response `200` Returns a list of Persons for a valid Merchant identifier. - ListPersonsResponseBody - `items` Person[], required - `id` string, required — The unique identifier for the Person. This is a [typeid](https://github.com/sumup/typeid). - `user_id` string — A corresponding identity user ID for the Person, if they have a user account. - `birthdate` string, date — The date of birth of the individual, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. - `given_name` string — The first name(s) of the individual. - `family_name` string — The last name(s) of the individual. - `middle_name` string — Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used. - `phone_number` string — A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. - `relationships` string[] — A list of roles the Person has in the Merchant or towards SumUp. A Merchant must have at least one Person with the relationship `representative`. - `ownership` Ownership - `share` integer, required — The percent of ownership shares held by the Person expressed in percent mille (1/100000). Only Persons with the relationship `owner` can have ownership. - `address` Address — An address somewhere in the world. The address fields used depend on the country conventions. For example, in Great Britain, `city` is `post_town`. In the United States, the top-level administrative unit used in addresses is `state`, whereas in Chile it's `region`. Whether an address is valid or not depends on whether the locally required fields are present. Fields not supported in a country will be ignored. - `street_address` string[] - `post_code` string — The postal code (aka. zip code) of the address. - `country` string, required — An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This definition users `oneOf` with a two-character string type to allow for support of future countries in client code. - `city` string — The city of the address. - `province` string — The province where the address is located. This may not be relevant in some countries. - `region` string — The region where the address is located. This may not be relevant in some countries. - `county` string — A county is a geographic region of a country used for administrative or other purposes in some nations. Used in countries such as Ireland, Romania, etc. - `autonomous_community` string — In Spain, an autonomous community is the first sub-national level of political and administrative division. - `post_town` string — A post town is a required part of all postal addresses in the United Kingdom and Ireland, and a basic unit of the postal delivery system. - `state` string — Most often, a country has a single state, with various administrative divisions. The term "state" is sometimes used to refer to the federated polities that make up the federation. Used in countries such as the United States and Brazil. - `neighborhood` string — Locality level of the address. Used in countries such as Brazil or Chile. - `commune` string — In many countries, terms cognate with "commune" are used, referring to the community living in the area and the common interest. Used in countries such as Chile. - `department` string — A department (French: département, Spanish: departamento) is an administrative or political division in several countries. Used in countries such as Colombia. - `municipality` string — A municipality is usually a single administrative division having corporate status and powers of self-government or jurisdiction as granted by national and regional laws to which it is subordinate. Used in countries such as Colombia. - `district` string — A district is a type of administrative division that in some countries is managed by the local government. Used in countries such as Portugal. - `zip_code` string — A US system of postal codes used by the United States Postal Service (USPS). - `eircode` string — A postal address in Ireland. - `identifiers` PersonalIdentifier[] — A list of country-specific personal identifiers. - `ref` string, required — The unique reference for the personal identifier type. - `value` string, required — The company identifier value. - `citizenship` string — An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This definition users `oneOf` with a two-character string type to allow for support of future countries in client code. - `nationality` string, nullable — The Person's nationality. May be an [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code, but legacy data may not conform to this standard. - `country_of_residence` string, nullable — An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code representing the country where the Person resides. - `version` string — The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH` endpoints. - `change_status` string — Reflects the status of changes submitted through the `PATCH` endpoints for the Merchant or Persons. If some changes have not been applied yet, the status will be `pending`. If all changes have been applied, the status `done`. The status is only returned after write operations or on read endpoints when the `version` query parameter is provided. ## Other responses - `404` — The requested Merchant does not exist. --- [API](https://skmtc.net/sumup/apis/sumup-rest-api.md) · [All operations](https://skmtc.net/sumup/apis/sumup-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumup/sumup-rest-api/revisions/f50e1dc97523/schema)