additional_addresses()

@type additional_addresses() :: %{
  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(:purpose) => String.t() | nil,
  optional(:state) => String.t() | nil,
  optional(:town) => String.t() | nil,
  optional(String.t()) => term()
}

city - City, district, suburb, town, or village.
country - Two-letter country code (ISO 3166-1 alpha-2).
line1 - Address line 1 (e.g., street, PO Box, or company name).
line2 - Address line 2 (e.g., apartment, suite, unit, or building).
postal_code - ZIP or postal code.
purpose - Purpose of additional address. Possible values: registered.
state - State, county, province, or region.
town - Town or district.

additional_names()

@type additional_names() :: %{
  optional(:full_name) => String.t() | nil,
  optional(:given_name) => String.t() | nil,
  optional(:purpose) => String.t() | nil,
  optional(:surname) => String.t() | nil,
  optional(String.t()) => term()
}

full_name - The person's full name.
given_name - The person's first or given name.
purpose - The purpose or type of the additional name. Possible values: alias, maiden.
surname - The person's last or family name.

additional_terms_of_service()

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

account - Stripe terms of service agreement.

additional_terms_of_service_account()

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

date - The time when the Account's representative accepted the terms of service. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. Format: date-time.
ip - The IP address from which the Account's representative accepted the terms of service.
user_agent - The user agent of the browser from which the Account's representative accepted the terms of service.

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(:town) => String.t() | nil,
  optional(String.t()) => term()
}

city - City, district, suburb, town, or village.
country - Two-letter country code (ISO 3166-1 alpha-2).
line1 - Address line 1 (e.g., street, PO Box, or company name).
line2 - Address line 2 (e.g., apartment, suite, unit, or building).
postal_code - ZIP or postal code.
state - State, county, province, or region.
town - Town or district.

date_of_birth()

@type date_of_birth() :: %{
  optional(:day) => integer() | nil,
  optional(:month) => integer() | nil,
  optional(:year) => integer() | nil,
  optional(String.t()) => term()
}

day - The day of birth.
month - The month of birth.
year - The year of birth.

documents()

@type documents() :: %{
  optional(:company_authorization) => documents_company_authorization() | nil,
  optional(:passport) => documents_passport() | nil,
  optional(:primary_verification) => documents_primary_verification() | nil,
  optional(:secondary_verification) => documents_secondary_verification() | 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.
primary_verification - An identifying document showing the person's name, either a passport or local ID card.
secondary_verification - A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
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) => [String.t()] | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}

files - One or more document IDs returned by a file upload with a purpose value of account_requirement.
type - The format of the document. Currently supports files only. Possible values: files.

documents_passport()

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

files - One or more document IDs returned by a file upload with a purpose value of account_requirement.
type - The format of the document. Currently supports files only. Possible values: files.

documents_primary_verification()

@type documents_primary_verification() :: %{
  optional(:front_back) => documents_primary_verification_front_back() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}

front_back - The file upload tokens referring to each side of the document.
type - The format of the verification document. Currently supports front_back only. Possible values: front_back.

documents_primary_verification_front_back()

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

back - A file upload token representing the back of the verification document. The purpose of the uploaded file should be '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.
front - A file upload token representing the front of the verification document. The purpose of the uploaded file should be '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.

documents_secondary_verification()

@type documents_secondary_verification() :: %{
  optional(:front_back) => documents_secondary_verification_front_back() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}

front_back - The file upload tokens referring to each side of the document.
type - The format of the verification document. Currently supports front_back only. Possible values: front_back.

documents_secondary_verification_front_back()

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

back - A file upload token representing the back of the verification document. The purpose of the uploaded file should be '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.
front - A file upload token representing the front of the verification document. The purpose of the uploaded file should be '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.

documents_visa()

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

files - One or more document IDs returned by a file upload with a purpose value of account_requirement.
type - The format of the document. Currently supports files only. Possible values: files.

id_numbers()

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

type - The ID number type of an individual. Possible values: ae_eid, ao_nif, ar_cuil, ar_dni, at_stn, az_tin, bd_brc, bd_etin, bd_nid, be_nrn, bg_ucn, bn_nric, br_cpf, ca_sin, ch_oasi, cl_rut, cn_pp, co_nuip, cr_ci, cr_cpf, cr_dimex, cr_nite, cy_tic, cz_rc, de_stn, dk_cpr, do_cie, do_rcn, ec_ci, ee_ik, es_nif, fi_hetu, fr_nir, gb_nino, gr_afm, gt_nit, hk_id, hr_oib, hu_ad, id_nik, ie_ppsn, is_kt, it_cf, jp_inc, ke_pin, kz_iin, li_peid, lt_ak, lu_nif, lv_pk, mx_rfc, my_nric, mz_nuit, ng_nin, nl_bsn, no_nin, nz_ird, pe_dni, pk_cnic, pk_snic, pl_pesel, pt_nif, ro_cnp, sa_tin, se_pin, sg_fin, sg_nric, sk_dic, th_lc, th_pin, tr_tin, us_itin, us_itin_last_4, us_ssn, us_ssn_last_4, uy_dni, za_id.
value - The value of the ID number.

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) => String.t() | nil,
  optional(:representative) => boolean() | nil,
  optional(:title) => String.t() | nil,
  optional(String.t()) => term()
}

