exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Person (exoapi_stripe v0.1.4)

description: This is an object representing a person associated with a Stripe account.

A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the Standard onboarding or Express onboarding documentation for information about platform pre-filling and account onboarding steps.

Related guide: Handling Identity Verification with the API.

:account :: ExOAPI.Stripe.Schemas.Account

The account the person is associated with.

:address :: ExOAPI.Stripe.Schemas.Address

:address_kana :: ExOAPI.Stripe.Schemas.LegalEntityJapanAddress

:address_kanji :: ExOAPI.Stripe.Schemas.LegalEntityJapanAddress

:created :: :integer

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

:dob :: ExOAPI.Stripe.Schemas.LegalEntityDob

: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 :: :string

:future_requirements :: ExOAPI.Stripe.Schemas.PersonFutureRequirements

:gender :: :string

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

:id :: :string

Unique identifier for the object.

:id_number_provided :: :boolean

Whether the person's id_number was provided.

: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 :: :map

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 :: :string

The country where the person is a national.

:object :: :string

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

:phone :: :string

The person's phone number.

:political_exposure :: :string

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.

:relationship :: ExOAPI.Stripe.Schemas.PersonRelationship

:requirements :: ExOAPI.Stripe.Schemas.PersonRequirements

:ssn_last_4_provided :: :boolean

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

:verification :: ExOAPI.Stripe.Schemas.LegalEntityPersonVerification

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Person{
  account: String.t() | nil,
  address: ExOAPI.Stripe.Schemas.Address.t() | nil,
  address_kana: ExOAPI.EctoTypes.AnyOf.t() | nil,
  address_kanji: ExOAPI.EctoTypes.AnyOf.t() | nil,
  created: integer() | nil,
  dob: ExOAPI.Stripe.Schemas.LegalEntityDob.t() | nil,
  email: String.t() | nil,
  first_name: String.t() | nil,
  first_name_kana: String.t() | nil,
  first_name_kanji: String.t() | nil,
  full_name_aliases: [String.t()] | nil,
  future_requirements: ExOAPI.EctoTypes.AnyOf.t() | nil,
  gender: String.t() | nil,
  id: String.t() | nil,
  id_number_provided: boolean() | nil,
  last_name: String.t() | nil,
  last_name_kana: String.t() | nil,
  last_name_kanji: String.t() | nil,
  maiden_name: String.t() | nil,
  metadata: map() | nil,
  nationality: String.t() | nil,
  object: :person | nil,
  phone: String.t() | nil,
  political_exposure: (:none | :existing) | nil,
  relationship: ExOAPI.Stripe.Schemas.PersonRelationship.t() | nil,
  requirements: ExOAPI.EctoTypes.AnyOf.t() | nil,
  ssn_last_4_provided: boolean() | nil,
  verification: ExOAPI.Stripe.Schemas.LegalEntityPersonVerification.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()