Sample - Stripe API
POST/v1/accounts/{account}/persons/{person}

Update a person

Updates an existing person associated with an account's legal entity. Identify the relationship with account and person, then submit only the person details you want to change. Use nested address, date-of-birth, document, relationship, and verification structures according to their defined schemas.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 29 body fields
accountstringrequired
The account associated with the person to update. Maximum 5000 characters.
personstringrequired
The unique identifier of the person to update. Maximum 5000 characters.

Optional form data containing the person fields to update.

additional_tos_acceptancesobjectoptional
Details on the legal guardian's or authorizer's acceptance of the required Stripe agreements.
addressobjectoptional
The person's address.
address_kanaobjectoptional
The Kana variation of the person's address (Japan only).
address_kanjiobjectoptional
The Kanji variation of the person's address (Japan only).
dobobjectoptional
The person's date of birth.
documentsobjectoptional
Documents that may be submitted to satisfy various informational requests.
emailstringoptional
The person's email address.
expandarray<string>optional
Specifies which fields in the response should be expanded.
first_namestringoptional
The person's first name.
first_name_kanastringoptional
The Kana variation of the person's first name (Japan only).
first_name_kanjistringoptional
The Kanji variation of the person's first name (Japan only).
full_name_aliasesarray<string>optional
A list of alternate names or aliases that the person is known by.
genderstringoptional
The person's gender (International regulations require either "male" or "female").
id_numberstringoptional
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](https://docs.stripe.com/js/tokens/create_token?type=pii). Changing this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance).
id_number_secondarystringoptional
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](https://docs.stripe.com/js/tokens/create_token?type=pii). Changing this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance).
last_namestringoptional
The person's last name.
last_name_kanastringoptional
The Kana variation of the person's last name (Japan only).
last_name_kanjistringoptional
The Kanji variation of the person's last name (Japan only).
maiden_namestringoptional
The person's maiden name.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
nationalitystringoptional
The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable.
person_tokenstringoptional
A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person.
phonestringoptional
The person's phone number.
political_exposurestringoptional
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.
Allowed:existingnone
registered_addressobjectoptional
The person's registered address.
relationshipobjectoptional
The relationship that this person has with the account's legal entity.
ssn_last_4stringoptional
The last four digits of the person's Social Security number (U.S. only). Changing this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance).
us_cfpb_dataobjectoptional
Demographic data related to the person.
verificationobjectoptional
The person's verification status.

2 status codes
200Returns the updated person object, including its account, unique identifier, creation time, object type, and current person details.
accountstringrequired
The account the person is associated with.
additional_tos_acceptancesobjectoptional
addressobjectoptional
address_kanaobjectoptional
address_kanjiobjectoptional
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
dobobjectoptional
emailstringoptional
The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
first_namestringoptional
The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
first_name_kanastringoptional
The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
first_name_kanjistringoptional
The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
full_name_aliasesarray<string>optional
A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
future_requirementsobjectoptional
genderstringoptional
The person's gender.
idstringrequired
Unique identifier for the object.
id_number_providedbooleanoptional
Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`).
id_number_secondary_providedbooleanoptional
Whether the person's `id_number_secondary` was provided.
last_namestringoptional
The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
last_name_kanastringoptional
The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
last_name_kanjistringoptional
The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
maiden_namestringoptional
The person's maiden name.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
nationalitystringoptional
The country where the person is a national.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:person
phonestringoptional
The person's phone number.
political_exposurestringoptional
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.
Allowed:existingnone
registered_addressobjectoptional
relationshipobjectoptional
requirementsobjectoptional
ssn_last_4_providedbooleanoptional
Whether the last four digits of the person's Social Security number have been provided (U.S. only).
us_cfpb_dataobjectoptional
Demographic data related to the person.
verificationobjectoptional
defaultReturned when the request cannot be processed; the response contains an API error object with an error type and related details.
errorobjectrequired

Error handling

account and person must identify the person to update, and each value must not exceed 5000 characters. String fields with maximum lengths, including first_name, email, and id_number, must remain within those limits; dob must be a complete date object or the allowed empty string. address.city must not exceed 100 characters, while address.line1 and address.line2 must not exceed 200 characters.