Stripe.Params.TokenCreateParams (tiger_stripe v0.3.0)

@type account() :: %{
  optional(:business_type) => String.t() | nil,
  optional(:company) => account_company() | nil,
  optional(:individual) => account_individual() | nil,
  optional(:tos_shown_and_accepted) => boolean() | nil,
  optional(String.t()) => term()
}

business_type - The business type. Possible values: company, government_entity, individual, non_profit.
company - Information about the company or business.
individual - Information about the person represented by the account.
tos_shown_and_accepted - Whether the user described by the data in the token has been shown the Stripe Connected Account Agreement. When creating an account token to create a new Connect account, this value must be true.

account_company()

@type account_company() :: %{
  optional(:address) => account_company_address() | nil,
  optional(:address_kana) => account_company_address_kana() | nil,
  optional(:address_kanji) => account_company_address_kanji() | nil,
  optional(:directors_provided) => boolean() | nil,
  optional(:directorship_declaration) =>
    account_company_directorship_declaration() | nil,
  optional(:executives_provided) => boolean() | nil,
  optional(:export_license_id) => String.t() | nil,
  optional(:export_purpose_code) => String.t() | nil,
  optional(:name) => String.t() | nil,
  optional(:name_kana) => String.t() | nil,
  optional(:name_kanji) => String.t() | nil,
  optional(:owners_provided) => boolean() | nil,
  optional(:ownership_declaration) =>
    account_company_ownership_declaration() | nil,
  optional(:ownership_declaration_shown_and_signed) => boolean() | nil,
  optional(:ownership_exemption_reason) => String.t() | nil,
  optional(:phone) => String.t() | nil,
  optional(:registration_date) => map() | nil,
  optional(:registration_number) => String.t() | nil,
  optional(:representative_declaration) =>
    account_company_representative_declaration() | nil,
  optional(:structure) => String.t() | nil,
  optional(:tax_id) => String.t() | nil,
  optional(:tax_id_registrar) => String.t() | nil,
  optional(:vat_id) => String.t() | nil,
  optional(:verification) => account_company_verification() | nil,
  optional(String.t()) => term()
}

address - The company's primary address.
address_kana - The Kana variation of the company's primary address (Japan only).
address_kanji - The Kanji variation of the company's primary address (Japan only).
directors_provided - Whether the company's directors have been provided. Set this Boolean to true after creating all the company's directors with the Persons API for accounts with a relationship.director requirement. This value is not automatically set to true after creating directors, so it needs to be updated to indicate all directors have been provided.
directorship_declaration - This hash is used to attest that the directors information provided to Stripe is both current and correct.
executives_provided - Whether the company's executives have been provided. Set this Boolean to true after creating all the company's executives with the Persons API for accounts with a relationship.executive requirement.
export_license_id - The export license ID number of the company, also referred as Import Export Code (India only). Max length: 5000.
export_purpose_code - The purpose code to use for export transactions (India only). Max length: 5000.
name - The company's legal name. Max length: 100.
name_kana - The Kana variation of the company's legal name (Japan only). Max length: 100.
name_kanji - The Kanji variation of the company's legal name (Japan only). Max length: 100.
owners_provided - Whether the company's owners have been provided. Set this Boolean to true after creating all the company's owners with the Persons API for accounts with a relationship.owner requirement.
ownership_declaration - This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
ownership_declaration_shown_and_signed - Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.
ownership_exemption_reason - This value is used to determine if a business is exempt from providing ultimate beneficial owners. See this support article and changelog for more details. Possible values: qualified_entity_exceeds_ownership_threshold, qualifies_as_financial_institution.
phone - The company's phone number (used for verification). Max length: 5000.
registration_date - When the business was incorporated or registered.
registration_number - The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong). Max length: 5000.
representative_declaration - This hash is used to attest that the representative is authorized to act as the representative of their legal entity.
structure - The category identifying the legal structure of the company or legal entity. See Business structure for more details. Pass an empty string to unset this value. Possible values: free_zone_establishment, free_zone_llc, government_instrumentality, governmental_unit, incorporated_non_profit, incorporated_partnership, limited_liability_partnership, llc, multi_member_llc, private_company, private_corporation, private_partnership, public_company, public_corporation, public_partnership, registered_charity, single_member_llc, sole_establishment, sole_proprietorship, tax_exempt_government_instrumentality, unincorporated_association, unincorporated_non_profit, unincorporated_partnership.
tax_id - The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.) Max length: 5000.
tax_id_registrar - The jurisdiction in which the tax_id is registered (Germany-based companies only). Max length: 5000.
vat_id - The VAT number of the company. Max length: 5000.
verification - Information on the verification state of the company.

account_company_address()

@type account_company_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.

account_company_address_kana()

@type account_company_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.

account_company_address_kanji()

@type account_company_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.

account_company_directorship_declaration()

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

