StripeAPI.Types.Person

Contains the types generated from the schema Person

Documentation

data 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.

Related guide: Handling Identity Verification with the API.

Constructors

Person

Fields

• personAccount :: Text

  account: The account the person is associated with.

  Constraints:

  • Maximum length of 5000
• personAddress :: Maybe Address

  address:

• personAddressKana :: Maybe PersonAddressKana'

  address_kana

• personAddressKanji :: Maybe PersonAddressKanji'

  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 Text

  email: The person's email address.

  Constraints:

  • Maximum length of 5000
• personFirstName :: Maybe Text

  first_name: The person's first name.

  Constraints:

  • Maximum length of 5000
• personFirstNameKana :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• personFirstNameKanji :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• personGender :: Maybe 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.

• personLastName :: Maybe Text

  last_name: The person's last name.

  Constraints:

  • Maximum length of 5000
• personLastNameKana :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• personLastNameKanji :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• personMaidenName :: Maybe 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 Text

  nationality: The country where the person is a national.

  Constraints:

  • Maximum length of 5000
• personPhone :: Maybe 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.

• personRelationship :: Maybe PersonRelationship

  relationship:

• personRequirements :: Maybe PersonRequirements'

  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:

Instances

Eq Person

Defined in StripeAPI.Types.Person

Methods

(==) :: Person -> Person -> Bool

(/=) :: Person -> Person -> Bool

Show Person

Defined in StripeAPI.Types.Person

Methods

showsPrec :: Int -> Person -> ShowS

show :: Person -> String

showList :: [Person] -> ShowS

ToJSON Person

Defined in StripeAPI.Types.Person

Methods

toJSON :: Person -> Value

toEncoding :: Person -> Encoding

toJSONList :: [Person] -> Value

toEncodingList :: [Person] -> Encoding

FromJSON Person

Defined in StripeAPI.Types.Person

Methods

parseJSON :: Value -> Parser Person

parseJSONList :: Value -> Parser [Person]

mkPerson

Arguments

:: Text

personAccount

-> Int

personCreated

-> Text

personId

-> Person

Create a new Person with all required fields.

data PersonAddressKana'

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

Constructors

PersonAddressKana'

Fields

• personAddressKana'City :: Maybe Text

  city: City/Ward.

  Constraints:

  • Maximum length of 5000
• personAddressKana'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• personAddressKana'Line1 :: Maybe Text

  line1: Block/Building number.

  Constraints:

  • Maximum length of 5000
• personAddressKana'Line2 :: Maybe Text

  line2: Building details.

  Constraints:

  • Maximum length of 5000
• personAddressKana'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• personAddressKana'State :: Maybe Text

  state: Prefecture.

  Constraints:

  • Maximum length of 5000
• personAddressKana'Town :: Maybe Text

  town: Town/cho-me.

  Constraints:

  • Maximum length of 5000

Instances

Eq PersonAddressKana'

Defined in StripeAPI.Types.Person

Methods

(==) :: PersonAddressKana' -> PersonAddressKana' -> Bool

(/=) :: PersonAddressKana' -> PersonAddressKana' -> Bool

Show PersonAddressKana'

Defined in StripeAPI.Types.Person

Methods

showsPrec :: Int -> PersonAddressKana' -> ShowS

show :: PersonAddressKana' -> String

