View Source Stripe.Person (Striped v0.1.0)
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.
Link to this section Summary
Functions
Creates a new person.
Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
Retrieves an existing person.
Updates an existing person.
Link to this section Types
@type t() :: %Stripe.Person{ account: binary(), address: term(), address_kana: term() | nil, address_kanji: term() | nil, created: integer(), dob: term(), email: binary() | nil, first_name: binary() | nil, first_name_kana: binary() | nil, first_name_kanji: binary() | nil, full_name_aliases: term(), future_requirements: term() | nil, gender: binary() | nil, id: binary(), id_number_provided: boolean(), id_number_secondary_provided: boolean(), last_name: binary() | nil, last_name_kana: binary() | nil, last_name_kanji: binary() | nil, maiden_name: binary() | nil, metadata: term(), nationality: binary() | nil, object: binary(), phone: binary() | nil, political_exposure: binary(), registered_address: term(), relationship: term(), requirements: term() | nil, ssn_last_4_provided: boolean(), verification: term() }
The person type.
accountThe account the person is associated with.addressaddress_kanaThe Kana variation of the person's address (Japan only).address_kanjiThe Kanji variation of the person's address (Japan only).createdTime at which the object was created. Measured in seconds since the Unix epoch.dobemailThe person's email address.first_nameThe person's first name.first_name_kanaThe Kana variation of the person's first name (Japan only).first_name_kanjiThe Kanji variation of the person's first name (Japan only).full_name_aliasesA list of alternate names or aliases that the person is known by.future_requirementsInformation about the upcoming new requirements for this person, including what information needs to be collected, and by when.genderThe person's gender (International regulations require either "male" or "female").idUnique identifier for the object.id_number_providedWhether the person'sid_numberwas provided.id_number_secondary_providedWhether the person'sid_number_secondarywas provided.last_nameThe person's last name.last_name_kanaThe Kana variation of the person's last name (Japan only).last_name_kanjiThe Kanji variation of the person's last name (Japan only).maiden_nameThe person's maiden name.metadataSet 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.nationalityThe country where the person is a national.objectString representing the object's type. Objects of the same type share the same value.phoneThe person's phone number.political_exposureIndicates 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.registered_addressrelationshiprequirementsInformation about the requirements for this person, including what information needs to be collected, and by when.ssn_last_4_providedWhether the last four digits of the person's Social Security number have been provided (U.S. only).verification
Link to this section Functions
@spec create(client :: term(), account :: binary(), params :: map()) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Creates a new person.
Details
- Method:
post - Path:
/v1/accounts/{account}/persons
@spec delete(client :: term(), account :: binary(), person :: binary()) :: {:ok, Stripe.DeletedPerson.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
Details
- Method:
delete - Path:
/v1/accounts/{account}/persons/{person}
@spec list(client :: term(), account :: binary(), params :: map()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
Details
- Method:
get - Path:
/v1/accounts/{account}/persons
Query parameters
:ending_beforestring:expandarray of: string:limitinteger:relationshipobject with (optional) properties:director: booleanexecutive: booleanowner: booleanrepresentative: boolean
:starting_afterstring
@spec retrieve( client :: term(), account :: binary(), person :: binary(), params :: map() ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Retrieves an existing person.
Details
- Method:
get - Path:
/v1/accounts/{account}/persons/{person}
Query parameters
:expandarray of: string
@spec update( client :: term(), account :: binary(), person :: binary(), params :: map() ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Updates an existing person.
Details
- Method:
post - Path:
/v1/accounts/{account}/persons/{person}