Creates a single-use token that represents the details for a person. Use this when you create or update persons associated with a Connect account. Learn more about account tokens.
You can only create person tokens with your application’s publishable key and in live mode. You can use your application’s secret key to create person tokens only in test mode.
Parameters
- personobjectRequired
Information for the person this token represents.
- person.
additional_ tos_ acceptancesobject Details on the legal guardian’s or authorizer’s acceptance of the required Stripe agreements.
- person.
additional_tos_acceptances. accountobject Details on the legal guardian’s acceptance of the main Stripe service agreement.
- person.
additional_tos_acceptances. account. datetimestampRequired if ip or user_agent is provided The Unix timestamp marking when the account representative accepted the service agreement.
- person.
additional_tos_acceptances. account. ipstringRequired if date or user_agent is provided The IP address from which the account representative accepted the service agreement.
- person.
additional_tos_acceptances. account. user_ agentstring The user agent of the browser from which the account representative accepted the service agreement.
- person.
addressobject The person’s address.
- person.
address. citystring City, district, suburb, town, or village.
- person.
address. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- person.
address. line1string Address line 1 (e.g., street, PO Box, or company name).
- person.
address. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- person.
address. postal_ codestring ZIP or postal code.
- person.
address. statestring State, county, province, or region.
- person.
address_ kanaobject The Kana variation of the person’s address (Japan only).
- person.
address_kana. citystring City or ward.
- person.
address_kana. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- person.
address_kana. line1string Block or building number.
- person.
address_kana. line2string Building details.
- person.
address_kana. postal_ codestring Postal code.
- person.
address_kana. statestring Prefecture.
- person.
address_kana. townstring Town or cho-me.
- person.
address_ kanjiobject The Kanji variation of the person’s address (Japan only).
- person.
address_kanji. citystring City or ward.
- person.
address_kanji. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- person.
address_kanji. line1string Block or building number.
- person.
address_kanji. line2string Building details.
- person.
address_kanji. postal_ codestring Postal code.
- person.
address_kanji. statestring Prefecture.
- person.
address_kanji. townstring Town or cho-me.
- person.
dobobject The person’s date of birth.
- person.
dob. dayintegerRequired The day of birth, between 1 and 31.
- person.
dob. monthintegerRequired The month of birth, between 1 and 12.
- person.
dob. yearintegerRequired The four-digit year of birth.
- person.
documentsobject Documents that may be submitted to satisfy various informational requests.
- person.
documents. object One or more documents that demonstrate proof that this person is authorized to represent the company.
- person.
documents. company_authorization. array of strings One or more document ids returned by a file upload with a
purposevalue ofaccount_.requirement
- person.
documents. passportobject One or more documents showing the person’s passport page with photo and personal data.
- person.
documents. passport. filesarray of strings One or more document ids returned by a file upload with a
purposevalue ofaccount_.requirement
- person.
documents. visaobject One or more documents showing the person’s visa required for living in the country where they are residing.
- person.
documents. visa. filesarray of strings One or more document ids returned by a file upload with a
purposevalue ofaccount_.requirement
- person.
emailstring The person’s email address.
- person.
first_ namestring The person’s first name.
- person.
first_ name_ kanastring The Kana variation of the person’s first name (Japan only).
- person.
first_ name_ kanjistring The Kanji variation of the person’s first name (Japan only).
- person.
full_ name_ aliasesarray of strings A list of alternate names or aliases that the person is known by.
- person.
genderenum The person’s gender (International regulations require either “male” or “female”).
- person.
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.
- person.
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.
- person.
last_ namestring The person’s last name.
- person.
last_ name_ kanastring The Kana variation of the person’s last name (Japan only).
- person.
last_ name_ kanjistring The Kanji variation of the person’s last name (Japan only).
- person.
maiden_ namestring The person’s maiden name.
- person.
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. - person.
nationalitystring The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or “XX” if unavailable.
- person.
phonestring The person’s phone number.
- 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 valuesexistingThe person has disclosed that they do have political exposure
noneThe person has disclosed that they have no political exposure
- person.
registered_ addressobject The person’s registered address.
- person.
registered_address. citystring City, district, suburb, town, or village.
- person.
registered_address. countrystring Two-letter country code (ISO 3166-1 alpha-2).
- person.
registered_address. line1string Address line 1 (e.g., street, PO Box, or company name).
- person.
registered_address. line2string Address line 2 (e.g., apartment, suite, unit, or building).
- person.
registered_address. postal_ codestring ZIP or postal code.
- person.
registered_address. statestring State, county, province, or region.
- person.
relationshipobject The relationship that this person has with the account’s legal entity.
- person.
relationship. boolean Whether the person is the authorizer of the account’s representative.
- person.
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.
- person.
relationship. executiveboolean Whether the person has significant responsibility to control, manage, or direct the organization.
- person.
relationship. legal_ guardianboolean Whether the person is the legal guardian of the account’s representative.
- person.
relationship. ownerboolean Whether the person is an owner of the account’s legal entity.
- person.
relationship. percent_ ownershipfloat The percent owned by the person of the account’s legal entity.
- person.
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.
- person.
relationship. titlestring The person’s title (e.g., CEO, Support Engineer).
- person.
ssn_ last_ 4string The last four digits of the person’s Social Security number (U.S. only).
- person.
us_ cfpb_ dataobject Demographic data related to the person.
- person.
us_cfpb_data. ethnicity_ detailsobject The persons ethnicity details
- person.
us_cfpb_data. ethnicity_details. ethnicityarray of enums The persons ethnicity
- person.
us_cfpb_data. ethnicity_details. ethnicity_ otherstring Please specify your origin, when other is selected.
- person.
us_cfpb_data. race_ detailsobject The persons race details
- person.
us_cfpb_data. race_details. racearray of enums The persons race.
- person.
us_cfpb_data. race_details. race_ otherstring Please specify your race, when other is selected.
- person.
us_cfpb_data. self_ identified_ genderstring The persons self-identified gender
- person.
verificationobject The person’s verification status.
- person.
verification. additional_ documentobject A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
- person.
verification. additional_document. backstring The back of an ID returned by a file upload with a
purposevalue ofidentity_. 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.document - person.
verification. additional_document. frontstring The front of an ID returned by a file upload with a
purposevalue ofidentity_. 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.document
- person.
verification. documentobject An identifying document, either a passport or local ID card.
- person.
verification. document. backstring The back of an ID returned by a file upload with a
purposevalue ofidentity_. 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.document - person.
verification. document. frontstring The front of an ID returned by a file upload with a
purposevalue ofidentity_. 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.document
Returns
Returns the created person token if it’s successful. Otherwise, this call raises an error.
{ "id": "cpt_1EDww82eZvKYlo2CsdelTHFu", "object": "token", "client_ip": "8.21.168.117", "created": 1552582904, "livemode": false, "redaction": null, "type": "person", "used": false}