authorizer - Whether the individual is an authorizer of the Account's identity.
director - Indicates whether the person is a director of the associated legal entity.
executive - Indicates whether the person is an executive of the associated legal entity.
legal_guardian - Indicates whether the person is a legal guardian of the associated legal entity.
owner - Indicates whether the person is an owner of the associated legal entity.
percent_ownership - The percentage of ownership the person has in the associated legal entity. Format: decimal string.
representative - Indicates whether the person is a representative of the associated legal entity.
title - The title or position the person holds in the associated legal entity.

script_addresses()

@type script_addresses() :: %{
  optional(:kana) => script_addresses_kana() | nil,
  optional(:kanji) => script_addresses_kanji() | nil,
  optional(String.t()) => term()
}

kana - Kana Address.
kanji - Kanji Address.

script_addresses_kana()

@type script_addresses_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, district, suburb, town, or village.
country - Two-letter country code (ISO 3166-1 alpha-2).
line1 - Address line 1 (e.g., street, PO Box, or company name).
line2 - Address line 2 (e.g., apartment, suite, unit, or building).
postal_code - ZIP or postal code.
state - State, county, province, or region.
town - Town or district.

script_addresses_kanji()

@type script_addresses_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, district, suburb, town, or village.
country - Two-letter country code (ISO 3166-1 alpha-2).
line1 - Address line 1 (e.g., street, PO Box, or company name).
line2 - Address line 2 (e.g., apartment, suite, unit, or building).
postal_code - ZIP or postal code.
state - State, county, province, or region.
town - Town or district.

script_names()

@type script_names() :: %{
  optional(:kana) => script_names_kana() | nil,
  optional(:kanji) => script_names_kanji() | nil,
  optional(String.t()) => term()
}

kana - Persons name in kana script.
kanji - Persons name in kanji script.

script_names_kana()

@type script_names_kana() :: %{
  optional(:given_name) => String.t() | nil,
  optional(:surname) => String.t() | nil,
  optional(String.t()) => term()
}

given_name - The person's first or given name.
surname - The person's last or family name.

script_names_kanji()

@type script_names_kanji() :: %{
  optional(:given_name) => String.t() | nil,
  optional(:surname) => String.t() | nil,
  optional(String.t()) => term()
}

given_name - The person's first or given name.
surname - The person's last or family name.

t()

@type t() :: %Stripe.Params.V2.Core.Accounts.PersonCreateParams{
  additional_addresses: [additional_addresses()] | nil,
  additional_names: [additional_names()] | nil,
  additional_terms_of_service: additional_terms_of_service() | nil,
  address: address() | nil,
  date_of_birth: date_of_birth() | nil,
  documents: documents() | nil,
  email: String.t() | nil,
  given_name: String.t() | nil,
  id_numbers: [id_numbers()] | nil,
  legal_gender: String.t() | nil,
  metadata: %{required(String.t()) => String.t()} | nil,
  nationalities: [String.t()] | nil,
  person_token: String.t() | nil,
  phone: String.t() | nil,
  political_exposure: String.t() | nil,
  relationship: relationship() | nil,
  script_addresses: script_addresses() | nil,
  script_names: script_names() | nil,
  surname: String.t() | nil
}

additional_addresses - Additional addresses associated with the person.
additional_names - Additional names (e.g. aliases) associated with the person.
additional_terms_of_service - Attestations of accepted terms of service agreements.
address - The person's residential address.
date_of_birth - The person's date of birth.
documents - Documents that may be submitted to satisfy various informational requests.
email - Email.
given_name - The person's first name.
id_numbers - The identification numbers (e.g., SSN) associated with the person.
legal_gender - The person's gender (International regulations require either "male" or "female"). Possible values: female, male.
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.
nationalities - The nationalities (countries) this person is associated with.
person_token - The person token generated by the person token api.
phone - The phone number for this person.
political_exposure - The person's political exposure. Possible values: existing, none.
relationship - The relationship that this person has with the Account's business or legal entity.
script_addresses - The script addresses (e.g., non-Latin characters) associated with the person.
script_names - The script names (e.g. non-Latin characters) associated with the person.
surname - The person's last name.

Stripe.Params.V2.Core.Accounts.PersonCreateParams (tiger_stripe v0.3.0)

Summary

Types

Types

additional_addresses()

additional_names()

additional_terms_of_service()

additional_terms_of_service_account()

address()

date_of_birth()

documents()

documents_company_authorization()

documents_passport()

documents_primary_verification()

documents_primary_verification_front_back()

documents_secondary_verification()

documents_secondary_verification_front_back()

documents_visa()

id_numbers()

relationship()

script_addresses()

script_addresses_kana()

script_addresses_kanji()

script_names()

script_names_kana()

script_names_kanji()

t()