Class: Stripe::V2::Core::AccountPerson

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/core/account_person.rb

Overview

A Person represents an individual associated with an Account’s identity (for example, an owner, director, executive, or representative). Use Persons to provide and update identity information for verification and compliance.

Defined Under Namespace

Classes: AdditionalAddress, AdditionalName, AdditionalTermsOfService, Address, DateOfBirth, Documents, IdNumber, Relationship, ScriptAddresses, ScriptNames

Constant Summary collapse

OBJECT_NAME = 
"v2.core.account_person"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#account ⇒ Object (readonly)

The account ID which the individual belongs to.



412
413
414
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 412

def 
  @account
end

#additional_addresses ⇒ Object (readonly)

Additional addresses associated with the person.



414
415
416
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 414

def additional_addresses
  @additional_addresses
end

#additional_names ⇒ Object (readonly)

Additional names (e.g. aliases) associated with the person.



416
417
418
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 416

def additional_names
  @additional_names
end

#additional_terms_of_service ⇒ Object (readonly)

Attestations of accepted terms of service agreements.



418
419
420
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 418

def additional_terms_of_service
  @additional_terms_of_service
end

#address ⇒ Object (readonly)

The person’s residential address.



420
421
422
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 420

def address
  @address
end

#created ⇒ Object (readonly)

Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.



422
423
424
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 422

def created
  @created
end

#date_of_birth ⇒ Object (readonly)

The person’s date of birth.



424
425
426
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 424

def date_of_birth
  @date_of_birth
end

#documents ⇒ Object (readonly)

Documents that may be submitted to satisfy various informational requests.



426
427
428
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 426

def documents
  @documents
end

#email ⇒ Object (readonly)

The person’s email address.



428
429
430
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 428

def email
  @email
end

#given_name ⇒ Object (readonly)

The person’s first name.



430
431
432
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 430

def given_name
  @given_name
end

#id ⇒ Object (readonly)

Unique identifier for the Person.



432
433
434
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 432

def id
  @id
end

#id_numbers ⇒ Object (readonly)

The identification numbers (e.g., SSN) associated with the person.



434
435
436
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 434

def id_numbers
  @id_numbers
end

#legal_gender ⇒ Object (readonly)

The person’s gender (International regulations require either “male” or “female”).



436
437
438
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 436

def legal_gender
  @legal_gender
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



438
439
440
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 438

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

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.



440
441
442
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 440

def metadata
  @metadata
end

#nationalities ⇒ Object (readonly)

The countries where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).



442
443
444
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 442

def nationalities
  @nationalities
end

#object ⇒ Object (readonly)

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



444
445
446
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 444

def object
  @object
end

#phone ⇒ Object (readonly)

The person’s phone number.



446
447
448
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 446

def phone
  @phone
end

#political_exposure ⇒ Object (readonly)

The person’s political exposure.



448
449
450
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 448

def political_exposure
  @political_exposure
end

#relationship ⇒ Object (readonly)

The relationship that this person has with the Account’s business or legal entity.



450
451
452
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 450

def relationship
  @relationship
end

#script_addresses ⇒ Object (readonly)

The script addresses (e.g., non-Latin characters) associated with the person.



452
453
454
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 452

def script_addresses
  @script_addresses
end

#script_names ⇒ Object (readonly)

The script names (e.g. non-Latin characters) associated with the person.



454
455
456
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 454

def script_names
  @script_names
end

#surname ⇒ Object (readonly)

The person’s last name.



456
457
458
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 456

def surname
  @surname
end

#updated ⇒ Object (readonly)

Time at which the object was last updated. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.



458
459
460
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 458

def updated
  @updated
end

Class Method Details

.field_encodings ⇒ Object 



479
480
481
482
483
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 479

def self.field_encodings
  @field_encodings = {
    relationship: { kind: :object, fields: { percent_ownership: :decimal_string } },
  }
end

.field_remappings ⇒ Object 



475
476
477
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 475

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 460

def self.inner_class_types
  @inner_class_types = {
    additional_addresses: AdditionalAddress,
    additional_names: AdditionalName,
    additional_terms_of_service: AdditionalTermsOfService,
    address: Address,
    date_of_birth: DateOfBirth,
    documents: Documents,
    id_numbers: IdNumber,
    relationship: Relationship,
    script_addresses: ScriptAddresses,
    script_names: ScriptNames,
  }
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/v2/core/account_person.rb', line 10

def self.object_name
  "v2.core.account_person"
end