BasePerson

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "BasePerson",
  "description": "Base schema for a person associated with a merchant. This can be a legal representative, business owner (ultimate beneficial owner), or an officer. A legal representative is the person who registered the merchant with SumUp. They should always have a `user_id`.\n",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique identifier for the person. This is a [typeid](https://github.com/sumup/typeid).\n",
      "type": "string",
      "examples": [
        "pers_2EGQ057R6C8J791RVCG5NWAEAB"
      ],
      "readOnly": true
    },
    "user_id": {
      "description": "A corresponding identity user ID for the person, if they have a user account.\n",
      "type": "string",
      "examples": [
        "ef263f37-8701-4181-9758-acddbb778ee9"
      ]
    },
    "birthdate": {
      "description": "The date of birth of the individual, represented as an ISO 8601:2004 [ISO8601\u20112004] YYYY-MM-DD format.\n",
      "type": "string",
      "format": "date",
      "example": "1980-01-12"
    },
    "given_name": {
      "description": "The first name(s) of the individual.",
      "type": "string",
      "example": "James Herrald",
      "maxLength": 60
    },
    "family_name": {
      "description": "The last name(s) of the individual.",
      "type": "string",
      "example": "Bond",
      "maxLength": 60
    },
    "middle_name": {
      "description": "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.\n",
      "type": "string",
      "example": "Maria Sophie",
      "maxLength": 60
    },
    "phone_number": {
      "$ref": "#/components/schemas/PhoneNumber"
    },
    "relationships": {
      "description": "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`.\n",
      "type": "array",
      "items": {
        "type": "string",
        "description": "* `representative`: The person is the primary contact for SumUp and has full administrative power over the merchant account.\n* `owner`: The person is a business owner. If this value is set, the `ownership_percent` should be set as well.\n* `officer`: The person is an officer at the company.\n",
        "examples": [
          "representative",
          "owner",
          "officer"
        ]
      },
      "maxItems": 1,
      "minItems": 1
    },
    "ownership": {
      "$ref": "#/components/schemas/Ownership"
    },
    "address": {
      "$ref": "#/components/schemas/Address"
    },
    "identifiers": {
      "description": "A list of country-specific personal identifiers.\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PersonalIdentifier"
      },
      "maxItems": 5
    },
    "citizenship": {
      "$ref": "#/components/schemas/CountryCode"
    },
    "nationality": {
      "description": "The persons 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.\n",
      "type": "string",
      "nullable": true
    },
    "country_of_residence": {
      "description": "An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code representing the country where the person resides.\n",
      "type": "string",
      "maxLength": 2,
      "minLength": 2,
      "nullable": true
    },
    "version": {
      "$ref": "#/components/schemas/Version"
    },
    "change_status": {
      "$ref": "#/components/schemas/ChangeStatus"
    }
  },
  "externalDocs": {
    "description": "Person documentation",
    "url": "https://developer.sumup.com/tools/glossary/merchant#persons"
  },
  "required": [
    "id"
  ]
}