The Person object 

Attributes

• idstring

  Unique identifier for the object.

• accountstring

  The account the person is associated with.

• addressnullable object

  The person’s address.

  Hide child attributes

  • address.citynullable string

    City, district, suburb, town, or village.

  • address.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • address.line1nullable string

    Address line 1 (e.g., street, PO Box, or company name).

  • address.line2nullable string

    Address line 2 (e.g., apartment, suite, unit, or building).

  • address.postal_codenullable string

    ZIP or postal code.

  • address.statenullable string

    State, county, province, or region.

• dobnullable object

  The person’s date of birth.

  Hide child attributes

  • dob.daynullable integer

    The day of birth, between 1 and 31.

  • dob.monthnullable integer

    The month of birth, between 1 and 12.

  • dob.yearnullable integer

    The four-digit year of birth.

• emailnullable string

  The person’s email address. Also available for accounts where controller.requirement_collection is stripe.

• first_namenullable string

  The person’s first name. Also available for accounts where controller.requirement_collection is stripe.

• last_namenullable string

  The person’s last name. Also available for accounts where controller.requirement_collection is stripe.

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

• phonenullable string

  The person’s phone number.

• relationshipobject

  Describes the person’s relationship to the account. Also available for accounts where controller.requirement_collection is stripe.

  Hide child attributes

  • relationship.authorizernullable boolean

    Whether the person is the authorizer of the account’s representative.

  • relationship.directornullable boolean

    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.executivenullable boolean

    Whether the person has significant responsibility to control, manage, or direct the organization.

  • relationship.legal_guardiannullable boolean

    Whether the person is the legal guardian of the account’s representative.

  • relationship.ownernullable boolean

    Whether the person is an owner of the account’s legal entity.

  • relationship.percent_ownershipnullable float

    The percent owned by the person of the account’s legal entity.

  • relationship.representativenullable boolean

    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.titlenullable string

    The person’s title (e.g., CEO, Support Engineer).

• requirementsnullable object

  Information about the requirements for this person, including what information needs to be collected, and by when.

  Hide child attributes

  • requirements.alternativesnullable array of objects

    Fields that are due and can be satisfied by providing the corresponding alternative fields instead.

    Hide child attributes

    • requirements.alternatives.alternative_fields_duearray of strings

      Fields that can be provided to satisfy all fields in original_fields_due.

    • requirements.alternatives.original_fields_duearray of strings

      Fields that are due and can be satisfied by providing all fields in alternative_fields_due.

  • requirements.currently_duearray of strings

    Fields that need to be collected to keep the person’s account enabled. If not collected by the account’s current_deadline, these fields appear in past_due as well, and the account is disabled.

  • requirements.errorsarray of objects

    Fields that are currently_due and need to be collected again because validation or verification failed.

    Hide child attributes

    • requirements.errors.codeenum

      The code for the type of error.

      Possible enum values

      information_missing The requirement associated with this error is missing critical information. The associated error reason provides more details.

      invalid_address_city_state_postal_code The combination of the city, state, and postal code in the provided address could not be validated.

      invalid_address_highway_contract_box Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a Highway Contract Box.

      invalid_address_private_mailbox Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a private mailbox.

      invalid_business_profile_name Business profile names must consist of recognizable words.

      invalid_business_profile_name_denylisted Generic or well-known business names aren’t supported.

      invalid_company_name_denylisted Generic or well-known business names aren’t supported.

      invalid_dob_age_over_maximum Date of birth must be within the past 120 years.

      invalid_dob_age_under_18 Underage. Age must be at least 18.

      invalid_dob_age_under_minimum Person must be at least 13 years old.

      Show 84 more

    • requirements.errors.reasonstring

      An informative message that indicates the error type and provides additional details about the error.

    • requirements.errors.requirementstring

      The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.

  • requirements.eventually_duearray of strings

    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account’s current_deadline becomes set.

  • requirements.past_duearray of strings

    Fields that weren’t collected by the account’s current_deadline. These fields need to be collected to enable the person’s account.

  • requirements.pending_verificationarray of strings

    Fields that might become required depending on the results of verification or review. It’s an empty array unless an asynchronous verification is pending. If verification fails, these fields move to eventually_due, currently_due, or past_due. Fields might appear in eventually_due, currently_due, or past_due and in pending_verification if verification fails but another verification is still pending.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• additional_tos_acceptancesobject

  Details on the legal guardian’s acceptance of the required Stripe service agreements.

  Hide child attributes

  • additional_tos_acceptances.accountnullable object

    Details on the legal guardian’s acceptance of the main Stripe service agreement.

    Hide child attributes

    • additional_tos_acceptances.account.datenullable timestamp

      The Unix timestamp marking when the legal guardian accepted the service agreement.

    • additional_tos_acceptances.account.ipnullable string

      The IP address from which the legal guardian accepted the service agreement.

    • additional_tos_acceptances.account.user_agentnullable string

      The user agent of the browser from which the legal guardian accepted the service agreement.

