Update a person

Connect

Person

Update a person

Updates an existing person.

Parameters

addressobject
The person’s address.
- address.citystring
  City, district, suburb, town, or village.
- address.countrystring
  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.

dobobject
The person’s date of birth.
- dob.dayintegerRequired
  The day of birth, between 1 and 31.
- dob.monthintegerRequired
  The month of birth, between 1 and 12.
- dob.yearintegerRequired
  The four-digit year of birth.

emailstring
The person’s email address.

first_namestring
The person’s first name.

id_numberstring
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.

last_namestring
The person’s last name.

metadataobject
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.

phonestring
The person’s phone number.

relationshipobject
The relationship that this person has with the account’s legal entity.
- relationship.authorizerboolean
  Whether the person is the authorizer of the account’s representative.
- relationship.directorboolean
  Whether the person 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.executiveboolean
  Whether the person has significant responsibility to control, manage, or direct the organization.
- relationship.legal_guardianboolean
  Whether the person is the legal guardian of the account’s representative.
- relationship.ownerboolean
  Whether the person is an owner of the account’s legal entity.
- relationship.percent_ownershipfloat
  The percent owned by the person of the account’s legal entity.
- relationship.representativeboolean
  Whether the person 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.titlestring
  The person’s title (e.g., CEO, Support Engineer).

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

More parameters

additional_tos_acceptancesobject
Details on the legal guardian’s or authorizer’s acceptance of the required Stripe agreements.
- additional_tos_acceptances.accountobject
  Details on the legal guardian’s acceptance of the main Stripe service agreement.
  additional_tos_acceptances.account.datetimestampRequired if ip or user_agent is provided
  The Unix timestamp marking when the account representative accepted the service agreement.
  additional_tos_acceptances.account.ipstringRequired if date or user_agent is provided
  The IP address from which the account representative accepted the service agreement.
  additional_tos_acceptances.account.user_agentstring
  The user agent of the browser from which the account representative accepted the service agreement.

address_kanaobject
The Kana variation of the person’s address (Japan only).
- address_kana.citystring
  City or ward.
- address_kana.countrystring
  Two-letter country code (ISO 3166-1 alpha-2).
- address_kana.line1string
  Block or building number.
- address_kana.line2string
  Building details.
- address_kana.postal_codestring
  Postal code.
- address_kana.statestring
  Prefecture.
- address_kana.townstring
  Town or cho-me.

address_kanjiobject
The Kanji variation of the person’s address (Japan only).
- address_kanji.citystring
  City or ward.
- address_kanji.countrystring
  Two-letter country code (ISO 3166-1 alpha-2).
- address_kanji.line1string
  Block or building number.
- address_kanji.line2string
  Building details.
- address_kanji.postal_codestring
  Postal code.
- address_kanji.statestring
  Prefecture.
- address_kanji.townstring
  Town or cho-me.

documentsobject
Documents that may be submitted to satisfy various informational requests.
- documents.company_authorizationobject
  One or more documents that demonstrate proof that this person is authorized to represent the company.
  documents.company_authorization.filesarray of strings
  One or more document ids returned by a file upload with a purpose value of account_requirement.
- documents.passportobject
  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.visaobject
  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.

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

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

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

genderenum
The person’s gender (International regulations require either “male” or “female”).

id_number_secondarystring
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.

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

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

maiden_namestring
The person’s maiden name.

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

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

political_exposureenum
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 enum values
existing
The person has disclosed that they do have political exposure
none
The person has disclosed that they have no political exposure

registered_addressobject
The person’s registered address.
- registered_address.citystring
  City, district, suburb, town, or village.
- registered_address.countrystring
  Two-letter country code (ISO 3166-1 alpha-2).
- registered_address.line1string
  Address line 1 (e.g., street, PO Box, or company name).
- registered_address.line2string
  Address line 2 (e.g., apartment, suite, unit, or building).
- registered_address.postal_codestring
  ZIP or postal code.
- registered_address.statestring
  State, county, province, or region.

us_cfpb_dataobject
Demographic data related to the person.
- us_cfpb_data.ethnicity_detailsobject
  The persons ethnicity details
  us_cfpb_data.ethnicity_details.ethnicityarray of enums
  The persons ethnicity
  us_cfpb_data.ethnicity_details.ethnicity_otherstring
  Please specify your origin, when other is selected.
