Mayson Monorepo Documentation
    Preparing search index...

    Interface Person

    This is an object representing a person associated with a Stripe account.

    A platform can only access a subset of data in a person for an account where account.controller.requirement_collection is stripe, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.

    See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.

    interface Person {
        id: string;
        object: "person";
        account: string;
        additional_tos_acceptances?: Stripe.Person.AdditionalTosAcceptances;
        address?: Stripe.Address;
        address_kana?: Stripe.Person.AddressKana;
        address_kanji?: Stripe.Person.AddressKanji;
        created: number;
        deleted?: void;
        dob?: Stripe.Person.Dob;
        email?: string;
        first_name?: string;
        first_name_kana?: string;
        first_name_kanji?: string;
        full_name_aliases?: string[];
        future_requirements?: Stripe.Person.FutureRequirements;
        gender?: string;
        id_number_provided?: boolean;
        id_number_secondary_provided?: boolean;
        last_name?: string;
        last_name_kana?: string;
        last_name_kanji?: string;
        maiden_name?: string;
        metadata?: Metadata;
        nationality?: string;
        phone?: string;
        political_exposure?: Stripe.Person.PoliticalExposure;
        registered_address?: Stripe.Address;
        relationship?: Stripe.Person.Relationship;
        requirements?: Stripe.Person.Requirements;
        ssn_last_4_provided?: boolean;
        us_cfpb_data?: Stripe.Person.UsCfpbData;
        verification?: Stripe.Person.Verification;
    }
    Index

    Properties

    id object account additional_tos_acceptances? address? address_kana? address_kanji? created deleted? dob? email? first_name? first_name_kana? first_name_kanji? full_name_aliases? future_requirements? gender? id_number_provided? id_number_secondary_provided? last_name? last_name_kana? last_name_kanji? maiden_name? metadata? nationality? phone? political_exposure? registered_address? relationship? requirements? ssn_last_4_provided? us_cfpb_data? verification?

    Properties

    id: string

    Unique identifier for the object.

    object: "person"

    String representing the object's type. Objects of the same type share the same value.

    account: string

    The account the person is associated with.

    additional_tos_acceptances?: Stripe.Person.AdditionalTosAcceptances
    address?: Stripe.Address
    address_kana?: Stripe.Person.AddressKana

    The Kana variation of the person's address (Japan only).

    address_kanji?: Stripe.Person.AddressKanji

    The Kanji variation of the person's address (Japan only).

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    deleted?: void

    Always true for a deleted object

    dob?: Stripe.Person.Dob
    email?: string

    The person's email address. Also available for accounts where controller.requirement_collection is stripe.

    first_name?: string

    The person's first name. Also available for accounts where controller.requirement_collection is stripe.

    first_name_kana?: string

    The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

    first_name_kanji?: string

    The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

    full_name_aliases?: string[]

    A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.

    future_requirements?: Stripe.Person.FutureRequirements

    Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.

    gender?: string

    The person's gender.

    id_number_provided?: boolean

    Whether the person's id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by ssn_last_4_provided).

    id_number_secondary_provided?: boolean

    Whether the person's id_number_secondary was provided.

    last_name?: string

    The person's last name. Also available for accounts where controller.requirement_collection is stripe.

    last_name_kana?: string

    The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

    last_name_kanji?: string

    The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

    maiden_name?: string

    The person's maiden name.

    metadata?: Metadata

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    nationality?: string

    The country where the person is a national.

    phone?: string

    The person's phone number.

    political_exposure?: Stripe.Person.PoliticalExposure

    Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.

    registered_address?: Stripe.Address
    relationship?: Stripe.Person.Relationship
    requirements?: Stripe.Person.Requirements

    Information about the requirements for this person, including what information needs to be collected, and by when.

    ssn_last_4_provided?: boolean

    Whether the last four digits of the person's Social Security number have been provided (U.S. only).

    us_cfpb_data?: Stripe.Person.UsCfpbData

    Demographic data related to the person.

    verification?: Stripe.Person.Verification

    Settings

    Member Visibility

    On This Page

    Properties