Sign in

v50

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-0342108400.9 KB
Merchants

Get Person

Returns a single Person related to a Merchant.

get/v1/merchants/{merchant_code}/persons/{person_id}

Path parameters

merchant_codestring required
Example:MK10CL2A

Short unique identifier for the merchant.

person_idstring required
Example:pers_5AKFHN2KSK8D3TS79DJE3P3A2Z

Person ID

Query parameters

versionstring

The version of the resource. At the moment, the only supported value is latest. When provided and the requested resource's change_status is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The change_status in the response body will reflect the current state of the resource.

Response

Returns a Person for a valid identifier.

idstring required

The unique identifier for the Person. This is a typeid.

user_idstring

A corresponding identity user ID for the Person, if they have a user account.

birthdatestring date

The date of birth of the individual, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.

given_namestring

The first name(s) of the individual.

family_namestring

The last name(s) of the individual.

middle_namestring

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_numberstring

A publicly available phone number in E.164 format.

relationshipsstring[]

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.

citizenshipstring

An ISO3166-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.

nationalitystring nullable

The Person's nationality. May be an ISO3166-1 alpha-2 country code, but legacy data may not conform to this standard.

country_of_residencestring nullable

An ISO3166-1 alpha-2 country code representing the country where the Person resides.

versionstring

The version of the resource. The version reflects a specific change submitted to the API via one of the PATCH endpoints.

change_statusstring

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.

Example response

{
  "birthdate": "1980-01-12T00:00:00Z",
  "given_name": "James Herrald",
  "family_name": "Bond",
  "middle_name": "Maria Sophie",
  "phone_number": "+420123456789",
  "ownership": {
    "share": 50000
  },
  "address": {
    "street_address": [
      "Paul-Linke-Ufer 39-40",
      "2. Hinterhof"
    ],
    "post_code": "10999",
    "city": "Berlin",
    "country": "DE"
  },
  "identifiers": [
    {
      "ref": "br.cpf",
      "value": "847.060.136-90"
    }
  ],
  "citizenship": "BR"
}