class Stripe::Person

• Stripe::Person
• Reference
• Object

Overview

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.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

stripe/models/person.cr

Constant Summary

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(*, 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 Method Summary

• #==(other : self)

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

• #account : String | Nil
• #account=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #address_kana_present=(address_kana_present : Bool)
• #address_kana_present? : Bool
• #address_kanji : Stripe::PersonAddressKanji | Nil
• #address_kanji=(new_value : Stripe::PersonAddressKanji | Nil)

  Custom attribute writer method checking allowed values (enum).

• #address_kanji_present=(address_kanji_present : Bool)
• #address_kanji_present? : Bool
• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #email : String | Nil
• #email=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #email_present=(email_present : Bool)
• #email_present? : Bool
• #first_name : String | Nil
• #first_name=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #first_name_kana : String | Nil
• #first_name_kana=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #first_name_kana_present=(first_name_kana_present : Bool)
• #first_name_kana_present? : Bool
• #first_name_kanji : String | Nil
• #first_name_kanji=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #first_name_kanji_present=(first_name_kanji_present : Bool)
• #first_name_kanji_present? : Bool
• #first_name_present=(first_name_present : Bool)
• #first_name_present? : Bool
• #full_name_aliases : Array(String) | Nil
• #full_name_aliases=(new_value : Array(String) | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #future_requirements_present=(future_requirements_present : Bool)
• #future_requirements_present? : Bool
• #gender : String | Nil
• #gender=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #gender_present=(gender_present : Bool)
• #gender_present? : Bool
• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #id_number_provided : Bool | Nil
• #id_number_provided=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #id_number_secondary_provided : Bool | Nil
• #id_number_secondary_provided=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #last_name : String | Nil
• #last_name=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #last_name_kana : String | Nil
• #last_name_kana=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #last_name_kana_present=(last_name_kana_present : Bool)
• #last_name_kana_present? : Bool
• #last_name_kanji : String | Nil
• #last_name_kanji=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #last_name_kanji_present=(last_name_kanji_present : Bool)
• #last_name_kanji_present? : Bool
• #last_name_present=(last_name_present : Bool)
• #last_name_present? : Bool
• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #maiden_name : String | Nil
• #maiden_name=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #maiden_name_present=(maiden_name_present : Bool)
• #maiden_name_present? : Bool
• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #nationality : String | Nil
• #nationality=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #nationality_present=(nationality_present : Bool)
• #nationality_present? : Bool
• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #phone : String | Nil
• #phone=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #phone_present=(phone_present : Bool)
• #phone_present? : Bool
• #political_exposure : String | Nil
• #political_exposure=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #requirements_present=(requirements_present : Bool)
• #requirements_present? : Bool
• #ssn_last_4_provided : Bool | Nil
• #ssn_last_4_provided=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

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

  Custom attribute writer method checking allowed values (enum).

Constructor Detail

Instance Method Detail