The Person object 

Attributes

• idstring

  Unique identifier for the Person.

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

• accountstring

  The account ID which the individual belongs to.

• additional_addressesnullable array of objects

  Additional addresses associated with the person.

  Hide child attributes

  • additional_addresses.citynullable string

    City, district, suburb, town, or village.

  • additional_addresses.countrynullable enum

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

  • additional_addresses.line1nullable string

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

  • additional_addresses.line2nullable string

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

  • additional_addresses.postal_codenullable string

    ZIP or postal code.

  • additional_addresses.purposeenum

    Purpose of additional address.

    Possible enum values

    registered Registered.

  • additional_addresses.statenullable string

    State, county, province, or region.

  • additional_addresses.townnullable string

    Town or cho-me.

• additional_namesnullable array of objects

  Additional names (e.g. aliases) associated with the person.

  Hide child attributes

  • additional_names.full_namenullable string

    The individual’s full name.

  • additional_names.given_namenullable string

    The individual’s first or given name.

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

  • additional_names.surnamenullable string

    The individual’s last or family name.

• additional_terms_of_servicenullable object

  Attestations of accepted terms of service agreements.

  Hide child attributes

  • additional_terms_of_service.accountnullable object

    Stripe terms of service agreement.

    Hide child attributes

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

    • additional_terms_of_service.account.ipnullable string

      The IP address from which the Account’s representative accepted the terms of service.

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

• addressnullable object

  The person’s residential address.

  Hide child attributes

  • address.citynullable string

    City, district, suburb, town, or village.

  • address.countrynullable enum

    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.

  • address.townnullable string

    Town or cho-me.

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

• date_of_birthnullable object

  The person’s date of birth.

  Hide child attributes

  • date_of_birth.dayinteger

    The day of birth, between 1 and 31.

  • date_of_birth.monthinteger

    The month of birth, between 1 and 12.

  • date_of_birth.yearinteger

    The four-digit year of birth.

• documentsnullable object

  Documents that may be submitted to satisfy various informational requests.

  Hide child attributes

  • documents.company_authorizationnullable object

    One or more documents that demonstrate proof that this person is authorized to represent the company.

    Hide child attributes

    • documents.company_authorization.filesarray of strings

      One or more document IDs returned by a file upload with a purpose value of account_requirement.

    • documents.company_authorization.typeenum

      The format of the document. Currently supports files only.

      Possible enum values

      files Document type with multiple files.

  • documents.passportnullable object

    One or more documents showing the person’s passport page with photo and personal data.

    Hide child attributes

    • documents.passport.filesarray of strings

      One or more document IDs returned by a file upload with a purpose value of account_requirement.

    • documents.passport.typeenum

      The format of the document. Currently supports files only.

      Possible enum values

      files Document type with multiple files.

  • documents.primary_verificationnullable object

    An identifying document showing the person’s name, either a passport or local ID card.

    Hide child attributes

    • documents.primary_verification.front_backobject

      The file upload tokens for the front and back of the verification document.

      Hide child attributes

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

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

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

  • documents.secondary_verificationnullable object

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

    Hide child attributes

    • documents.secondary_verification.front_backobject

      The file upload tokens for the front and back of the verification document.

      Hide child attributes

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

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

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

  • documents.visanullable object

    One or more documents showing the person’s visa required for living in the country where they are residing.

    Hide child attributes

    • documents.visa.filesarray of strings

      One or more document IDs returned by a file upload with a purpose value of account_requirement.

    • documents.visa.typeenum

      The format of the document. Currently supports files only.

      Possible enum values

      files Document type with multiple files.

• emailnullable string

  The person’s email address.

• given_namenullable string

  The person’s first name.

• id_numbersnullable array of objects

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

  Hide child attributes

  • 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

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

• livemodeboolean

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

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

• nationalitiesnullable array of enums

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

• phonenullable string

  The person’s phone number.

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

• relationshipnullable object

  The relationship that this person has with the Account’s business or legal entity.

  Hide child attributes

  • relationship.authorizernullable boolean

    Whether the individual is an authorizer of the Account’s legal entity.

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

  • relationship.executivenullable boolean

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

  • relationship.legal_guardiannullable boolean

    Whether the individual is the legal guardian of the Account’s representative.

  • relationship.ownernullable boolean

    Whether the individual is an owner of the Account’s legal entity.

  • relationship.percent_ownershipnullable decimal

    The percent owned by the individual of the Account’s legal entity.

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

  • relationship.titlenullable string

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

• script_addressesnullable object

  The script addresses (e.g., non-Latin characters) associated with the person.

  Hide child attributes

  • script_addresses.kananullable object

    Kana Address.

    Hide child attributes

    • script_addresses.kana.citynullable string

      City, district, suburb, town, or village.

    • script_addresses.kana.countrynullable enum

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

    • script_addresses.kana.line1nullable string

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

    • script_addresses.kana.line2nullable string

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

    • script_addresses.kana.postal_codenullable string

      ZIP or postal code.

    • script_addresses.kana.statenullable string

      State, county, province, or region.

    • script_addresses.kana.townnullable string

      Town or cho-me.

  • script_addresses.kanjinullable object

    Kanji Address.

    Hide child attributes

    • script_addresses.kanji.citynullable string

      City, district, suburb, town, or village.

    • script_addresses.kanji.countrynullable enum

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

    • script_addresses.kanji.line1nullable string

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

    • script_addresses.kanji.line2nullable string

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

    • script_addresses.kanji.postal_codenullable string

      ZIP or postal code.

    • script_addresses.kanji.statenullable string

      State, county, province, or region.

    • script_addresses.kanji.townnullable string

      Town or cho-me.

• script_namesnullable object

  The script names (e.g. non-Latin characters) associated with the person.

  Hide child attributes

  • script_names.kananullable object

    Persons name in kana script.

    Hide child attributes

    • script_names.kana.given_namenullable string

      The person’s first or given name.

    • script_names.kana.surnamenullable string

      The person’s last or family name.

  • script_names.kanjinullable object

    Persons name in kanji script.

    Hide child attributes

    • script_names.kanji.given_namenullable string

      The person’s first or given name.

    • script_names.kanji.surnamenullable string

      The person’s last or family name.

• surnamenullable string

  The person’s last name.

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