• address_kananullable object

  The Kana variation of the person’s address (Japan only).

  Hide child attributes

  • address_kana.citynullable string

    City/Ward.

  • address_kana.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • address_kana.line1nullable string

    Block/Building number.

  • address_kana.line2nullable string

    Building details.

  • address_kana.postal_codenullable string

    ZIP or postal code.

  • address_kana.statenullable string

    Prefecture.

  • address_kana.townnullable string

    Town/cho-me.

• address_kanjinullable object

  The Kanji variation of the person’s address (Japan only).

  Hide child attributes

  • address_kanji.citynullable string

    City/Ward.

  • address_kanji.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • address_kanji.line1nullable string

    Block/Building number.

  • address_kanji.line2nullable string

    Building details.

  • address_kanji.postal_codenullable string

    ZIP or postal code.

  • address_kanji.statenullable string

    Prefecture.

  • address_kanji.townnullable string

    Town/cho-me.

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• first_name_kananullable string

  The Kana variation of the person’s first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

• first_name_kanjinullable string

  The Kanji variation of the person’s first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

• full_name_aliasesnullable array of strings

  A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.

• future_requirementsnullable object

  Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.

  Hide child attributes

  • future_requirements.alternativesnullable array of objects

    Fields that are due and can be satisfied by providing the corresponding alternative fields instead.

    Hide child attributes

    • future_requirements.alternatives.alternative_fields_duearray of strings

      Fields that can be provided to satisfy all fields in original_fields_due.

    • future_requirements.alternatives.original_fields_duearray of strings

      Fields that are due and can be satisfied by providing all fields in alternative_fields_due.

  • future_requirements.currently_duearray of strings

    Fields that need to be collected to keep the person’s account enabled. If not collected by the account’s future_requirements[current_deadline], these fields will transition to the main requirements hash, and may immediately become past_due, but the account may also be given a grace period depending on the account’s enablement state prior to transition.

  • future_requirements.errorsarray of objects

    Fields that are currently_due and need to be collected again because validation or verification failed.

    Hide child attributes

    • future_requirements.errors.codeenum

      The code for the type of error.

      Possible enum values

      information_missing The requirement associated with this error is missing critical information. The associated error reason provides more details.

      invalid_address_city_state_postal_code The combination of the city, state, and postal code in the provided address could not be validated.

      invalid_address_highway_contract_box Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a Highway Contract Box.

      invalid_address_private_mailbox Invalid address. Your business address must be a valid physical address from which you conduct business and cannot be a private mailbox.

      invalid_business_profile_name Business profile names must consist of recognizable words.

      invalid_business_profile_name_denylisted Generic or well-known business names aren’t supported.

      invalid_company_name_denylisted Generic or well-known business names aren’t supported.

      invalid_dob_age_over_maximum Date of birth must be within the past 120 years.

      invalid_dob_age_under_18 Underage. Age must be at least 18.

      invalid_dob_age_under_minimum Person must be at least 13 years old.

      Show 84 more

    • future_requirements.errors.reasonstring

      An informative message that indicates the error type and provides additional details about the error.

    • future_requirements.errors.requirementstring

      The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.

  • future_requirements.eventually_duearray of strings

    Fields you must collect when all thresholds are reached. As they become required, they appear in currently_due as well, and the account’s future_requirements[current_deadline] becomes set.

  • future_requirements.past_duearray of strings

    Fields that weren’t collected by the account’s requirements.current_deadline. These fields need to be collected to enable the person’s account. New fields will never appear here; future_requirements.past_due will always be a subset of requirements.past_due.

  • future_requirements.pending_verificationarray of strings

    Fields that might become required depending on the results of verification or review. It’s an empty array unless an asynchronous verification is pending. If verification fails, these fields move to eventually_due or currently_due. Fields might appear in eventually_due or currently_due and in pending_verification if verification fails but another verification is still pending.

