Schema2020-08-27object

person

This is an object representing a person associated with a Stripe account. A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps. Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information).

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

LegalEntityPersonVerification

object

additional_document

optionalnullable

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

details string

optionalnullable

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

maxLength:5000

details_code string

optionalnullable

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.

maxLength:5000

document LegalEntityPersonVerificationDocument object

optional

status string

required

The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`.

maxLength:5000

Root JSON Schema

{"description":"This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.\nSee the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps.\n\nRelated guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information).","properties":{"account":{"description":"The account the person is associated with.","maxLength":5000,"type":"string"},"address":{"$ref":"#/components/schemas/address"},"address_kana":{"anyOf":[{"$ref":"#/components/schemas/legal_entity_japan_address"}],"nullable":true},"address_kanji":{"anyOf":[{"$ref":"#/components/schemas/legal_entity_japan_address"}],"nullable":true},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"dob":{"$ref":"#/components/schemas/legal_entity_dob"},"email":{"description":"The person's email address.","maxLength":5000,"nullable":true,"type":"string"},"first_name":{"description":"The person's first name.","maxLength":5000,"nullable":true,"type":"string"},"first_name_kana":{"description":"The Kana variation of the person's first name (Japan only).","maxLength":5000,"nullable":true,"type":"string"},"first_name_kanji":{"description":"The Kanji variation of the person's first name (Japan only).","maxLength":5000,"nullable":true,"type":"string"},"full_name_aliases":{"description":"A list of alternate names or aliases that the person is known by.","items":{"maxLength":5000,"type":"string"},"type":"array"},"future_requirements":{"anyOf":[{"$ref":"#/components/schemas/person_future_requirements"}],"nullable":true},"gender":{"description":"The person's gender (International regulations require either \"male\" or \"female\").","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"id_number_provided":{"description":"Whether the person's `id_number` was provided.","type":"boolean"},"last_name":{"description":"The person's last name.","maxLength":5000,"nullable":true,"type":"string"},"last_name_kana":{"description":"The Kana variation of the person's last name (Japan only).","maxLength":5000,"nullable":true,"type":"string"},"last_name_kanji":{"description":"The Kanji variation of the person's last name (Japan only).","maxLength":5000,"nullable":true,"type":"string"},"maiden_name":{"description":"The person's maiden name.","maxLength":5000,"nullable":true,"type":"string"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"object"},"nationality":{"description":"The country where the person is a national.","maxLength":5000,"nullable":true,"type":"string"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["person"],"type":"string"},"phone":{"description":"The person's phone number.","maxLength":5000,"nullable":true,"type":"string"},"political_exposure":{"description":"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.","enum":["existing","none"],"type":"string"},"relationship":{"$ref":"#/components/schemas/person_relationship"},"requirements":{"anyOf":[{"$ref":"#/components/schemas/person_requirements"}],"nullable":true},"ssn_last_4_provided":{"description":"Whether the last four digits of the person's Social Security number have been provided (U.S. only).","type":"boolean"},"verification":{"$ref":"#/components/schemas/legal_entity_person_verification"}},"required":["account","created","id","object"],"title":"Person","type":"object","x-expandableFields":["address","address_kana","address_kanji","dob","future_requirements","relationship","requirements","verification"],"x-resourceId":"person"}