List all Person objects v2

Core Resources

Persons

List all Person objects

Returns a list of Persons associated with an Account.

Learn more about calling API v2 endpoints.

Parameters

account_idstringRequired
Account the Persons are associated with.

limitinteger
The upper limit on the number of accounts returned by the List Account request.

pagestring
The page token to navigate to next or previous batch of accounts given by the list request.

Returns

Response attributes

dataarray of objects

A list of retrieved Person objects.

data.idstring
Unique identifier for the Person.

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

data.accountstring
The account ID which the individual belongs to.

data.additional_addressesnullable array of objects
Additional addresses associated with the person.
- data.additional_addresses.citynullable string
  City, district, suburb, town, or village.
- data.additional_addresses.countrynullable enum
  Two-letter country code (ISO 3166-1 alpha-2).
- data.additional_addresses.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
- data.additional_addresses.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
- data.additional_addresses.postal_codenullable string
  ZIP or postal code.
- data.additional_addresses.purposeenum
  Purpose of additional address.
  Possible enum values
  registered
  Registered.
- data.additional_addresses.statenullable string
  State, county, province, or region.
- data.additional_addresses.townnullable string
  Town or cho-me.

data.additional_namesnullable array of objects
Additional names (e.g. aliases) associated with the person.
- data.additional_names.full_namenullable string
  The individual’s full name.
- data.additional_names.given_namenullable string
  The individual’s first or given name.
- data.additional_names.purposeenum
  The purpose or type of the additional name.
  Possible enum values
  alias
  An alias for the individual’s name.
  maiden
  The maiden name of the individual.
- data.additional_names.surnamenullable string
  The individual’s last or family name.

data.additional_terms_of_servicenullable object
Attestations of accepted terms of service agreements.
- data.additional_terms_of_service.accountnullable object
  Stripe terms of service agreement.
  data.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.
  data.additional_terms_of_service.account.ipnullable string
  The IP address from which the Account’s representative accepted the terms of service.
  data.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.

data.addressnullable object
The person’s residential address.
- data.address.citynullable string
  City, district, suburb, town, or village.
- data.address.countrynullable enum
  Two-letter country code (ISO 3166-1 alpha-2).
- data.address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
- data.address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
- data.address.postal_codenullable string
  ZIP or postal code.
- data.address.statenullable string
  State, county, province, or region.
- data.address.townnullable string
  Town or cho-me.

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

data.date_of_birthnullable object
The person’s date of birth.
- data.date_of_birth.dayinteger
  The day of birth, between 1 and 31.
- data.date_of_birth.monthinteger
  The month of birth, between 1 and 12.
- data.date_of_birth.yearinteger
  The four-digit year of birth.

data.documentsnullable object
Documents that may be submitted to satisfy various informational requests.
- data.documents.company_authorizationnullable object
  One or more documents that demonstrate proof that this person is authorized to represent the company.
  data.documents.company_authorization.filesarray of strings
  One or more document IDs returned by a file upload with a purpose value of account_requirement.
  data.documents.company_authorization.typeenum
  The format of the document. Currently supports files only.
  Possible enum values
  files
  Document type with multiple files.
- data.documents.passportnullable object
  One or more documents showing the person’s passport page with photo and personal data.
  data.documents.passport.filesarray of strings
  One or more document IDs returned by a file upload with a purpose value of account_requirement.
  data.documents.passport.typeenum
  The format of the document. Currently supports files only.
  Possible enum values
  files
  Document type with multiple files.
- data.documents.primary_verificationnullable object
  An identifying document showing the person’s name, either a passport or local ID card.
  data.documents.primary_verification.front_backobject
  The file upload tokens for the front and back of the verification document.
  data.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.
  data.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.
  data.documents.primary_verification.typeenum
  The format of the verification document. Currently supports front_back only.
  Possible enum values
  front_back
  Document type with both front and back sides.