• gendernullable enum

  The person’s gender.

• id_number_providedboolean

  Whether the person’s id_number was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual’s SSN for the US indicated by ssn_last_4_provided).

• id_number_secondary_providednullable boolean

  Whether the person’s id_number_secondary was provided.

• last_name_kananullable string

  The Kana variation of the person’s last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

• last_name_kanjinullable string

  The Kanji variation of the person’s last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

• maiden_namenullable string

  The person’s maiden name.

• nationalitynullable string

  The country where the person is a national.

• political_exposurenullable enum

  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_addressnullable object

  The person’s registered address.

  Hide child attributes

  • registered_address.citynullable string

    City, district, suburb, town, or village.

  • registered_address.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • registered_address.line1nullable string

    Address line 1 (e.g., street, PO Box, or company name).

  • registered_address.line2nullable string

    Address line 2 (e.g., apartment, suite, unit, or building).

  • registered_address.postal_codenullable string

    ZIP or postal code.

  • registered_address.statenullable string

    State, county, province, or region.

• ssn_last_4_providedboolean

  Whether the last four digits of the person’s Social Security number have been provided (U.S. only).

• us_cfpb_datanullable object

  Demographic data related to the person.

  Hide child attributes

  • us_cfpb_data.ethnicity_detailsnullable object

    The persons ethnicity details

    Hide child attributes

    • us_cfpb_data.ethnicity_details.ethnicitynullable array of enums

      The persons ethnicity

    • us_cfpb_data.ethnicity_details.ethnicity_othernullable string

      Please specify your origin, when other is selected.

  • us_cfpb_data.race_detailsnullable object

    The persons race details

    Hide child attributes

    • us_cfpb_data.race_details.racenullable array of enums

      The persons race.

    • us_cfpb_data.race_details.race_othernullable string

      Please specify your race, when other is selected.

  • us_cfpb_data.self_identified_gendernullable string

    The persons self-identified gender

• verificationobject

  The persons’s verification status.

  Hide child attributes

  • verification.additional_documentnullable object

    A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

    Hide child attributes

    • verification.additional_document.backnullable stringExpandable

      The back of an ID returned by a file upload with a purpose value of identity_document.

    • verification.additional_document.detailsnullable string

      A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say “Identity document is too unclear to read”.

    • verification.additional_document.details_codenullable string

      One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.

    • verification.additional_document.frontnullable stringExpandable

      The front of an ID returned by a file upload with a purpose value of identity_document.

  • verification.detailsnullable stringDeprecated

    A user-displayable string describing the verification state for the person. For example, this may say “Provided identity information could not be verified”.

  • verification.details_codenullable stringDeprecated

    One of document_address_mismatch, document_dob_mismatch, document_duplicate_type, document_id_number_mismatch, document_name_mismatch, document_nationality_mismatch, failed_keyed_identity, or failed_other. A machine-readable code specifying the verification state for the person.

  • verification.documentobject

    An identifying document for the person, either a passport or local ID card.

    Hide child attributes

    • verification.document.backnullable stringExpandable

      The back of an ID returned by a file upload with a purpose value of identity_document.

    • verification.document.detailsnullable string

      A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say “Identity document is too unclear to read”.

    • verification.document.details_codenullable string

      One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.

    • verification.document.frontnullable stringExpandable

      The front of an ID returned by a file upload with a purpose value of identity_document.

  • verification.statusstringDeprecated

    The state of verification for the person. Possible values are unverified, pending, or verified. Please refer guide to handle verification updates.