date - The Unix timestamp marking when the directorship declaration attestation was made. Format: Unix timestamp.
ip - The IP address from which the directorship declaration attestation was made.
user_agent - The user agent of the browser from which the directorship declaration attestation was made. Max length: 5000.

account_company_ownership_declaration()

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

date - The Unix timestamp marking when the beneficial owner attestation was made. Format: Unix timestamp.
ip - The IP address from which the beneficial owner attestation was made.
user_agent - The user agent of the browser from which the beneficial owner attestation was made. Max length: 5000.

account_company_representative_declaration()

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

date - The Unix timestamp marking when the representative declaration attestation was made. Format: Unix timestamp.
ip - The IP address from which the representative declaration attestation was made.
user_agent - The user agent of the browser from which the representative declaration attestation was made. Max length: 5000.

account_company_verification()

@type account_company_verification() :: %{
  optional(:document) => account_company_verification_document() | nil,
  optional(String.t()) => term()
}

document - A document verifying the business.

account_company_verification_document()

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

back - The back of a document returned by a file upload with a purpose value of additional_verification. 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 a document returned by a file upload with a purpose value of additional_verification. 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.

account_individual()

@type account_individual() :: %{
  optional(:address) => account_individual_address() | nil,
  optional(:address_kana) => account_individual_address_kana() | nil,
  optional(:address_kanji) => account_individual_address_kanji() | nil,
  optional(:dob) => map() | nil,
  optional(:email) => String.t() | nil,
  optional(:first_name) => String.t() | nil,
  optional(:first_name_kana) => String.t() | nil,
  optional(:first_name_kanji) => String.t() | nil,
  optional(:full_name_aliases) => map() | nil,
  optional(:gender) => String.t() | nil,
  optional(:id_number) => String.t() | nil,
  optional(:id_number_secondary) => String.t() | nil,
  optional(:last_name) => String.t() | nil,
  optional(:last_name_kana) => String.t() | nil,
  optional(:last_name_kanji) => String.t() | nil,
  optional(:maiden_name) => String.t() | nil,
  optional(:metadata) => map() | nil,
  optional(:phone) => String.t() | nil,
  optional(:political_exposure) => String.t() | nil,
  optional(:registered_address) =>
    account_individual_registered_address() | nil,
  optional(:relationship) => account_individual_relationship() | nil,
  optional(:ssn_last_4) => String.t() | nil,
  optional(:verification) => account_individual_verification() | nil,
  optional(String.t()) => term()
}

address - The individual's primary address.
address_kana - The Kana variation of the individual's primary address (Japan only).
address_kanji - The Kanji variation of the individual's primary address (Japan only).
dob - The individual's date of birth.
email - The individual's email address.
first_name - The individual's first name. Max length: 100.
first_name_kana - The Kana variation of the individual's first name (Japan only). Max length: 5000.
first_name_kanji - The Kanji variation of the individual's first name (Japan only). Max length: 5000.
full_name_aliases - A list of alternate names or aliases that the individual is known by.
gender - The individual's gender
id_number - The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a PII token created with Stripe.js. Max length: 5000.
id_number_secondary - The government-issued secondary ID number of the individual, as appropriate for the representative's 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 created with Stripe.js. Max length: 5000.
last_name - The individual's last name. Max length: 100.
last_name_kana - The Kana variation of the individual's last name (Japan only). Max length: 5000.
last_name_kanji - The Kanji variation of the individual's last name (Japan only). Max length: 5000.
maiden_name - The individual'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.
phone - The individual'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 individual's registered address.
relationship - Describes the person’s relationship to the account.
ssn_last_4 - The last four digits of the individual's Social Security Number (U.S. only). Max length: 5000.
verification - The individual's verification document information.

account_individual_address()

@type account_individual_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.

account_individual_address_kana()

@type account_individual_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.

account_individual_address_kanji()

@type account_individual_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.

account_individual_registered_address()

@type account_individual_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.

account_individual_relationship()

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

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.
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.
title - The person's title (e.g., CEO, Support Engineer). Max length: 5000.

account_individual_verification()

