@sumup/sdk
    Preparing search index...

    Type Alias BasePerson

    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.

    Person documentation: https://developer.sumup.com/tools/models/merchant#persons

    type BasePerson = {
        address?: Address;
        birthdate?: string;
        change_status?: ChangeStatus;
        citizenship?: CountryCode;
        family_name?: string;
        given_name?: string;
        id: string;
        identifiers?: PersonalIdentifier[];
        middle_name?: string;
        ownership?: Ownership;
        phone_number?: PhoneNumber;
        relationships?: string[];
        user_id?: string;
        version?: Version;
    }
    Index

    Properties

    address? birthdate? change_status? citizenship? family_name? given_name? id identifiers? middle_name? ownership? phone_number? relationships? user_id? version?

    Properties

    address?: Address
    birthdate?: string

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

    change_status?: ChangeStatus
    citizenship?: CountryCode
    family_name?: string

    The last name(s) of the individual.

    given_name?: string

    The first name(s) of the individual.

    id: string

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

    identifiers?: PersonalIdentifier[]

    A list of country-specific personal identifiers.

    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.

    ownership?: Ownership
    phone_number?: PhoneNumber
    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.

    user_id?: string

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

    version?: Version

    Settings

    Member Visibility

    On This Page

    Properties