- data.documents.secondary_verificationnullable object
  A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
  data.documents.secondary_verification.front_backobject
  The file upload tokens for the front and back of the verification document.
  data.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.
  data.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.
  data.documents.secondary_verification.typeenum
  The format of the verification document. Currently supports front_back only.
  Possible enum values
  front_back
  Document type with both front and back sides.
- data.documents.visanullable object
  One or more documents showing the person’s visa required for living in the country where they are residing.
  data.documents.visa.filesarray of strings
  One or more document IDs returned by a file upload with a purpose value of account_requirement.
  data.documents.visa.typeenum
  The format of the document. Currently supports files only.
  Possible enum values
  files
  Document type with multiple files.

data.emailnullable string
The person’s email address.

data.given_namenullable string
The person’s first name.

data.id_numbersnullable array of objects

The identification numbers (e.g., SSN) associated with the person.

data.id_numbers.typeenum

The ID number type of an individual.

Possible enum values

ae_eid

Emirates ID - United Arab Emirates.

br_cpf

Cadastro de Pessoas Físicas - Brazil.

de_stn

Tax Identification Number (Steuer-ID) - Germany.

hk_id

Hong Kong Identity Card Number - Hong Kong.

mx_rfc

Personal RFC - Mexico.

my_nric

National Registration Identity Card Number - Malaysia.

nl_bsn

Citizen Service Number (BSN) - Netherlands.

sg_fin

Foreign Identification Number - Singapore.

sg_nric

National Registration Identity Card - Singapore.

th_lc

Laser Code (เลเซอร์ ไอดี) - Thailand.

Show 5 more

data.legal_gendernullable enum
The person’s gender (International regulations require either “male” or “female”).
Possible enum values
female
Female person gender.
male
Male person gender.

data.livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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

data.nationalitiesnullable array of enums
The countries where the person is a national. Two-letter country code (ISO 3166-1 alpha-2).

data.phonenullable string
The person’s phone number.

data.political_exposurenullable enum
The person’s political exposure.
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.

data.relationshipnullable object
The relationship that this person has with the Account’s business or legal entity.
- data.relationship.authorizernullable boolean
  Whether the individual is an authorizer of the Account’s legal entity.
- data.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.
- data.relationship.executivenullable boolean
  Whether the individual has significant responsibility to control, manage, or direct the organization.
- data.relationship.legal_guardiannullable boolean
  Whether the individual is the legal guardian of the Account’s representative.
- data.relationship.ownernullable boolean
  Whether the individual is an owner of the Account’s legal entity.
- data.relationship.percent_ownershipnullable decimal
  The percent owned by the individual of the Account’s legal entity.
- data.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.
- data.relationship.titlenullable string
  The individual’s title (e.g., CEO, Support Engineer).

data.script_addressesnullable object
The script addresses (e.g., non-Latin characters) associated with the person.
- data.script_addresses.kananullable object
  Kana Address.
  data.script_addresses.kana.citynullable string
  City, district, suburb, town, or village.
  data.script_addresses.kana.countrynullable enum
  Two-letter country code (ISO 3166-1 alpha-2).
  data.script_addresses.kana.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  data.script_addresses.kana.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  data.script_addresses.kana.postal_codenullable string
  ZIP or postal code.
  data.script_addresses.kana.statenullable string
  State, county, province, or region.
  data.script_addresses.kana.townnullable string
  Town or cho-me.
- data.script_addresses.kanjinullable object
  Kanji Address.
  data.script_addresses.kanji.citynullable string
  City, district, suburb, town, or village.
  data.script_addresses.kanji.countrynullable enum
  Two-letter country code (ISO 3166-1 alpha-2).
  data.script_addresses.kanji.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  data.script_addresses.kanji.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  data.script_addresses.kanji.postal_codenullable string
  ZIP or postal code.
  data.script_addresses.kanji.statenullable string
  State, county, province, or region.
  data.script_addresses.kanji.townnullable string
  Town or cho-me.