- us_cfpb_data.race_detailsobject
  The persons race details
  us_cfpb_data.race_details.racearray of enums
  The persons race.
  us_cfpb_data.race_details.race_otherstring
  Please specify your race, when other is selected.
- us_cfpb_data.self_identified_genderstring
  The persons self-identified gender

verificationobject
The person’s verification status.
- verification.additional_documentobject
  A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
  verification.additional_document.backstring
  The back of an ID returned by a file upload with a purpose value of 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.
  verification.additional_document.frontstring
  The front of an ID returned by a file upload with a purpose value of 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.
- verification.documentobject
  An identifying document, either a passport or local ID card.
  verification.document.backstring
  The back of an ID returned by a file upload with a purpose value of 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.
  verification.document.frontstring
  The front of an ID returned by a file upload with a purpose value of 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.

Returns

Returns a person object.

POST /v1/accounts/:id/persons/:id

Server-side language

curl https://api.stripe.com/v1/accounts/acct_1032D82eZvKYlo2C/persons/person_1MqjB62eZvKYlo2CaeEJzKVR \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "metadata[order_id]"=6735

Response

{
  "id": "person_1MqjB62eZvKYlo2CaeEJzKVR",
  "person": "person_1MqjB62eZvKYlo2CaeEJzKVR",
  "object": "person",
  "account": "acct_1032D82eZvKYlo2C",
  "created": 1680035496,
  "dob": {
    "day": null,
    "month": null,
    "year": null
  },
  "first_name": "Jane",
  "future_requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id_number_provided": false,
  "last_name": "Diaz",
  "metadata": {
    "order_id": "6735"
  },
  "relationship": {
    "director": false,
    "executive": false,
    "owner": false,
    "percent_ownership": null,
    "representative": false,
    "title": null
  },
  "requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "ssn_last_4_provided": false,
  "verification": {
    "additional_document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "details": null,
    "details_code": null,
    "document": {
      "back": null,
      "details": null,
      "details_code": null,
      "front": null
    },
    "status": "unverified"
  }
}

Update a person

Parameters

addressobject

address.citystring

address.countrystring

address.line1string

address.line2string

address.postal_codestring

address.statestring

dobobject

dob.dayintegerRequired

dob.monthintegerRequired

dob.yearintegerRequired

emailstring

first_namestring

id_numberstring

last_namestring

metadataobject

phonestring

relationshipobject

relationship.authorizerboolean

relationship.directorboolean

relationship.executiveboolean

relationship.legal_guardianboolean

relationship.ownerboolean

relationship.percent_ownershipfloat

relationship.representativeboolean

relationship.titlestring

ssn_last_4string

More parametersCollapse all

additional_tos_acceptancesobject

additional_tos_acceptances.accountobject

additional_tos_acceptances.account.datetimestampRequired if ip or user_agent is provided

additional_tos_acceptances.account.ipstringRequired if date or user_agent is provided

additional_tos_acceptances.account.user_agentstring

address_kanaobject

address_kana.citystring

address_kana.countrystring

address_kana.line1string

address_kana.line2string

address_kana.postal_codestring

address_kana.statestring

address_kana.townstring

address_kanjiobject

address_kanji.citystring

address_kanji.countrystring

address_kanji.line1string

address_kanji.line2string

address_kanji.postal_codestring

address_kanji.statestring

address_kanji.townstring

documentsobject

documents.company_authorizationobject

documents.company_authorization.filesarray of strings

documents.passportobject

documents.passport.filesarray of strings

documents.visaobject

documents.visa.filesarray of strings

first_name_kanastring

first_name_kanjistring

full_name_aliasesarray of strings

genderenum

id_number_secondarystring

last_name_kanastring

last_name_kanjistring

maiden_namestring

nationalitystring

person_tokenstring

political_exposureenum

registered_addressobject

registered_address.citystring

registered_address.countrystring

registered_address.line1string

registered_address.line2string

registered_address.postal_codestring

registered_address.statestring

us_cfpb_dataobject

us_cfpb_data.ethnicity_detailsobject

us_cfpb_data.ethnicity_details.ethnicityarray of enums

us_cfpb_data.ethnicity_details.ethnicity_otherstring

More parameters