Stripe.Params.AccountPersonUpdateParams (tiger_stripe v0.3.0)

Parameters for account person update.

Summary

Types

additional_tos_acceptances()

additional_tos_acceptances_account()

address()

address_kana()

address_kanji()

documents()

documents_company_authorization()

documents_passport()

documents_visa()

registered_address()

relationship()

t()

us_cfpb_data()

us_cfpb_data_ethnicity_details()

us_cfpb_data_race_details()

verification()

verification_additional_document()

verification_document()

Types

additional_tos_acceptances()

@type additional_tos_acceptances() :: %{
  optional(:account) => additional_tos_acceptances_account() | nil,
  optional(String.t()) => term()
}

account - Details on the legal guardian's acceptance of the main Stripe service agreement.

additional_tos_acceptances_account()

@type additional_tos_acceptances_account() :: %{
  optional(:date) => integer() | nil,
  optional(:ip) => String.t() | nil,
  optional(:user_agent) => map() | nil,
  optional(String.t()) => term()
}

date - The Unix timestamp marking when the account representative accepted the service agreement. Format: Unix timestamp.
ip - The IP address from which the account representative accepted the service agreement.
user_agent - The user agent of the browser from which the account representative accepted the service agreement.

address()

@type address() :: %{
  optional(:city) => String.t() | nil,
  optional(:country) => String.t() | nil,
  optional(:line1) => String.t() | nil,
  optional(:line2) => String.t() | nil,
  optional(:postal_code) => String.t() | nil,
  optional(:state) => String.t() | nil,
  optional(String.t()) => term()
}

city - City, district, suburb, town, or village. Max length: 100.
country - Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000.
line1 - Address line 1, such as the street, PO Box, or company name. Max length: 200.
line2 - Address line 2, such as the apartment, suite, unit, or building. Max length: 200.
postal_code - ZIP or postal code. Max length: 5000.
state - State, county, province, or region (ISO 3166-2). Max length: 5000.

address_kana()

@type address_kana() :: %{
  optional(:city) => String.t() | nil,
  optional(:country) => String.t() | nil,
  optional(:line1) => String.t() | nil,
  optional(:line2) => String.t() | nil,
  optional(:postal_code) => String.t() | nil,
  optional(:state) => String.t() | nil,
  optional(:town) => String.t() | nil,
  optional(String.t()) => term()
}

city - City or ward. Max length: 5000.
country - Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000.
line1 - Block or building number. Max length: 5000.
line2 - Building details. Max length: 5000.
postal_code - Postal code. Max length: 5000.
state - Prefecture. Max length: 5000.
town - Town or cho-me. Max length: 5000.

address_kanji()

@type address_kanji() :: %{
  optional(:city) => String.t() | nil,
  optional(:country) => String.t() | nil,
  optional(:line1) => String.t() | nil,
  optional(:line2) => String.t() | nil,
  optional(:postal_code) => String.t() | nil,
  optional(:state) => String.t() | nil,
  optional(:town) => String.t() | nil,
  optional(String.t()) => term()
}

city - City or ward. Max length: 5000.
country - Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000.
line1 - Block or building number. Max length: 5000.
line2 - Building details. Max length: 5000.
postal_code - Postal code. Max length: 5000.
state - Prefecture. Max length: 5000.
town - Town or cho-me. Max length: 5000.

documents()

@type documents() :: %{
  optional(:company_authorization) => documents_company_authorization() | nil,
  optional(:passport) => documents_passport() | nil,
  optional(:visa) => documents_visa() | nil,
  optional(String.t()) => term()
}

company_authorization - One or more documents that demonstrate proof that this person is authorized to represent the company.
passport - One or more documents showing the person's passport page with photo and personal data.
visa - One or more documents showing the person's visa required for living in the country where they are residing.

documents_company_authorization()

@type documents_company_authorization() :: %{
  optional(:files) => [map()] | nil,
  optional(String.t()) => term()
}

files - One or more document ids returned by a file upload with a purpose value of account_requirement.

documents_passport()

@type documents_passport() :: %{
  optional(:files) => [map()] | nil,
  optional(String.t()) => term()
}

files - One or more document ids returned by a file upload with a purpose value of account_requirement.

documents_visa()

@type documents_visa() :: %{
  optional(:files) => [map()] | nil,
  optional(String.t()) => term()
}

files - One or more document ids returned by a file upload with a purpose value of account_requirement.

registered_address()

@type registered_address() :: %{
  optional(:city) => String.t() | nil,
  optional(:country) => String.t() | nil,
  optional(:line1) => String.t() | nil,
  optional(:line2) => String.t() | nil,
  optional(:postal_code) => String.t() | nil,
  optional(:state) => String.t() | nil,
  optional(String.t()) => term()
}

city - City, district, suburb, town, or village. Max length: 100.
country - Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000.
line1 - Address line 1, such as the street, PO Box, or company name. Max length: 200.
line2 - Address line 2, such as the apartment, suite, unit, or building. Max length: 200.
postal_code - ZIP or postal code. Max length: 5000.
state - State, county, province, or region (ISO 3166-2). Max length: 5000.

relationship()