data.script_namesnullable object
The script names (e.g. non-Latin characters) associated with the person.
- data.script_names.kananullable object
  Persons name in kana script.
  data.script_names.kana.given_namenullable string
  The person’s first or given name.
  data.script_names.kana.surnamenullable string
  The person’s last or family name.
- data.script_names.kanjinullable object
  Persons name in kanji script.
  data.script_names.kanji.given_namenullable string
  The person’s first or given name.
  data.script_names.kanji.surnamenullable string
  The person’s last or family name.

data.surnamenullable string
The person’s last name.

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

next_page_urlnullable string
URL with page token to navigate to next batch of Persons given by the list request.

previous_page_urlnullable string
URL with page token to previous to next batch of Persons given by the list request.

Error Codes

400v1_account_instead_of_v2_account

V1 Account ID cannot be used in V2 Account APIs.

400v1_customer_instead_of_v2_account

V1 Customer ID cannot be used in V2 Account APIs.

GET /v2/core/accounts/:id/persons

curl https://api.stripe.com/v2/core/accounts/acct_1Nv0FGQ9RKHgCVdK/persons \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-05-28.preview"

Response

{
  "data": [
    {
      "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

List all Person objects v2

Parameters

account_idstringRequired

limitinteger

pagestring

Returns

Response attributes

dataarray of objects

data.idstring

data.objectstring, value is "v2.core.account_person"

data.accountstring

data.additional_addressesnullable array of objects

data.additional_addresses.citynullable string

data.additional_addresses.countrynullable enum

data.additional_addresses.line1nullable string

data.additional_addresses.line2nullable string

data.additional_addresses.postal_codenullable string

data.additional_addresses.purposeenum

data.additional_addresses.statenullable string

data.additional_addresses.townnullable string

data.additional_namesnullable array of objects

data.additional_names.full_namenullable string

data.additional_names.given_namenullable string

data.additional_names.purposeenum

data.additional_names.surnamenullable string

data.additional_terms_of_servicenullable object

data.additional_terms_of_service.accountnullable object

data.additional_terms_of_service.account.datenullable timestamp

data.additional_terms_of_service.account.ipnullable string

data.additional_terms_of_service.account.user_agentnullable string

data.addressnullable object

data.address.citynullable string

data.address.countrynullable enum

data.address.line1nullable string

data.address.line2nullable string

data.address.postal_codenullable string

data.address.statenullable string

data.address.townnullable string

data.createdtimestamp

data.date_of_birthnullable object

data.date_of_birth.dayinteger

data.date_of_birth.monthinteger

data.date_of_birth.yearinteger

data.documentsnullable object

data.documents.company_authorizationnullable object

data.documents.company_authorization.filesarray of strings

data.documents.company_authorization.typeenum

data.documents.passportnullable object

data.documents.passport.filesarray of strings

data.documents.passport.typeenum

data.documents.primary_verificationnullable object

data.documents.primary_verification.front_backobject

data.documents.primary_verification.front_back.backnullable string

data.documents.primary_verification.front_back.frontstring

data.documents.primary_verification.typeenum

data.documents.secondary_verificationnullable object

data.documents.secondary_verification.front_backobject

data.documents.secondary_verification.front_back.backnullable string

data.documents.secondary_verification.front_back.frontstring

data.documents.secondary_verification.typeenum

data.documents.visanullable object

data.documents.visa.filesarray of strings

data.documents.visa.typeenum

data.emailnullable string

data.given_namenullable string

data.id_numbersnullable array of objects

data.id_numbers.typeenum

data.legal_gendernullable enum

data.livemodeboolean

data.metadatanullable map

data.nationalitiesnullable array of enums

data.phonenullable string

data.political_exposurenullable enum

data.relationshipnullable object

data.relationship.authorizernullable boolean

data.relationship.directornullable boolean

data.relationship.executivenullable boolean

data.relationship.legal_guardiannullable boolean

data.relationship.ownernullable boolean

data.relationship.percent_ownershipnullable decimal