Merchants

Returns a single Person related to a Merchant.

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

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v1/merchants/{merchant_code}/persons/{person_id}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.sumup.com/authorize
      Token URL: https://api.sumup.com/token scopes: user.profile, user.profile_readonly

Path parameters

merchant_codestring required
Example:MK10CL2A

Short unique identifier for the merchant.

person_idstring required
Example:pers_5AKFHN2KSK8D3TS79DJE3P3A2Z

Person ID

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.

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

{
  "id": "pers_2EGQ057R6C8J791RVCG5NWAEAB",
  "user_id": "ef263f37-8701-4181-9758-acddbb778ee9",
  "birthdate": "1980-01-12",
  "given_name": "Sofia",
  "family_name": "Rossi",
  "phone_number": "+420123456789",
  "relationships": [
    "representative"
  ],
  "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",
  "version": "chng_01HS0KG3MPVEVWW85E3KNXH55J"
}

Changes

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to string for status

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to string for status

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      removed subschema #1 from the //// response property allOf list for the response status

    • info

      removed subschema #1 from the //// response property allOf list for the response status

    • info

      removed subschema #1 from the //// response property allOf list for the response status

    • info

      removed subschema #1 from the //// response property allOf list for the response status

    • info

      the //// response's property pattern ^[A-Z]{2}$ was added for the status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status

    • breaking

      the //// response property's maxLength was unset from 2 for the response status

    • breaking

      the //// response property's maxLength was unset from 16 for the response status

    • breaking

      the //// response property's minLength was decreased from 2 to 0 for the response status

    • breaking

      the //// response's property type changed from object to no type for status

    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      the //// response's property type changed from object to no type for status

    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • info

      added subschema #1 to the //// response property allOf list for the response status

    • info

      added subschema #1 to the //// response property allOf list for the response status

    • info

      added subschema #1 to the //// response property allOf list for the response status

    • info

      added subschema #1 to the //// response property allOf list for the response status

    • info

      the //// response's property pattern ^[A-Z]{2}$ was removed for the status