Package com.stripe.model

Class Person

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.Person
All Implemented Interfaces:
HasId, MetadataStore<Person>, StripeActiveObject, StripeObjectInterface
public class Person extends ApiResource implements HasId, MetadataStore<Person>
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.

  • Constructor Details

    • Person

      public Person()

  • Method Details

    • delete

      public Person delete() throws StripeException
      Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
      Throws:
      StripeException

    • delete

      public Person delete(RequestOptions options) throws StripeException
      Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
      Throws:
      StripeException

    • delete

      public Person delete(Map<String,Object> params) throws StripeException
      Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
      Throws:
      StripeException

    • delete

      public Person delete(Map<String,Object> params, RequestOptions options) throws StripeException
      Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
      Throws:
      StripeException

    • update

      public Person update(Map<String,Object> params) throws StripeException
      Updates an existing person.
      Specified by:
      update in interface MetadataStore<Person>
      Throws:
      StripeException

    • update

      public Person update(Map<String,Object> params, RequestOptions options) throws StripeException
      Updates an existing person.
      Specified by:
      update in interface MetadataStore<Person>
      Throws:
      StripeException

    • update

      public Person update(PersonUpdateParams params) throws StripeException
      Updates an existing person.
      Throws:
      StripeException

    • update

      public Person update(PersonUpdateParams params, RequestOptions options) throws StripeException
      Updates an existing person.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Get expanded front.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAccount

      public String getAccount()
      The account the person is associated with.

    • getAdditionalTosAcceptances

      public Person.AdditionalTosAcceptances getAdditionalTosAcceptances()

    • getAddress

      public Address getAddress()

    • getAddressKana

      public Person.AddressKana getAddressKana()
      The Kana variation of the person's address (Japan only).

    • getAddressKanji

      public Person.AddressKanji getAddressKanji()
      The Kanji variation of the person's address (Japan only).

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getDeleted

      public Boolean getDeleted()
      Always true for a deleted object.

    • getDob

      public Person.Dob getDob()

    • getEmail

      public String getEmail()
      The person's email address. Also available for accounts where controller.requirement_collection is stripe.

    • getFirstName

      public String getFirstName()
      The person's first name. Also available for accounts where controller.requirement_collection is stripe.

    • getFirstNameKana

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

    • getFirstNameKanji

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

    • getFullNameAliases

      public List<String> getFullNameAliases()
      A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.

    • getFutureRequirements

      public Person.FutureRequirements getFutureRequirements()
      Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.

    • getGender

      public String getGender()
      The person's gender.

    • getIdNumberProvided

      public Boolean getIdNumberProvided()
      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).

    • getIdNumberSecondaryProvided

      public Boolean getIdNumberSecondaryProvided()
      Whether the person's id_number_secondary was provided.

    • getLastName

      public String getLastName()
      The person's last name. Also available for accounts where controller.requirement_collection is stripe.

    • getLastNameKana

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

    • getLastNameKanji

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

    • getMaidenName

      public String getMaidenName()
      The person's maiden name.

    • getNationality

      public String getNationality()
      The country where the person is a national.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to person.

    • getPhone

      public String getPhone()
      The person's phone number.

    • getPoliticalExposure

      public String getPoliticalExposure()
      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.

      One of existing, or none.

    • getRegisteredAddress

      public Address getRegisteredAddress()

    • getRelationship

      public Person.Relationship getRelationship()

    • getRequirements

      public Person.Requirements getRequirements()
      Information about the requirements for this person, including what information needs to be collected, and by when.

    • getSelfReportedIncome

      public Person.SelfReportedIncome getSelfReportedIncome()

    • getSelfReportedMonthlyHousingPayment

      public Person.SelfReportedMonthlyHousingPayment getSelfReportedMonthlyHousingPayment()

    • getSsnLast4Provided

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

    • getUsCfpbData

      public Person.UsCfpbData getUsCfpbData()
      Demographic data related to the person.

    • getVerification

      public Person.Verification getVerification()

    • setAccount

      public void setAccount(String account)
      The account the person is associated with.

    • setAdditionalTosAcceptances

      public void setAdditionalTosAcceptances(Person.AdditionalTosAcceptances additionalTosAcceptances)

    • setAddress

      public void setAddress(Address address)

    • setAddressKana

      public void setAddressKana(Person.AddressKana addressKana)
      The Kana variation of the person's address (Japan only).

    • setAddressKanji

      public void setAddressKanji(Person.AddressKanji addressKanji)
      The Kanji variation of the person's address (Japan only).

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setDeleted

      public void setDeleted(Boolean deleted)
      Always true for a deleted object.

    • setDob

      public void setDob(Person.Dob dob)

    • setEmail

      public void setEmail(String email)
      The person's email address. Also available for accounts where controller.requirement_collection is stripe.

    • setFirstName

      public void setFirstName(String firstName)
      The person's first name. Also available for accounts where controller.requirement_collection is stripe.

    • setFirstNameKana

      public void setFirstNameKana(String firstNameKana)
      The Kana variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

    • setFirstNameKanji

      public void setFirstNameKanji(String firstNameKanji)
      The Kanji variation of the person's first name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

    • setFullNameAliases

      public void setFullNameAliases(List<String> fullNameAliases)
      A list of alternate names or aliases that the person is known by. Also available for accounts where controller.requirement_collection is stripe.

    • setFutureRequirements

      public void setFutureRequirements(Person.FutureRequirements futureRequirements)
      Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.

    • setGender

      public void setGender(String gender)
      The person's gender.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setIdNumberProvided

      public void setIdNumberProvided(Boolean idNumberProvided)
      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).

    • setIdNumberSecondaryProvided

      public void setIdNumberSecondaryProvided(Boolean idNumberSecondaryProvided)
      Whether the person's id_number_secondary was provided.

    • setLastName

      public void setLastName(String lastName)
      The person's last name. Also available for accounts where controller.requirement_collection is stripe.

    • setLastNameKana

      public void setLastNameKana(String lastNameKana)
      The Kana variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

    • setLastNameKanji

      public void setLastNameKanji(String lastNameKanji)
      The Kanji variation of the person's last name (Japan only). Also available for accounts where controller.requirement_collection is stripe.

    • setMaidenName

      public void setMaidenName(String maidenName)
      The person's maiden name.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      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.

    • setNationality

      public void setNationality(String nationality)
      The country where the person is a national.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to person.

    • setPhone

      public void setPhone(String phone)
      The person's phone number.

    • setPoliticalExposure

      public void setPoliticalExposure(String politicalExposure)
      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.

      One of existing, or none.

    • setRegisteredAddress

      public void setRegisteredAddress(Address registeredAddress)

    • setRelationship

      public void setRelationship(Person.Relationship relationship)

    • setRequirements

      public void setRequirements(Person.Requirements requirements)
      Information about the requirements for this person, including what information needs to be collected, and by when.

    • setSelfReportedIncome

      public void setSelfReportedIncome(Person.SelfReportedIncome selfReportedIncome)

    • setSelfReportedMonthlyHousingPayment

      public void setSelfReportedMonthlyHousingPayment(Person.SelfReportedMonthlyHousingPayment selfReportedMonthlyHousingPayment)

    • setSsnLast4Provided

      public void setSsnLast4Provided(Boolean ssnLast4Provided)
      Whether the last four digits of the person's Social Security number have been provided (U.S. only).

    • setUsCfpbData

      public void setUsCfpbData(Person.UsCfpbData usCfpbData)
      Demographic data related to the person.

    • setVerification

      public void setVerification(Person.Verification verification)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId

    • getMetadata

      public Map<String,String> getMetadata()
      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.
      Specified by:
      getMetadata in interface MetadataStore<Person>