Struct Person

pub struct Person {

    pub account: Option<String>,
    pub additional_tos_acceptances: Option<PersonAdditionalTosAcceptances>,
    pub address: Option<Address>,
    pub address_kana: Option<LegalEntityJapanAddress>,
    pub address_kanji: Option<LegalEntityJapanAddress>,
    pub created: Timestamp,
    pub dob: Option<LegalEntityDob>,
    pub email: Option<String>,
    pub first_name: Option<String>,
    pub first_name_kana: Option<String>,
    pub first_name_kanji: Option<String>,
    pub full_name_aliases: Option<Vec<String>>,
    pub future_requirements: Option<PersonFutureRequirements>,
    pub gender: Option<String>,
    pub id: PersonId,
    pub id_number_provided: Option<bool>,
    pub id_number_secondary_provided: Option<bool>,
    pub last_name: Option<String>,
    pub last_name_kana: Option<String>,
    pub last_name_kanji: Option<String>,
    pub maiden_name: Option<String>,
    pub metadata: Option<HashMap<String, String>>,
    pub nationality: Option<String>,
    pub phone: Option<String>,
    pub political_exposure: Option<PersonPoliticalExposure>,
    pub registered_address: Option<Address>,
    pub relationship: Option<PersonRelationship>,
    pub requirements: Option<PersonRequirements>,
    pub ssn_last_4_provided: Option<bool>,
    pub us_cfpb_data: Option<PersonUsCfpbData>,
    pub verification: Option<LegalEntityPersonVerification>,
}

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.

For more details see <https://stripe.com/docs/api/persons/object>.

Fields

account: Option<String>

The account the person is associated with.

additional_tos_acceptances: Option<PersonAdditionalTosAcceptances>

address: Option<Address>

address_kana: Option<LegalEntityJapanAddress>

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

address_kanji: Option<LegalEntityJapanAddress>

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

created: Timestamp

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

dob: Option<LegalEntityDob>

email: Option<String>

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

first_name: Option<String>

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

first_name_kana: Option<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: Option<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: Option<Vec<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: Option<PersonFutureRequirements>

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

gender: Option<String>

The person’s gender.

id: PersonId

Unique identifier for the object.

id_number_provided: Option<bool>

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: Option<bool>

Whether the person’s id_number_secondary was provided.

last_name: Option<String>

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

last_name_kana: Option<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: Option<String>

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

maiden_name: Option<String>

The person’s maiden name.

metadata: Option<HashMap<String, String>>

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: Option<String>

The country where the person is a national.

phone: Option<String>

The person’s phone number.

political_exposure: Option<PersonPoliticalExposure>

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: Option<Address>

relationship: Option<PersonRelationship>

requirements: Option<PersonRequirements>

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

ssn_last_4_provided: Option<bool>

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

us_cfpb_data: Option<PersonUsCfpbData>

Demographic data related to the person.

verification: Option<LegalEntityPersonVerification>

Trait Implementations

impl Clone for Person

fn clone(&self) -> Person

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Person

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize for Person

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for Person

fn from_value(v: Value) -> Option<Self>

impl Object for Person

type Id = PersonId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for Person

type Builder = PersonBuilder