Updates a Person associated with an Account.
Learn more about calling API v2 endpoints.Parameters
- account_
idstringRequired The Account the Person is associated with.
- idstringRequired
The ID of the Person to update.
- additional_
addressesarray of objects Additional addresses associated with the person.
- additional_addresses.
citystring City, district, suburb, town, or village.
- additional_addresses.
countryenum Two-letter country code (ISO 3166-1 alpha-2).
- additional_addresses.
line1string Address line 1 (e.g., street, PO Box, or company name).
- additional_addresses.
line2string Address line 2 (e.g., apartment, suite, unit, or building).
- additional_addresses.
postal_ codestring ZIP or postal code.
- additional_addresses.
purposeenumRequired Purpose of additional address.
Possible enum valuesregisteredRegistered.
- additional_addresses.
statestring State, county, province, or region.
- additional_addresses.
townstring Town or cho-me.
- additional_
namesarray of objects Additional names (e.g. aliases) associated with the person.
- additional_names.
full_ namestring The person’s full name.
- additional_names.
given_ namestring The person’s first or given name.
- additional_names.
purposeenumRequired The purpose or type of the additional name.
Possible enum valuesaliasAn alias for the individual’s name.
maidenThe maiden name of the individual.
- additional_names.
surnamestring The person’s last or family name.
- additional_
terms_ of_ serviceobject Attestations of accepted terms of service agreements.
- additional_terms_of_service.
accountobject Stripe terms of service agreement.
- additional_terms_of_service.
account. datetimestamp 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.
- additional_terms_of_service.
account. ipstring The IP address from which the Account’s representative accepted the terms of service.
- additional_terms_of_service.
account. user_ agentstring The user agent of the browser from which the Account’s representative accepted the terms of service.
- addressobject
The primary address associated with the person.
- address.
citystring City, district, suburb, town, or village.
- address.
countryenum Two-letter country code (ISO 3166-1 alpha-2).
- address.
line1string Address line 1 (e.g., street, PO Box, or company name).
- address.
line2string Address line 2 (e.g., apartment, suite, unit, or building).
- address.
postal_ codestring ZIP or postal code.
- address.
statestring State, county, province, or region.
- address.
townstring Town or cho-me.
- date_
of_ birthobject The person’s date of birth.
- date_of_birth.
dayintegerRequired The day of the birth.
- date_of_birth.
monthintegerRequired The month of birth.
- date_of_birth.
yearintegerRequired The year of birth.
- documentsobject
Documents that may be submitted to satisfy various informational requests.
- documents.
object One or more documents that demonstrate proof that this person is authorized to represent the company.
- documents.
company_authorization. array of stringsRequired One or more document IDs returned by a file upload with a purpose value of
account_.requirement - documents.
company_authorization. enumRequired The format of the document. Currently supports
filesonly.Possible enum valuesfilesDocument type with multiple files.
- documents.
passportobject One or more documents showing the person’s passport page with photo and personal data.
- documents.
passport. filesarray of stringsRequired One or more document IDs returned by a file upload with a purpose value of
account_.requirement - documents.
passport. typeenumRequired The format of the document. Currently supports
filesonly.Possible enum valuesfilesDocument type with multiple files.
- documents.
primary_ verificationobject An identifying document showing the person’s name, either a passport or local ID card.
- documents.
primary_verification. front_ backobjectRequired The file upload tokens referring to each side of the document.
- documents.
primary_verification. front_back. backstring 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.
- documents.
primary_verification. front_back. frontstring 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.
primary_verification. typeenumRequired The format of the verification document. Currently supports
front_only.back Possible enum valuesfront_back Document type with both front and back sides.
- documents.
secondary_ verificationobject A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
- documents.
secondary_verification. front_ backobjectRequired The file upload tokens referring to each side of the document.
- documents.
secondary_verification. front_back. backstring 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.
- documents.
secondary_verification. front_back. frontstring 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. typeenumRequired The format of the verification document. Currently supports
front_only.back Possible enum valuesfront_back Document type with both front and back sides.
- documents.
visaobject One or more documents showing the person’s visa required for living in the country where they are residing.
- documents.
visa. filesarray of stringsRequired One or more document IDs returned by a file upload with a purpose value of
account_.requirement - documents.
visa. typeenumRequired The format of the document. Currently supports
filesonly.Possible enum valuesfilesDocument type with multiple files.
- emailstring
Email.
- given_
namestring The person’s first name.
- id_
numbersarray of objects The identification numbers (e.g., SSN) associated with the person.
- id_numbers.
typeenumRequired The ID number type of an individual.
Possible enum valuesae_eid Emirates ID - United Arab Emirates.
ao_nif Número de Identificação Fiscal (Tax Identification Number) - Angola.
ar_dni Documento Nacional de Identidad (DNI) - Argentina.
az_tin Tax Identification Number - Azerbaijan.
bd_brc Birth Registration Certificate (BRC) - Bangladesh.
bd_etin Electronic Tax Identification Number (ETIN) - Bangladesh.
bd_nid National Identification Number (NID) - Bangladesh.
br_cpf Cadastro de Pessoas Físicas - Brazil.
cr_cpf Cédula de Persona Fisica (CPF) - Costa Rica.
cr_dimex Documento de identificación Tributario Especial (DIMEX) - Costa Rica.
Show 22 more - id_numbers.
valuestringRequired The value of the ID number.
- legal_
genderenum The person’s gender (International regulations require either “male” or “female”).
Possible enum valuesfemaleFemale person gender.
maleMale person gender.
- metadatamap
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.
- nationalitiesarray of enums
The nationalities (countries) this person is associated with.
- person_
tokenstring The person token generated by the person token api.
- phonestring
The phone number for this person.
- political_
exposureenum The person’s political exposure.
Possible enum valuesexistingThe person has disclosed that they do have political exposure.
noneThe person has disclosed that they have no political exposure.
- relationshipobject
The relationship that this person has with the Account’s business or legal entity.
- relationship.
boolean Whether the individual is an authorizer of the Account’s legal entity.
- relationship.
directorboolean Indicates whether the person is a director of the associated legal entity.
- relationship.
executiveboolean Indicates whether the person is an executive of the associated legal entity.
- relationship.
legal_ guardianboolean Indicates whether the person is a legal guardian of the associated legal entity.
- relationship.
ownerboolean Indicates whether the person is an owner of the associated legal entity.
- relationship.
percent_ ownershipdecimal The percentage of ownership the person has in the associated legal entity.
- relationship.
representativeboolean Indicates whether the person is a representative of the associated legal entity.
- relationship.
titlestring The title or position the person holds in the associated legal entity.
- script_
addressesobject The script addresses (e.g., non-Latin characters) associated with the person.
- script_addresses.
kanaobject Kana Address.
- script_addresses.
kana. citystring City, district, suburb, town, or village.
- script_addresses.
kana. countryenum Two-letter country code (ISO 3166-1 alpha-2).
- script_addresses.
kana. line1string Address line 1 (e.g., street, PO Box, or company name).
- script_addresses.
kana. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- script_addresses.
kana. postal_ codestring ZIP or postal code.
- script_addresses.
kana. statestring State, county, province, or region.
- script_addresses.
kana. townstring Town or cho-me.
- script_addresses.
kanjiobject Kanji Address.
- script_addresses.
kanji. citystring City, district, suburb, town, or village.
- script_addresses.
kanji. countryenum Two-letter country code (ISO 3166-1 alpha-2).
- script_addresses.
kanji. line1string Address line 1 (e.g., street, PO Box, or company name).
- script_addresses.
kanji. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- script_addresses.
kanji. postal_ codestring ZIP or postal code.
- script_addresses.
kanji. statestring State, county, province, or region.
- script_addresses.
kanji. townstring Town or cho-me.
- script_
namesobject The script names (e.g. non-Latin characters) associated with the person.
- script_names.
kanaobject Persons name in kana script.
- script_names.
kana. given_ namestring The person’s first or given name.
- script_names.
kana. surnamestring The person’s last or family name.
- script_names.
kanjiobject Persons name in kanji script.
- script_names.
kanji. given_ namestring The person’s first or given name.
- script_names.
kanji. surnamestring The person’s last or family name.
- surnamestring
The person’s last name.
Returns
Response attributes
- idstring
Unique identifier for the Person.
- objectstring, value is "v2.core.account_person"
String representing the object’s type. Objects of the same type share the same value of the object field.
- accountstring
The account ID which the individual belongs to.
- additional_
addressesnullable array of objects Additional addresses associated with the person.
- additional_addresses.
citynullable string City, district, suburb, town, or village.
- additional_addresses.
countrynullable enum Two-letter country code (ISO 3166-1 alpha-2).
- additional_addresses.
line1nullable string Address line 1 (e.g., street, PO Box, or company name).
- additional_addresses.
line2nullable string Address line 2 (e.g., apartment, suite, unit, or building).
- additional_addresses.
postal_ codenullable string ZIP or postal code.
- additional_addresses.
purposeenum Purpose of additional address.
Possible enum valuesregisteredRegistered.
- additional_addresses.
statenullable string State, county, province, or region.
- additional_addresses.
townnullable string Town or cho-me.
- additional_
namesnullable array of objects Additional names (e.g. aliases) associated with the person.
- additional_names.
full_ namenullable string The individual’s full name.
- additional_names.
given_ namenullable string The individual’s first or given name.
- additional_names.
purposeenum The purpose or type of the additional name.
Possible enum valuesaliasAn alias for the individual’s name.
maidenThe maiden name of the individual.
- additional_names.
surnamenullable string The individual’s last or family name.
- additional_
terms_ of_ servicenullable object Attestations of accepted terms of service agreements.
- additional_terms_of_service.
accountnullable object Stripe terms of service agreement.
- additional_terms_of_service.
account. datenullable timestamp 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.
- additional_terms_of_service.
account. ipnullable string The IP address from which the Account’s representative accepted the terms of service.
- additional_terms_of_service.
account. user_ agentnullable string The user agent of the browser from which the Account’s representative accepted the terms of service.
- addressnullable object
The person’s residential address.
- address.
citynullable string City, district, suburb, town, or village.
- address.
countrynullable enum Two-letter country code (ISO 3166-1 alpha-2).
- address.
line1nullable string Address line 1 (e.g., street, PO Box, or company name).
- address.
line2nullable string Address line 2 (e.g., apartment, suite, unit, or building).
- address.
postal_ codenullable string ZIP or postal code.
- address.
statenullable string State, county, province, or region.
- address.
townnullable string Town or cho-me.
- createdtimestamp
Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- date_
of_ birthnullable object The person’s date of birth.
- date_of_birth.
dayinteger The day of birth, between 1 and 31.
- date_of_birth.
monthinteger The month of birth, between 1 and 12.
- date_of_birth.
yearinteger The four-digit year of birth.
- documentsnullable object
Documents that may be submitted to satisfy various informational requests.
- documents.
nullable object One or more documents that demonstrate proof that this person is authorized to represent the company.
- documents.
company_authorization. array of strings One or more document IDs returned by a file upload with a purpose value of
account_.requirement - documents.
company_authorization. enum The format of the document. Currently supports
filesonly.Possible enum valuesfilesDocument type with multiple files.
- documents.
passportnullable object One or more documents showing the person’s passport page with photo and personal data.
- documents.
passport. filesarray of strings One or more document IDs returned by a file upload with a purpose value of
account_.requirement - documents.
passport. typeenum The format of the document. Currently supports
filesonly.Possible enum valuesfilesDocument type with multiple files.
- documents.
primary_ verificationnullable object An identifying document showing the person’s name, either a passport or local ID card.
- documents.
primary_verification. front_ backobject The file upload tokens for the front and back of the verification document.
- documents.
primary_verification. front_back. backnullable string 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.
- documents.
primary_verification. front_back. frontstring 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.
primary_verification. typeenum The format of the verification document. Currently supports
front_only.back Possible enum valuesfront_back Document type with both front and back sides.
- documents.
secondary_ verificationnullable object A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
- documents.
secondary_verification. front_ backobject The file upload tokens for the front and back of the verification document.
- documents.
secondary_verification. front_back. backnullable string 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.
- documents.
secondary_verification. front_back. frontstring 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. typeenum The format of the verification document. Currently supports
front_only.back Possible enum valuesfront_back Document type with both front and back sides.
- documents.
visanullable object One or more documents showing the person’s visa required for living in the country where they are residing.
- documents.
visa. filesarray of strings One or more document IDs returned by a file upload with a purpose value of
account_.requirement - documents.
visa. typeenum The format of the document. Currently supports
filesonly.Possible enum valuesfilesDocument type with multiple files.
- emailnullable string
The person’s email address.
- given_
namenullable string The person’s first name.
- id_
numbersnullable array of objects The identification numbers (e.g., SSN) associated with the person.
- id_numbers.
typeenum The ID number type of an individual.
Possible enum valuesae_eid Emirates ID - United Arab Emirates.
ao_nif Número de Identificação Fiscal (Tax Identification Number) - Angola.
ar_dni Documento Nacional de Identidad (DNI) - Argentina.
az_tin Tax Identification Number - Azerbaijan.
bd_brc Birth Registration Certificate (BRC) - Bangladesh.
bd_etin Electronic Tax Identification Number (ETIN) - Bangladesh.
bd_nid National Identification Number (NID) - Bangladesh.
br_cpf Cadastro de Pessoas Físicas - Brazil.
cr_cpf Cédula de Persona Fisica (CPF) - Costa Rica.
cr_dimex Documento de identificación Tributario Especial (DIMEX) - Costa Rica.
Show 22 more
- legal_
gendernullable enum The person’s gender (International regulations require either “male” or “female”).
Possible enum valuesfemaleFemale person gender.
maleMale person gender.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - metadatanullable map
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.
- nationalitiesnullable array of enums
The countries where the person is a national. Two-letter country code (ISO 3166-1 alpha-2).
- phonenullable string
The person’s phone number.
- political_
exposurenullable enum The person’s political exposure.
Possible enum valuesexistingThe person has disclosed that they do have political exposure.
noneThe person has disclosed that they have no political exposure.
- relationshipnullable object
The relationship that this person has with the Account’s business or legal entity.
- relationship.
nullable boolean Whether the individual is an authorizer of the Account’s legal entity.
- relationship.
directornullable boolean Whether the individual 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.
- relationship.
executivenullable boolean Whether the individual has significant responsibility to control, manage, or direct the organization.
- relationship.
legal_ guardiannullable boolean Whether the individual is the legal guardian of the Account’s representative.
- relationship.
ownernullable boolean Whether the individual is an owner of the Account’s legal entity.
- relationship.
percent_ ownershipnullable decimal The percent owned by the individual of the Account’s legal entity.
- relationship.
representativenullable boolean Whether the individual 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.
- relationship.
titlenullable string The individual’s title (e.g., CEO, Support Engineer).
- script_
addressesnullable object The script addresses (e.g., non-Latin characters) associated with the person.
- script_addresses.
kananullable object Kana Address.
- script_addresses.
kana. citynullable string City, district, suburb, town, or village.
- script_addresses.
kana. countrynullable enum Two-letter country code (ISO 3166-1 alpha-2).
- script_addresses.
kana. line1nullable string Address line 1 (e.g., street, PO Box, or company name).
- script_addresses.
kana. line2nullable string Address line 2 (e.g., apartment, suite, unit, or building).
- script_addresses.
kana. postal_ codenullable string ZIP or postal code.
- script_addresses.
kana. statenullable string State, county, province, or region.
- script_addresses.
kana. townnullable string Town or cho-me.
- script_addresses.
kanjinullable object Kanji Address.
- script_addresses.
kanji. citynullable string City, district, suburb, town, or village.
- script_addresses.
kanji. countrynullable enum Two-letter country code (ISO 3166-1 alpha-2).
- script_addresses.
kanji. line1nullable string Address line 1 (e.g., street, PO Box, or company name).
- script_addresses.
kanji. line2nullable string Address line 2 (e.g., apartment, suite, unit, or building).
- script_addresses.
kanji. postal_ codenullable string ZIP or postal code.
- script_addresses.
kanji. statenullable string State, county, province, or region.
- script_addresses.
kanji. townnullable string Town or cho-me.
- script_
namesnullable object The script names (e.g. non-Latin characters) associated with the person.
- script_names.
kananullable object Persons name in kana script.
- script_names.
kana. given_ namenullable string The person’s first or given name.
- script_names.
kana. surnamenullable string The person’s last or family name.
- script_names.
kanjinullable object Persons name in kanji script.
- script_names.
kanji. given_ namenullable string The person’s first or given name.
- script_names.
kanji. surnamenullable string The person’s last or family name.
- surnamenullable string
The person’s last name.
- updatedtimestamp
Time at which the object was last updated. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
Account is not yet compatible with V2 APIs.
Accounts v2 is not enabled for your platform.
More than one legal guardian is added to an account.
More than one representative is added to an account.
Additional terms of service are signed by someone other than the legal guardian.
Invalid characters are provided for address fields.
Address country doesn’t match identity country.
Registered/script address country doesn’t match residential address country.
Address country is required but not provided.
Address postal code is invalid.
Address state is invalid.
Address town is invalid.
Representative date of birth does not meet the age limit.
Representative date of birth is provided an invalid date or a future date.
Provided file tokens for documents are invalid, not found, deleted, or belong to a different account.
Provided file tokens for documents are of the wrong purpose.
Duplicate person is added to an account.
Email contains unsupported domain.
Incorrect email is provided.
Provided ID number is of the wrong format for the given type.
The identity. value is required but not provided.
Identity param has been made immutable due to the state of the account.
A person token is created with one account but used on a different account.
Incorrect ID number is provided for a country.
The incorrect token type is provided .
Invalid IP address is provided.
Person is designated as both legal guardian and representative.
A legal guardian may not be added to the account without an existing representative.
Kana Kanji script addresses must have JP country.
Parameter cannot be passed alongside person_token.
Error returned when relationship.owner is set to true but the ownership percentage is set to 0%.
Person token required for platforms in mandated countries (e.g., France).
Phone number is invalid.
Provided script characters are invalid for the script.
The token is re-used with a different idempotency key.
Token has expired.
Total ownership percentages of all Persons on the account exceeds 100%.
V1 Account ID cannot be used in V2 Account APIs.
V1 Customer ID cannot be used in V2 Account APIs.
A v1 token ID is passed in v2 APIs.
Invalid person token.
The resource wasn’t found.
{ "id": "person_test_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person", "account": "acct_1Nv0FGQ9RKHgCVdK", "additional_addresses": [], "additional_names": [], "address": { "city": "Brothers", "country": "us", "line1": "27 Fredrick Ave", "postal_code": "97712", "state": "OR" }, "created": "2024-11-26T17:10:07.000Z", "date_of_birth": { "day": 28, "month": 1, "year": 2000 }, "email": "jenny.rosen@example.com", "given_name": "Jenny", "id_numbers": [ { "type": "us_ssn_last_4" } ], "livemode": true, "metadata": {}, "nationalities": [], "relationship": { "owner": true, "percent_ownership": "0.8", "representative": true, "title": "CEO" }, "surname": "Rosen", "updated": "2024-11-26T17:12:55.000Z"}- Need help? Contact Support.
- Check out our changelog.
- Questions? Contact Sales.
- LLM? Read llms.txt.
- Powered by Markdoc