@type account_individual_verification() :: %{
  optional(:additional_document) =>
    account_individual_verification_additional_document() | nil,
  optional(:document) => account_individual_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.

account_individual_verification_additional_document()

@type account_individual_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.

account_individual_verification_document()

@type account_individual_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.

bank_account()

@type bank_account() :: %{
  optional(:account_holder_name) => String.t() | nil,
  optional(:account_holder_type) => String.t() | nil,
  optional(:account_number) => String.t() | nil,
  optional(:account_type) => String.t() | nil,
  optional(:country) => String.t() | nil,
  optional(:currency) => String.t() | nil,
  optional(:payment_method) => String.t() | nil,
  optional(:routing_number) => String.t() | nil,
  optional(String.t()) => term()
}

account_holder_name - The name of the person or business that owns the bank account. This field is required when attaching the bank account to a Customer object. Max length: 5000.
account_holder_type - The type of entity that holds the account. It can be company or individual. This field is required when attaching the bank account to a Customer object. Possible values: company, individual. Max length: 5000.
account_number - The account number for the bank account, in string form. Must be a checking account. Max length: 5000.
account_type - The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza. Possible values: checking, futsu, savings, toza. Max length: 5000.
country - The country in which the bank account is located. Max length: 5000.
currency - The currency the bank account is in. This must be a country/currency pairing that Stripe supports. Format: ISO 4217 currency code.
payment_method - The ID of a Payment Method with a type of us_bank_account. The Payment Method's bank account information will be copied and returned as a Bank Account Token. This parameter is exclusive with respect to all other parameters in the bank_account hash. You must include the top-level customer parameter if the Payment Method is attached to a Customer object. If the Payment Method is not attached to a Customer object, it will be consumed and cannot be used again. You may not use Payment Methods which were created by a Setup Intent with attach_to_self=true. Max length: 5000.
routing_number - The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for account_number, this field is not required. Max length: 5000.

cvc_update()

@type cvc_update() :: %{
  optional(:cvc) => String.t() | nil,
  optional(String.t()) => term()
}

cvc - The CVC value, in string form. Max length: 5000.

person()

@type person() :: %{
  optional(:additional_tos_acceptances) =>
    person_additional_tos_acceptances() | nil,
  optional(:address) => person_address() | nil,
  optional(:address_kana) => person_address_kana() | nil,
  optional(:address_kanji) => person_address_kanji() | nil,
  optional(:dob) => map() | nil,
  optional(:documents) => person_documents() | nil,
  optional(:email) => String.t() | nil,
  optional(:first_name) => String.t() | nil,
  optional(:first_name_kana) => String.t() | nil,
  optional(:first_name_kanji) => String.t() | nil,
  optional(:full_name_aliases) => map() | nil,
  optional(:gender) => String.t() | nil,
  optional(:id_number) => String.t() | nil,
  optional(:id_number_secondary) => String.t() | nil,
  optional(:last_name) => String.t() | nil,
  optional(:last_name_kana) => String.t() | nil,
  optional(:last_name_kanji) => String.t() | nil,
  optional(:maiden_name) => String.t() | nil,
  optional(:metadata) => map() | nil,
  optional(:nationality) => String.t() | nil,
  optional(:phone) => String.t() | nil,
  optional(:political_exposure) => String.t() | nil,
  optional(:registered_address) => person_registered_address() | nil,
  optional(:relationship) => person_relationship() | nil,
  optional(:ssn_last_4) => String.t() | nil,
  optional(:us_cfpb_data) => person_us_cfpb_data() | nil,
  optional(:verification) => person_verification() | nil,
  optional(String.t()) => term()
}

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

person_additional_tos_acceptances()

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

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

person_additional_tos_acceptances_account()

@type person_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.

person_address()

@type person_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.

person_address_kana()

@type person_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.

person_address_kanji()

@type person_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.

person_documents()

@type person_documents() :: %{
  optional(:company_authorization) =>
    person_documents_company_authorization() | nil,
  optional(:passport) => person_documents_passport() | nil,
  optional(:visa) => person_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.

person_documents_company_authorization()

@type person_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.

person_documents_passport()

@type person_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.

person_documents_visa()

@type person_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.

person_registered_address()

@type person_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.

person_relationship()

@type person_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.

person_us_cfpb_data()

@type person_us_cfpb_data() :: %{
  optional(:ethnicity_details) => person_us_cfpb_data_ethnicity_details() | nil,
  optional(:race_details) => person_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.

person_us_cfpb_data_ethnicity_details()

@type person_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.

person_us_cfpb_data_race_details()

@type person_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.

person_verification()

@type person_verification() :: %{
  optional(:additional_document) =>
    person_verification_additional_document() | nil,
  optional(:document) => person_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.

person_verification_additional_document()

@type person_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.

person_verification_document()

@type person_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.

pii()

@type pii() :: %{
  optional(:id_number) => String.t() | nil,
  optional(String.t()) => term()
}

id_number - The id_number for the PII, in string form. Max length: 5000.

t()

@type t() :: %Stripe.Params.TokenCreateParams{
  account: account() | nil,
  bank_account: bank_account() | nil,
  card: map() | nil,
  customer: String.t() | nil,
  cvc_update: cvc_update() | nil,
  expand: [String.t()] | nil,
  person: person() | nil,
  pii: pii() | nil
}

account - Information for the account this token represents.
bank_account - The bank account this token will represent.
card - The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.
customer - Create a token for the customer, which is owned by the application's account. You can only use this with an OAuth access token or Stripe-Account header. Learn more about cloning saved payment methods. Max length: 5000.
cvc_update - The updated CVC value this token represents.
expand - Specifies which fields in the response should be expanded.
person - Information for the person this token represents.
pii - The PII this token represents.