Search documentation of tiger_stripe

# Stripe.Resources.Person (tiger_stripe v0.1.1)

Copy Markdown View Source

Person

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

A platform can only access a subset of data in 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.

## Summary

### Types

t()

### Functions

expandable_fields()
object_name()

## Types

# t()

    @type t() :: %Stripe.Resources.Person{
      account: String.t() | nil,
      additional_tos_acceptances: map() | nil,
      address: String.t() | map() | nil,
      address_kana: map() | nil,
      address_kanji: map() | nil,
      created: integer(),
      dob: map() | 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: map() | nil,
      gender: String.t() | nil,
      id: String.t(),
      id_number_provided: boolean() | nil,
      id_number_secondary_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: String.t(),
      phone: String.t() | nil,
      political_exposure: String.t() | nil,
      registered_address: String.t() | map() | nil,
      relationship: map() | nil,
      requirements: map() | nil,
      ssn_last_4_provided: boolean() | nil,
      us_cfpb_data: map() | nil,
      verification: map() | nil
    }

- `account` - The account the person is associated with. Max length: 5000.
- `additional_tos_acceptances` - Expandable.
- `address` - Expandable.
- `address_kana` - The Kana variation of the person's address (Japan only). Nullable. Expandable.
- `address_kanji` - The Kanji variation of the person's address (Japan only). Nullable. Expandable.
- `created` - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
- `dob` - Expandable.
- `email` - The person's email address. Also available for accounts where controller.requirement_collection is `stripe`. Max length: 5000. Nullable.
- `first_name` - The person's first name. Also available for accounts where controller.requirement_collection is `stripe`. Max length: 5000. Nullable.
- `first_name_kana` - The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is `stripe`. Max length: 5000. Nullable.
- `first_name_kanji` - The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is `stripe`. Max length: 5000. Nullable.
- `full_name_aliases` - A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is `stripe`.
- `future_requirements` - Information about the upcoming new requirements for this person, including what information needs to be collected, and by when. Nullable. Expandable.
- `gender` - The person's gender. Nullable.
- `id` - Unique identifier for the object. Max length: 5000.
- `id_number_provided` - Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`).
- `id_number_secondary_provided` - Whether the person's `id_number_secondary` was provided.
- `last_name` - The person's last name. Also available for accounts where controller.requirement_collection is `stripe`. Max length: 5000. Nullable.
- `last_name_kana` - The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is `stripe`. Max length: 5000. Nullable.
- `last_name_kanji` - The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is `stripe`. Max length: 5000. Nullable.
- `maiden_name` - The person's maiden name. Max length: 5000. Nullable.
- `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.
- `nationality` - The country where the person is a national. Max length: 5000. Nullable.
- `object` - String representing the object's type. Objects of the same type share the same value. Possible values: `person`.
- `phone` - The person's phone number. Max length: 5000. Nullable.
- `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. Possible values: `existing`, `none`.
- `registered_address` - Expandable.
- `relationship` - Expandable.
- `requirements` - Information about the requirements for this person, including what information needs to be collected, and by when. Nullable. Expandable.
- `ssn_last_4_provided` - Whether the last four digits of the person's Social Security number have been provided (U.S. only).
- `us_cfpb_data` - Demographic data related to the person. Nullable. Expandable.
- `verification` - Expandable.

## Functions

# expandable_fields()

# object_name()