Find anything

Ask AI

This is an object representing a person associated with a Stripe account.

A platform can only access a subset of data in 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.

Was this section helpful?Yes No

Create a person

POST/v1/accounts/:id/persons

Update a person

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

Retrieve a person

GET/v1/accounts/:id/persons/:id

List all persons

GET/v1/accounts/:id/persons

Delete a person

DELETE/v1/accounts/:id/persons/:id

The Person object

Attributes

idstring
Unique identifier for the object.

accountstring
The account the person is associated with.

addressnullable object
The persons address.
Show child attributes

dobnullable object
The persons date of birth.
Show child attributes

emailnullable string
The persons email address. Also available for accounts where controller.requirement_collection is stripe.

first_namenullable string
The persons first name. Also available for accounts where controller.requirement_collection is stripe.

last_namenullable string
The persons last name. Also available for accounts where controller.requirement_collection is stripe.

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.

phonenullable string
The persons phone number.

relationshipobject
Describes the persons relationship to the account. Also available for accounts where controller.requirement_collection is stripe.
Show child attributes

requirementsnullable object
Information about the requirements for this person, including what information needs to be collected, and by when.
Show child attributes

More attributes
Expand all

objectstring

additional_tos_acceptancesobject

address_kananullable object

address_kanjinullable object

createdtimestamp

first_name_kananullable string

first_name_kanjinullable string

full_name_aliasesnullable array of strings

future_requirementsnullable object

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 object

ssn_last_4_providedboolean

us_cfpb_datanullable object

verificationobject

Create a person

POST/v1/accounts/:id/persons

Creates a new person.

Parameters

addressobject
The persons address.
Show child parameters

dobobject
The persons date of birth.
Show child parameters

emailstring
The persons email address.
The maximum length is 800 characters.

first_namestring
The persons first name.

id_numberstring
The persons 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.
Changing this value for the accounts representative requires that the account re-accept the terms of service.

last_namestring
The persons last name.

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. 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 persons phone number.

relationshipobject
The relationship that this person has with the accounts legal entity.
Show child parameters

ssn_last_4string
The last four digits of the persons Social Security number (U.S. only).
Changing this value for the accounts representative requires that the account re-accept the terms of service.

More parameters
Expand all

additional_tos_acceptancesobject

address_kanaobject

address_kanjiobject

documentsobject

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

us_cfpb_dataobject

verificationobject

Returns

Returns a person object.

curl https://api.stripe.com/v1/accounts/{{ACCOUNT_ID}}/persons \
  -u "sk_test_wU7nrJCZspk1NPDxiQgAF05qsk_test_wU7nrJCZspk1NPDxiQgAF05q:" \
  -d first_name=John \
  -d last_name=Doe

Response

{
  "id": "person_1N9XNb2eZvKYlo2CjPX7xF6F",
  "object": "person",
  "account": "acct_1032D82eZvKYlo2C",
  "created": 1684518375,
  "dob": {
    "day": null,
    "month": null,
    "year": null
  },
  "first_name": "John",
  "future_requirements": {
    "alternatives": [],
    "currently_due": [],
    "errors": [],
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  },
  "id_number_provided": false,
  "last_name": "Doe",
  "metadata": {},
  "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"
  }
}

Need help? Contact Support.
Chat with Stripe developers on Discord.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc

Persons

The Person object

Attributes

idstring

accountstring

addressnullable object

dobnullable object

emailnullable string

first_namenullable string

last_namenullable string

metadatamap

phonenullable string

relationshipobject

requirementsnullable object

More attributesExpand all

objectstring

additional_tos_acceptancesobject

address_kananullable object

address_kanjinullable object

createdtimestamp

first_name_kananullable string

first_name_kanjinullable string

full_name_aliasesnullable array of strings

future_requirementsnullable object

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 object

ssn_last_4_providedboolean

us_cfpb_datanullable object

verificationobject

Create a person

Parameters

addressobject

dobobject

emailstring

first_namestring

id_numberstring

last_namestring

metadatamap

phonestring

relationshipobject

ssn_last_4string

More parametersExpand all

additional_tos_acceptancesobject

address_kanaobject

address_kanjiobject

documentsobject

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

us_cfpb_dataobject

verificationobject

Returns

More attributes
Expand all

More parameters
Expand all