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"
}

Changes

Changed in 8 of the 53 revisions of this API.525

Jun 18, 202689d32e0b22e222See the full diff
- ▲
  the allOf[BasePerson]/identifiers/items/value response property's maxLength was increased from 30 to 128 for the response status 200
  response-property-max-length-increased
- ▲
  the allOf[BasePerson]/address/street_address response property's minItems was decreased from 1 to 0 for the response status 200
  response-property-min-items-decreased
- ○
  the allOf[BasePerson]/address/country response's property pattern ^[A-Z]{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the allOf[BasePerson]/citizenship response's property pattern ^[A-Z]{2}$ was added for the status 200
  response-property-pattern-added
Apr 27, 2026b54086fdb4cc12See the full diff
- ▲
  the allOf[BasePerson]/identifiers/items/ref response property's maxLength was unset from 32 for the response status 200
  response-property-max-length-unset
- ○
  the allOf[BasePerson]/address/country response's property pattern ^[A-Z]{2}$ was removed for the status 200
  response-property-pattern-removed
- ○
  the allOf[BasePerson]/citizenship response's property pattern ^[A-Z]{2}$ was removed for the status 200
  response-property-pattern-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 13, 2026d06724d996eb1See the full diff
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 19, 202662e8baa4ac73214See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 404
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ○
  removed BaseError subschema #2 from the response body allOf list for the response status 404
  response-body-all-of-removed
- ○
  removed BaseError subschema #2 from the response body allOf list for the response status 500
  response-body-all-of-removed
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 404
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 500
  response-media-type-name-specialized
- ○
  added the optional property detail to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property detail to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property instance to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property instance to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property title to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property title to the response with the 500 status
  response-optional-property-added
- ○
  added the required property type to the response with the 404 status
  response-required-property-added
- ○
  added the required property type to the response with the 500 status
  response-required-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 7, 20265818ed9898e12See the full diff
- ○
  the allOf[BasePerson]/address/country response's property pattern ^[A-Z]{2}$ was added for the status 200
  response-property-pattern-added
- ○
  the allOf[BasePerson]/citizenship response's property pattern ^[A-Z]{2}$ was added for the status 200
  response-property-pattern-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 12, 2025d32eef8a3bd21See the full diff
- ○
  the security scope merchant.read was removed from the endpoint's security scheme oauth2
  api-security-scope-removed
Nov 6, 2025cf6aa1c164472See the full diff
- ○
  added the optional property allOf[BasePerson]/country_of_residence to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[BasePerson]/nationality to the response with the 200 status
  response-optional-property-added
Oct 29, 20254dc4b073a6a91See the full diff
- ○
  endpoint added
  endpoint-added

Full history