Mayson Monorepo Documentation
    Preparing search index...

    Interface Person

    interface Person {
        additional_tos_acceptances?: Stripe.TokenCreateParams.Person.AdditionalTosAcceptances;
        address?: AddressParam;
        address_kana?: JapanAddressParam;
        address_kanji?: JapanAddressParam;
        dob?: Emptyable<Stripe.TokenCreateParams.Person.Dob>;
        documents?: Stripe.TokenCreateParams.Person.Documents;
        email?: string;
        first_name?: string;
        first_name_kana?: string;
        first_name_kanji?: string;
        full_name_aliases?: Emptyable<string[]>;
        gender?: string;
        id_number?: string;
        id_number_secondary?: string;
        last_name?: string;
        last_name_kana?: string;
        last_name_kanji?: string;
        maiden_name?: string;
        metadata?: Emptyable<MetadataParam>;
        nationality?: string;
        phone?: string;
        political_exposure?: Stripe.TokenCreateParams.Person.PoliticalExposure;
        registered_address?: AddressParam;
        relationship?: Stripe.TokenCreateParams.Person.Relationship;
        ssn_last_4?: string;
        us_cfpb_data?: Stripe.TokenCreateParams.Person.UsCfpbData;
        verification?: Stripe.TokenCreateParams.Person.Verification;
    }
    Index

    Properties

    additional_tos_acceptances? address? address_kana? address_kanji? dob? documents? email? first_name? first_name_kana? first_name_kanji? full_name_aliases? gender? id_number? id_number_secondary? last_name? last_name_kana? last_name_kanji? maiden_name? metadata? nationality? phone? political_exposure? registered_address? relationship? ssn_last_4? us_cfpb_data? verification?

    Properties

    additional_tos_acceptances?: Stripe.TokenCreateParams.Person.AdditionalTosAcceptances

    Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.

    address?: AddressParam

    The person's address.

    address_kana?: JapanAddressParam

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

    address_kanji?: JapanAddressParam

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

    dob?: Emptyable<Stripe.TokenCreateParams.Person.Dob>

    The person's date of birth.

    documents?: Stripe.TokenCreateParams.Person.Documents

    Documents that may be submitted to satisfy various informational requests.

    email?: string

    The person's email address.

    first_name?: string

    The person's first name.

    first_name_kana?: string

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

    first_name_kanji?: string

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

    full_name_aliases?: Emptyable<string[]>

    A list of alternate names or aliases that the person is known by.

    gender?: string

    The person's gender (International regulations require either "male" or "female").

    id_number?: string

    The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.

    id_number_secondary?: string

    The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js.

    last_name?: string

    The person's last name.

    last_name_kana?: string

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

    last_name_kanji?: string

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

    maiden_name?: string

    The person's maiden name.

    metadata?: Emptyable<MetadataParam>

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    nationality?: string

    The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.

    phone?: string

    The person's phone number.

    political_exposure?: Stripe.TokenCreateParams.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?: AddressParam

    The person's registered address.

    relationship?: Stripe.TokenCreateParams.Person.Relationship

    The relationship that this person has with the account's legal entity.

    ssn_last_4?: string

    The last four digits of the person's Social Security number (U.S. only).

    us_cfpb_data?: Stripe.TokenCreateParams.Person.UsCfpbData

    Demographic data related to the person.

    verification?: Stripe.TokenCreateParams.Person.Verification

    The person's verification status.

    Settings

    Member Visibility

    On This Page

    Properties