POST /v1/accounts/{account}/persons/{person}

Updates an existing person.

Servers

Path parameters

Name Type Required Description
account String Yes
person String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
full_name_aliases No

A list of alternate names or aliases that the person is known by.

first_name String No

The person's first name.

metadata No

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.

relationship Object No

The relationship that this person has with the account's legal entity.

relationship.percent_ownership No
relationship.authorizer Boolean No
relationship.representative Boolean No
relationship.executive Boolean No
relationship.title String No
relationship.director Boolean No
relationship.owner Boolean No
relationship.legal_guardian Boolean No
documents Object No

Documents that may be submitted to satisfy various informational requests.

documents.passport Object No
documents.passport.files[] Array No
documents.visa Object No
documents.visa.files[] Array No
documents.company_authorization Object No
documents.company_authorization.files[] Array No
first_name_kana String No

The Kana variation of the person's first name (Japan only).

political_exposure String No

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"
last_name_kanji String No

The Kanji variation of the person's last name (Japan only).

email String No

The person's email address.

us_cfpb_data Object No

Demographic data related to the person.

us_cfpb_data.ethnicity_details Object No
us_cfpb_data.ethnicity_details.ethnicity_other String No
us_cfpb_data.ethnicity_details.ethnicity[] Array No
us_cfpb_data.self_identified_gender String No
us_cfpb_data.race_details Object No
us_cfpb_data.race_details.race[] Array No
us_cfpb_data.race_details.race_other String No
address_kanji Object No

The Kanji variation of the person's address (Japan only).

address_kanji.line2 String No
address_kanji.line1 String No
address_kanji.town String No
address_kanji.postal_code String No
address_kanji.country String No
address_kanji.state String No
address_kanji.city String No
ssn_last_4 String No

The last four digits of the person's Social Security number (U.S. only).

address_kana Object No

The Kana variation of the person's address (Japan only).

address_kana.line2 String No
address_kana.line1 String No
address_kana.town String No
address_kana.postal_code String No
address_kana.country String No
address_kana.state String No
address_kana.city String No
verification Object No

The person's verification status.

verification.additional_document Object No
verification.additional_document.back String No
verification.additional_document.front String No
verification.document Object No
verification.document.back String No
verification.document.front String No
additional_tos_acceptances Object No

Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.

additional_tos_acceptances.account Object No
additional_tos_acceptances.account.user_agent No
additional_tos_acceptances.account.ip String No
additional_tos_acceptances.account.date Integer No
registered_address Object No

The person's registered address.

registered_address.line2 String No
registered_address.line1 String No
registered_address.postal_code String No
registered_address.country String No
registered_address.state String No
registered_address.city String No
last_name_kana String No

The Kana variation of the person's last name (Japan only).

expand[] Array No

Specifies which fields in the response should be expanded.

person_token String No

A person token, used to securely provide details to the person.

dob No

The person's date of birth.

id_number String No

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.

id_number_secondary String No

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.

gender String No

The person's gender (International regulations require either "male" or "female").

last_name String No

The person's last name.

maiden_name String No

The person's maiden name.

phone String No

The person's phone number.

nationality String No

The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.

first_name_kanji String No

The Kanji variation of the person's first name (Japan only).

address Object No

The person's address.

address.line2 String No
address.line1 String No
address.postal_code String No
address.country String No
address.state String No
address.city String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.