Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Person

Contains the types generated from the schema Person

6 types
5 values

Packagestripeapi-3.0.0.0
Exports11
LanguageHaskell2010
LicenceMIT
SourcePerson.hs

datadata Person

Defines the object schema located at components.schemas.person in the specification.

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.

Constructors

Person
- personAccount :: Text
  account: The account the person is associated with.
  Constraints:
  - Maximum length of 5000
- personAddress :: Maybe Address
  address:
- personAddressKana :: Maybe (Nullable PersonAddressKana'NonNullable)
  address_kana
- personAddressKanji :: Maybe (Nullable PersonAddressKanji'NonNullable)
  address_kanji
- personCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- personDob :: Maybe LegalEntityDob
  dob:
- personEmail :: Maybe (Nullable Text)
  email: The person's email address.
  Constraints:
  - Maximum length of 5000
- personFirstName :: Maybe (Nullable Text)
  first_name: The person's first name.
  Constraints:
  - Maximum length of 5000
- personFirstNameKana :: Maybe (Nullable Text)
  first_name_kana: The Kana variation of the person's first name (Japan only).
  Constraints:
  - Maximum length of 5000
- personFirstNameKanji :: Maybe (Nullable Text)
  first_name_kanji: The Kanji variation of the person's first name (Japan only).
  Constraints:
  - Maximum length of 5000
- personFullNameAliases :: Maybe [Text]
  full_name_aliases: A list of alternate names or aliases that the person is known by.
- personFutureRequirements :: Maybe (Nullable PersonFutureRequirements'NonNullable)
  future_requirements
- personGender :: Maybe (Nullable Text)
  gender: The person's gender (International regulations require either "male" or "female").
- personId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- personIdNumberProvided :: Maybe Bool
  id_number_provided: Whether the person's `id_number` was provided.
- personIdNumberSecondaryProvided :: Maybe Bool
  id_number_secondary_provided: Whether the person's `id_number_secondary` was provided.
- personLastName :: Maybe (Nullable Text)
  last_name: The person's last name.
  Constraints:
  - Maximum length of 5000
- personLastNameKana :: Maybe (Nullable Text)
  last_name_kana: The Kana variation of the person's last name (Japan only).
  Constraints:
  - Maximum length of 5000
- personLastNameKanji :: Maybe (Nullable Text)
  last_name_kanji: The Kanji variation of the person's last name (Japan only).
  Constraints:
  - Maximum length of 5000
- personMaidenName :: Maybe (Nullable Text)
  maiden_name: The person's maiden name.
  Constraints:
  - Maximum length of 5000
- personMetadata :: Maybe Object
  metadata: 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.
- personNationality :: Maybe (Nullable Text)
  nationality: The country where the person is a national.
  Constraints:
  - Maximum length of 5000
- personPhone :: Maybe (Nullable Text)
  phone: The person's phone number.
  Constraints:
  - Maximum length of 5000
- personPoliticalExposure :: Maybe PersonPoliticalExposure'
  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.
- personRegisteredAddress :: Maybe Address
  registered_address:
- personRelationship :: Maybe PersonRelationship
  relationship:
- personRequirements :: Maybe (Nullable PersonRequirements'NonNullable)
  requirements
- personSsnLast_4Provided :: Maybe Bool
  ssn_last_4_provided: Whether the last four digits of the person's Social Security number have been provided (U.S. only).
- personVerification :: Maybe LegalEntityPersonVerification
  verification:

Instances4Eq, Show, FromJSON, ToJSON

Eq PersonDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
Show PersonDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
FromJSON PersonDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
ToJSON PersonDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person

valuemkPerson

:: Text
personAccount
-> Int
personCreated
-> Text
personId
-> Person

Create a new Person with all required fields.

datadata PersonAddressKana'NonNullable

Defines the object schema located at components.schemas.person.properties.address_kana.anyOf in the specification.

Constructors

PersonAddressKana'NonNullable
- personAddressKana'NonNullableCity :: Maybe (Nullable Text)
  city: City/Ward.
  Constraints:
  - Maximum length of 5000
- personAddressKana'NonNullableCountry :: Maybe (Nullable Text)
  country: Two-letter country code (ISO 3166-1 alpha-2).
  Constraints:
  - Maximum length of 5000
- personAddressKana'NonNullableLine1 :: Maybe (Nullable Text)
  line1: Block/Building number.
  Constraints:
  - Maximum length of 5000
- personAddressKana'NonNullableLine2 :: Maybe (Nullable Text)
  line2: Building details.
  Constraints:
  - Maximum length of 5000
- personAddressKana'NonNullablePostalCode :: Maybe (Nullable Text)
  postal_code: ZIP or postal code.
  Constraints:
  - Maximum length of 5000
- personAddressKana'NonNullableState :: Maybe (Nullable Text)
  state: Prefecture.
  Constraints:
  - Maximum length of 5000
- personAddressKana'NonNullableTown :: Maybe (Nullable Text)
  town: Town/cho-me.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PersonAddressKana'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
Show PersonAddressKana'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
FromJSON PersonAddressKana'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
ToJSON PersonAddressKana'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person

valuemkPersonAddressKana'NonNullable :: PersonAddressKana'NonNullable

Create a new PersonAddressKana'NonNullable with all required fields.

datadata PersonAddressKanji'NonNullable

Defines the object schema located at components.schemas.person.properties.address_kanji.anyOf in the specification.

Constructors

PersonAddressKanji'NonNullable
- personAddressKanji'NonNullableCity :: Maybe (Nullable Text)
  city: City/Ward.
  Constraints:
  - Maximum length of 5000
- personAddressKanji'NonNullableCountry :: Maybe (Nullable Text)
  country: Two-letter country code (ISO 3166-1 alpha-2).
  Constraints:
  - Maximum length of 5000
- personAddressKanji'NonNullableLine1 :: Maybe (Nullable Text)
  line1: Block/Building number.
  Constraints:
  - Maximum length of 5000
- personAddressKanji'NonNullableLine2 :: Maybe (Nullable Text)
  line2: Building details.
  Constraints:
  - Maximum length of 5000
- personAddressKanji'NonNullablePostalCode :: Maybe (Nullable Text)
  postal_code: ZIP or postal code.
  Constraints:
  - Maximum length of 5000
- personAddressKanji'NonNullableState :: Maybe (Nullable Text)
  state: Prefecture.
  Constraints:
  - Maximum length of 5000
- personAddressKanji'NonNullableTown :: Maybe (Nullable Text)
  town: Town/cho-me.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PersonAddressKanji'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
Show PersonAddressKanji'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
FromJSON PersonAddressKanji'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
ToJSON PersonAddressKanji'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person

valuemkPersonAddressKanji'NonNullable :: PersonAddressKanji'NonNullable

Create a new PersonAddressKanji'NonNullable with all required fields.

datadata PersonFutureRequirements'NonNullable

Defines the object schema located at components.schemas.person.properties.future_requirements.anyOf in the specification.

Constructors

PersonFutureRequirements'NonNullable
- personFutureRequirements'NonNullableAlternatives :: Maybe (Nullable [AccountRequirementsAlternative])
  alternatives: Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- personFutureRequirements'NonNullableCurrentlyDue :: Maybe [Text]
  currently_due: Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.
- personFutureRequirements'NonNullableErrors :: Maybe [AccountRequirementsError]
  errors: Fields that are `currently_due` and need to be collected again because validation or verification failed.
- personFutureRequirements'NonNullableEventuallyDue :: Maybe [Text]
  eventually_due: Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set.
- personFutureRequirements'NonNullablePastDue :: Maybe [Text]
  past_due: Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
- personFutureRequirements'NonNullablePendingVerification :: Maybe [Text]
  pending_verification: Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`.

Instances4Eq, Show, FromJSON, ToJSON

Eq PersonFutureRequirements'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
Show PersonFutureRequirements'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
FromJSON PersonFutureRequirements'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
ToJSON PersonFutureRequirements'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person

valuemkPersonFutureRequirements'NonNullable :: PersonFutureRequirements'NonNullable

Create a new PersonFutureRequirements'NonNullable with all required fields.

datadata PersonPoliticalExposure'

Defines the enum schema located at components.schemas.person.properties.political_exposure in the specification.

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.

Constructors

PersonPoliticalExposure'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PersonPoliticalExposure'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PersonPoliticalExposure'EnumExisting
Represents the JSON value "existing"
PersonPoliticalExposure'EnumNone
Represents the JSON value "none"

Instances4Eq, Show, FromJSON, ToJSON

Eq PersonPoliticalExposure'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
Show PersonPoliticalExposure'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
FromJSON PersonPoliticalExposure'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
ToJSON PersonPoliticalExposure'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Person

datadata PersonRequirements'NonNullable

Defines the object schema located at components.schemas.person.properties.requirements.anyOf in the specification.

Constructors

PersonRequirements'NonNullable
- personRequirements'NonNullableAlternatives :: Maybe (Nullable [AccountRequirementsAlternative])
  alternatives: Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- personRequirements'NonNullableCurrentlyDue :: Maybe [Text]
  currently_due: Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
- personRequirements'NonNullableErrors :: Maybe [AccountRequirementsError]
  errors: Fields that are `currently_due` and need to be collected again because validation or verification failed.
- personRequirements'NonNullableEventuallyDue :: Maybe [Text]
  eventually_due: Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.
- personRequirements'NonNullablePastDue :: Maybe [Text]
  past_due: Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account.
- personRequirements'NonNullablePendingVerification :: Maybe [Text]
  pending_verification: Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.

Instances4Eq, Show, FromJSON, ToJSON

Eq PersonRequirements'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
Show PersonRequirements'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
FromJSON PersonRequirements'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person
ToJSON PersonRequirements'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Person

valuemkPersonRequirements'NonNullable :: PersonRequirements'NonNullable

Create a new PersonRequirements'NonNullable with all required fields.