Person
This is an object representing a person associated with a Stripe account.
A platform cannot access a person for an account where account.controller.requirement_collection is stripe
, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.
The Person object
Attributes
- idstring
Unique identifier for the object.
- accountstring
The account the person is associated with.
- addressnullable dictionary
The person’s address.
- dobnullable dictionary
The person’s date of birth.
- emailnullable string
The person’s email address.
- first_
namenullable string The person’s first name.
- last_
namenullable string The person’s last name.
- metadatadictionary
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.
- phonenullable string
The person’s phone number.
- relationshipdictionary
Describes the person’s relationship to the account.
- requirementsnullable dictionary
Information about the requirements for this person, including what information needs to be collected, and by when.
More attributes
- objectstring
- additional_
tos_ acceptancesdictionary - address_
kananullable dictionary - address_
kanjinullable dictionary - createdtimestamp
- first_
name_ kananullable string - first_
name_ kanjinullable string - full_
name_ aliasesnullable array of strings - future_
requirementsnullable dictionary - gendernullable enum
- id_
number_ providedboolean - id_
number_ secondary_ providednullable boolean - last_
name_ kananullable string - last_
name_ kanjinullable string - maiden_
namenullable string - nationalitynullable string
- political_
exposurenullable enum - registered_
addressnullable dictionary - ssn_
last_ 4_ providedboolean - verificationdictionary
Create a person
Creates a new person.
Parameters
- addressdictionary
The person’s address.
- dobdictionary
The person’s date 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.
- metadatadictionary
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.
- relationshipdictionary
The relationship that this person has with the account’s legal entity.
- ssn_
last_ 4string The last four digits of the person’s Social Security number (U.S. only).
More parameters
- additional_
tos_ acceptancesdictionary - address_
kanadictionary - address_
kanjidictionary - documentsdictionary
- 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_
exposurestring - registered_
addressdictionary - verificationdictionary
Returns
Returns a person object.
Update a person
Updates an existing person.
Parameters
- addressdictionary
The person’s address.
- dobdictionary
The person’s date 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.
- metadatadictionary
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.
- relationshipdictionary
The relationship that this person has with the account’s legal entity.
- ssn_
last_ 4string The last four digits of the person’s Social Security number (U.S. only).
More parameters
- additional_
tos_ acceptancesdictionary - address_
kanadictionary - address_
kanjidictionary - documentsdictionary
- 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_
exposurestring - registered_
addressdictionary - verificationdictionary
Returns
Returns a person object.
Retrieve a person
Retrieves an existing person.
Parameters
No parameters.
Returns
Returns a person object.