class

Stripe::Person

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

This is an object representing a person associated with a Stripe account. A platform cannot access 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.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [person]."

ERROR_MESSAGE_FOR_POLITICAL_EXPOSURE = "invalid value for \"political_exposure\", must be one of [existing, none]."

MAX_LENGTH_FOR_ACCOUNT = 5000

MAX_LENGTH_FOR_EMAIL = 5000

MAX_LENGTH_FOR_FIRST_NAME = 5000

MAX_LENGTH_FOR_FIRST_NAME_KANA = 5000

MAX_LENGTH_FOR_FIRST_NAME_KANJI = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_LAST_NAME = 5000

MAX_LENGTH_FOR_LAST_NAME_KANA = 5000

MAX_LENGTH_FOR_LAST_NAME_KANJI = 5000

MAX_LENGTH_FOR_MAIDEN_NAME = 5000

MAX_LENGTH_FOR_NATIONALITY = 5000

MAX_LENGTH_FOR_PHONE = 5000

VALID_VALUES_FOR_OBJECT = String.static_array("person")

VALID_VALUES_FOR_POLITICAL_EXPOSURE = String.static_array("existing", "none")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, created : Int64 | Nil = nil, id : String | Nil = nil, object : String | Nil = nil, account : String | Nil = nil, additional_tos_acceptances : Stripe::PersonAdditionalTosAcceptances | Nil = nil, address : Stripe::Address | Nil = nil, address_kana : Stripe::PersonAddressKana | Nil = nil, address_kanji : Stripe::PersonAddressKanji | Nil = nil, dob : Stripe::LegalEntityDob | Nil = nil, email : String | Nil = nil, first_name : String | Nil = nil, first_name_kana : String | Nil = nil, first_name_kanji : String | Nil = nil, full_name_aliases : Array(String) | Nil = nil, future_requirements : Stripe::PersonFutureRequirements1 | Nil = nil, gender : String | Nil = nil, id_number_provided : Bool | Nil = nil, id_number_secondary_provided : Bool | Nil = nil, last_name : String | Nil = nil, last_name_kana : String | Nil = nil, last_name_kanji : String | Nil = nil, maiden_name : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, nationality : String | Nil = nil, phone : String | Nil = nil, political_exposure : String | Nil = nil, registered_address : Stripe::Address | Nil = nil, relationship : Stripe::PersonRelationship | Nil = nil, requirements : Stripe::PersonRequirements1 | Nil = nil, ssn_last_4_provided : Bool | Nil = nil, verification : Stripe::LegalEntityPersonVerification | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

account

The account the person is associated with.

account=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] account Object to be assigned

additional_tos_acceptances

additional_tos_acceptances=(new_value : Stripe::PersonAdditionalTosAcceptances | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] additional_tos_acceptances Object to be assigned

address

address=(new_value : Stripe::Address | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] address Object to be assigned

address_kana

address_kana=(new_value : Stripe::PersonAddressKana | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] address_kana Object to be assigned

address_kana_present=(address_kana_present : Bool)

address_kana_present?

address_kanji

address_kanji=(new_value : Stripe::PersonAddressKanji | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] address_kanji Object to be assigned

address_kanji_present=(address_kanji_present : Bool)

address_kanji_present?

created

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

created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

dob

dob=(new_value : Stripe::LegalEntityDob | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] dob Object to be assigned

email

The person's email address.

email=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] email Object to be assigned

email_present=(email_present : Bool)

email_present?

first_name

The person's first name.

first_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] first_name Object to be assigned

first_name_kana

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

first_name_kana=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] first_name_kana Object to be assigned

first_name_kana_present=(first_name_kana_present : Bool)

first_name_kana_present?

first_name_kanji

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

first_name_kanji=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] first_name_kanji Object to be assigned

first_name_kanji_present=(first_name_kanji_present : Bool)

first_name_kanji_present?

first_name_present=(first_name_present : Bool)

first_name_present?

full_name_aliases

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

full_name_aliases=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] full_name_aliases Object to be assigned

future_requirements

future_requirements=(new_value : Stripe::PersonFutureRequirements1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] future_requirements Object to be assigned

future_requirements_present=(future_requirements_present : Bool)

future_requirements_present?

gender

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

gender=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] gender Object to be assigned

gender_present=(gender_present : Bool)

gender_present?

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

id_number_provided

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_provided=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id_number_provided Object to be assigned

id_number_secondary_provided

Whether the person's id_number_secondary was provided.

id_number_secondary_provided=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id_number_secondary_provided Object to be assigned

last_name

The person's last name.

last_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last_name Object to be assigned

last_name_kana

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

last_name_kana=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last_name_kana Object to be assigned

last_name_kana_present=(last_name_kana_present : Bool)

last_name_kana_present?

last_name_kanji

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

last_name_kanji=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last_name_kanji Object to be assigned

last_name_kanji_present=(last_name_kanji_present : Bool)

last_name_kanji_present?

last_name_present=(last_name_present : Bool)

last_name_present?

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

maiden_name

The person's maiden name.

maiden_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] maiden_name Object to be assigned

maiden_name_present=(maiden_name_present : Bool)

maiden_name_present?

metadata

metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

nationality

The country where the person is a national.

nationality=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] nationality Object to be assigned

nationality_present=(nationality_present : Bool)

nationality_present?

object

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

object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

phone

The person's phone number.

phone=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] phone Object to be assigned

phone_present=(phone_present : Bool)

phone_present?

political_exposure

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.

political_exposure=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] political_exposure Object to be assigned

registered_address

registered_address=(new_value : Stripe::Address | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] registered_address Object to be assigned

relationship

relationship=(new_value : Stripe::PersonRelationship | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] relationship Object to be assigned

requirements

requirements=(new_value : Stripe::PersonRequirements1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] requirements Object to be assigned

requirements_present=(requirements_present : Bool)

requirements_present?

ssn_last_4_provided

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

ssn_last_4_provided=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ssn_last_4_provided Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

verification

verification=(new_value : Stripe::LegalEntityPersonVerification | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] verification Object to be assigned