showList :: [PersonAddressKana'] -> ShowS

ToJSON PersonAddressKana'

Defined in StripeAPI.Types.Person

Methods

toJSON :: PersonAddressKana' -> Value

toEncoding :: PersonAddressKana' -> Encoding

toJSONList :: [PersonAddressKana'] -> Value

toEncodingList :: [PersonAddressKana'] -> Encoding

FromJSON PersonAddressKana'

Defined in StripeAPI.Types.Person

Methods

parseJSON :: Value -> Parser PersonAddressKana'

parseJSONList :: Value -> Parser [PersonAddressKana']

mkPersonAddressKana' :: PersonAddressKana'

Create a new PersonAddressKana' with all required fields.

data PersonAddressKanji'

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

Constructors

PersonAddressKanji'

Fields

• personAddressKanji'City :: Maybe Text

  city: City/Ward.

  Constraints:

  • Maximum length of 5000
• personAddressKanji'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• personAddressKanji'Line1 :: Maybe Text

  line1: Block/Building number.

  Constraints:

  • Maximum length of 5000
• personAddressKanji'Line2 :: Maybe Text

  line2: Building details.

  Constraints:

  • Maximum length of 5000
• personAddressKanji'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• personAddressKanji'State :: Maybe Text

  state: Prefecture.

  Constraints:

  • Maximum length of 5000
• personAddressKanji'Town :: Maybe Text

  town: Town/cho-me.

  Constraints:

  • Maximum length of 5000

Instances

Eq PersonAddressKanji'

Defined in StripeAPI.Types.Person

Methods

(==) :: PersonAddressKanji' -> PersonAddressKanji' -> Bool

(/=) :: PersonAddressKanji' -> PersonAddressKanji' -> Bool

Show PersonAddressKanji'

Defined in StripeAPI.Types.Person

Methods

showsPrec :: Int -> PersonAddressKanji' -> ShowS

show :: PersonAddressKanji' -> String

showList :: [PersonAddressKanji'] -> ShowS

ToJSON PersonAddressKanji'

Defined in StripeAPI.Types.Person

Methods

toJSON :: PersonAddressKanji' -> Value

toEncoding :: PersonAddressKanji' -> Encoding

toJSONList :: [PersonAddressKanji'] -> Value

toEncodingList :: [PersonAddressKanji'] -> Encoding

FromJSON PersonAddressKanji'

Defined in StripeAPI.Types.Person

Methods

parseJSON :: Value -> Parser PersonAddressKanji'

parseJSONList :: Value -> Parser [PersonAddressKanji']

mkPersonAddressKanji' :: PersonAddressKanji'

Create a new PersonAddressKanji' with all required fields.

data 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"

Instances

Eq PersonPoliticalExposure'

Defined in StripeAPI.Types.Person

Methods

(==) :: PersonPoliticalExposure' -> PersonPoliticalExposure' -> Bool

(/=) :: PersonPoliticalExposure' -> PersonPoliticalExposure' -> Bool

Show PersonPoliticalExposure'

Defined in StripeAPI.Types.Person

Methods

showsPrec :: Int -> PersonPoliticalExposure' -> ShowS

show :: PersonPoliticalExposure' -> String

showList :: [PersonPoliticalExposure'] -> ShowS

ToJSON PersonPoliticalExposure'

Defined in StripeAPI.Types.Person

Methods

toJSON :: PersonPoliticalExposure' -> Value

toEncoding :: PersonPoliticalExposure' -> Encoding

toJSONList :: [PersonPoliticalExposure'] -> Value

toEncodingList :: [PersonPoliticalExposure'] -> Encoding

FromJSON PersonPoliticalExposure'

Defined in StripeAPI.Types.Person

Methods

parseJSON :: Value -> Parser PersonPoliticalExposure'

parseJSONList :: Value -> Parser [PersonPoliticalExposure']

data PersonRequirements'

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

Constructors

PersonRequirements'

Fields

• personRequirements'CurrentlyDue :: 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'Errors :: Maybe [AccountRequirementsError]

  errors: Fields that are `currently_due` and need to be collected again because validation or verification failed.

• personRequirements'EventuallyDue :: 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'PastDue :: 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'PendingVerification :: 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`.

Instances

Eq PersonRequirements'

Defined in StripeAPI.Types.Person

Methods

(==) :: PersonRequirements' -> PersonRequirements' -> Bool

(/=) :: PersonRequirements' -> PersonRequirements' -> Bool

Show PersonRequirements'

Defined in StripeAPI.Types.Person

Methods

showsPrec :: Int -> PersonRequirements' -> ShowS

show :: PersonRequirements' -> String

showList :: [PersonRequirements'] -> ShowS

ToJSON PersonRequirements'

Defined in StripeAPI.Types.Person

Methods

toJSON :: PersonRequirements' -> Value

toEncoding :: PersonRequirements' -> Encoding

toJSONList :: [PersonRequirements'] -> Value

toEncodingList :: [PersonRequirements'] -> Encoding

FromJSON PersonRequirements'

Defined in StripeAPI.Types.Person

Methods

parseJSON :: Value -> Parser PersonRequirements'

parseJSONList :: Value -> Parser [PersonRequirements']

mkPersonRequirements' :: PersonRequirements'

Create a new PersonRequirements' with all required fields.