@type relationship() :: %{
  optional(:authorizer) => boolean() | nil,
  optional(:director) => boolean() | nil,
  optional(:executive) => boolean() | nil,
  optional(:legal_guardian) => boolean() | nil,
  optional(:owner) => boolean() | nil,
  optional(:percent_ownership) => map() | nil,
  optional(:representative) => boolean() | nil,
  optional(:title) => String.t() | nil,
  optional(String.t()) => term()
}

authorizer - Whether the person is the authorizer of the account's representative.
director - Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
executive - Whether the person has significant responsibility to control, manage, or direct the organization.
legal_guardian - Whether the person is the legal guardian of the account's representative.
owner - Whether the person is an owner of the account’s legal entity.
percent_ownership - The percent owned by the person of the account's legal entity.
representative - Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
title - The person's title (e.g., CEO, Support Engineer). Max length: 5000.

t()

@type t() :: %Stripe.Params.AccountPersonUpdateParams{
  additional_tos_acceptances: additional_tos_acceptances() | nil,
  address: address() | nil,
  address_kana: address_kana() | nil,
  address_kanji: address_kanji() | nil,
  dob: map() | nil,
  documents: documents() | nil,
  email: String.t() | nil,
  expand: [String.t()] | nil,
  first_name: String.t() | nil,
  first_name_kana: String.t() | nil,
  first_name_kanji: String.t() | nil,
  full_name_aliases: map() | nil,
  gender: String.t() | nil,
  id_number: String.t() | nil,
  id_number_secondary: String.t() | 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,
  person_token: String.t() | nil,
  phone: String.t() | nil,
  political_exposure: String.t() | nil,
  registered_address: registered_address() | nil,
  relationship: relationship() | nil,
  ssn_last_4: String.t() | nil,
  us_cfpb_data: us_cfpb_data() | nil,
  verification: verification() | nil
}

additional_tos_acceptances - Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
address - The person's address.
address_kana - The Kana variation of the person's address (Japan only).
address_kanji - The Kanji variation of the person's address (Japan only).
dob - The person's date of birth.
documents - Documents that may be submitted to satisfy various informational requests.
email - The person's email address.
expand - Specifies which fields in the response should be expanded.
first_name - The person's first name. Max length: 5000.
first_name_kana - The Kana variation of the person's first name (Japan only). Max length: 5000.
first_name_kanji - The Kanji variation of the person's first name (Japan only). Max length: 5000.
full_name_aliases - A list of alternate names or aliases that the person is known by.
gender - The person's gender (International regulations require either "male" or "female").
id_number - The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Max length: 5000.
id_number_secondary - The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Max length: 5000.
last_name - The person's last name. Max length: 5000.
last_name_kana - The Kana variation of the person's last name (Japan only). Max length: 5000.
last_name_kanji - The Kanji variation of the person's last name (Japan only). Max length: 5000.
maiden_name - The person's maiden name. Max length: 5000.
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
nationality - The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable. Max length: 5000.
person_token - A person token, used to securely provide details to the person. Max length: 5000.
phone - The person's phone number.
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 - The person's registered address.
relationship - The relationship that this person has with the account's legal entity.
ssn_last_4 - The last four digits of the person's Social Security number (U.S. only).
us_cfpb_data - Demographic data related to the person.
verification - The person's verification status.

us_cfpb_data()

@type us_cfpb_data() :: %{
  optional(:ethnicity_details) => us_cfpb_data_ethnicity_details() | nil,
  optional(:race_details) => us_cfpb_data_race_details() | nil,
  optional(:self_identified_gender) => String.t() | nil,
  optional(String.t()) => term()
}

ethnicity_details - The persons ethnicity details
race_details - The persons race details
self_identified_gender - The persons self-identified gender Max length: 5000.

us_cfpb_data_ethnicity_details()

@type us_cfpb_data_ethnicity_details() :: %{
  optional(:ethnicity) => [String.t()] | nil,
  optional(:ethnicity_other) => String.t() | nil,
  optional(String.t()) => term()
}

ethnicity - The persons ethnicity
ethnicity_other - Please specify your origin, when other is selected. Max length: 5000.

us_cfpb_data_race_details()

@type us_cfpb_data_race_details() :: %{
  optional(:race) => [String.t()] | nil,
  optional(:race_other) => String.t() | nil,
  optional(String.t()) => term()
}

race - The persons race.
race_other - Please specify your race, when other is selected. Max length: 5000.

verification()

@type verification() :: %{
  optional(:additional_document) => verification_additional_document() | nil,
  optional(:document) => verification_document() | nil,
  optional(String.t()) => term()
}

additional_document - A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
document - An identifying document, either a passport or local ID card.

verification_additional_document()

@type verification_additional_document() :: %{
  optional(:back) => String.t() | nil,
  optional(:front) => String.t() | nil,
  optional(String.t()) => term()
}

back - The back of an ID returned by a file upload with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. Max length: 500.
front - The front of an ID returned by a file upload with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. Max length: 500.

verification_document()

@type verification_document() :: %{
  optional(:back) => String.t() | nil,
  optional(:front) => String.t() | nil,
  optional(String.t()) => term()
}

back - The back of an ID returned by a file upload with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. Max length: 500.
front - The front of an ID returned by a file upload with a purpose value of identity_document. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size. Max length: 500.