All Implemented Interfaces:
```
public final class Entity

                    
```
Entities are the legal entities that own accounts. They can be people, corporations, joint accounts, trusts, or government authorities. To learn more, see /documentation/entities.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Entity.Builder`	A builder for Entity.
`public final class`	`Entity.Corporation`	Details of the corporation entity. Will be present if `structure` is equal to `corporation`.
`public final class`	`Entity.GovernmentAuthority`	Details of the government authority entity. Will be present if `structure` is equal to `government_authority`.
`public final class`	`Entity.Joint`	Details of the joint entity. Will be present if `structure` is equal to `joint`.
`public final class`	`Entity.NaturalPerson`	Details of the natural person entity. Will be present if `structure` is equal to `natural_person`.
`public final class`	`Entity.RiskRating`	An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
`public final class`	`Entity.Status`	The status of the entity.
`public final class`	`Entity.Structure`	The entity's legal structure.
`public final class`	`Entity.TermsAgreement`
`public final class`	`Entity.ThirdPartyVerification`	If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service.
`public final class`	`Entity.Trust`	Details of the trust entity. Will be present if `structure` is equal to `trust`.
`public final class`	`Entity.Type`	A constant representing the object's type. For this resource it will always be `entity`.
`public final class`	`Entity.Validation`	The validation results for the entity. Learn more about /documentation/entity-validation.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`	The entity's identifier.
`final Optional<Entity.Corporation>`	`corporation()`	Details of the corporation entity.
`final OffsetDateTime`	`createdAt()`	The ISO 8601 time at which the Entity was created.
`final Optional<String>`	`creatingEntityOnboardingSessionId()`	The identifier of the Entity Onboarding Session that was used to create this Entity, if any.
`final Optional<String>`	`description()`	The entity's description for display purposes.
`final Optional<OffsetDateTime>`	`detailsConfirmedAt()`	The ISO 8601 time at which the Entity's details were most recently confirmed.
`final Optional<Entity.GovernmentAuthority>`	`governmentAuthority()`	Details of the government authority entity.
`final Optional<String>`	`idempotencyKey()`	The idempotency key you chose for this object.
`final Optional<Entity.Joint>`	`joint()`	Details of the joint entity.
`final Optional<Entity.NaturalPerson>`	`naturalPerson()`	Details of the natural person entity.
`final Optional<Entity.RiskRating>`	`riskRating()`	An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
`final Entity.Status`	`status()`	The status of the entity.
`final Entity.Structure`	`structure()`	The entity's legal structure.
`final List<EntitySupplementalDocument>`	`supplementalDocuments()`	Additional documentation associated with the entity.
`final List<Entity.TermsAgreement>`	`termsAgreements()`	The terms that the Entity agreed to.
`final Optional<Entity.ThirdPartyVerification>`	`thirdPartyVerification()`	If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service.
`final Optional<Entity.Trust>`	`trust()`	Details of the trust entity.
`final Entity.Type`	`type()`	A constant representing the object's type.
`final Optional<Entity.Validation>`	`validation()`	The validation results for the entity.
`final JsonField<String>`	`_id()`	Returns the raw JSON value of id.
`final JsonField<Entity.Corporation>`	`_corporation()`	Returns the raw JSON value of corporation.
`final JsonField<OffsetDateTime>`	`_createdAt()`	Returns the raw JSON value of createdAt.
`final JsonField<String>`	`_creatingEntityOnboardingSessionId()`	Returns the raw JSON value of creatingEntityOnboardingSessionId.
`final JsonField<String>`	`_description()`	Returns the raw JSON value of description.
`final JsonField<OffsetDateTime>`	`_detailsConfirmedAt()`	Returns the raw JSON value of detailsConfirmedAt.
`final JsonField<Entity.GovernmentAuthority>`	`_governmentAuthority()`	Returns the raw JSON value of governmentAuthority.
`final JsonField<String>`	`_idempotencyKey()`	Returns the raw JSON value of idempotencyKey.
`final JsonField<Entity.Joint>`	`_joint()`	Returns the raw JSON value of joint.
`final JsonField<Entity.NaturalPerson>`	`_naturalPerson()`	Returns the raw JSON value of naturalPerson.
`final JsonField<Entity.RiskRating>`	`_riskRating()`	Returns the raw JSON value of riskRating.
`final JsonField<Entity.Status>`	`_status()`	Returns the raw JSON value of status.
`final JsonField<Entity.Structure>`	`_structure()`	Returns the raw JSON value of structure.
`final JsonField<List<EntitySupplementalDocument>>`	`_supplementalDocuments()`	Returns the raw JSON value of supplementalDocuments.
`final JsonField<List<Entity.TermsAgreement>>`	`_termsAgreements()`	Returns the raw JSON value of termsAgreements.
`final JsonField<Entity.ThirdPartyVerification>`	`_thirdPartyVerification()`	Returns the raw JSON value of thirdPartyVerification.
`final JsonField<Entity.Trust>`	`_trust()`	Returns the raw JSON value of trust.
`final JsonField<Entity.Type>`	`_type()`	Returns the raw JSON value of type.
`final JsonField<Entity.Validation>`	`_validation()`	Returns the raw JSON value of validation.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final Entity.Builder`	`toBuilder()`
`final Entity`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static Entity.Builder`	`builder()`	Returns a mutable builder for constructing an instance of Entity.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    The entity's identifier.
  - corporation
```
 final Optional<Entity.Corporation> corporation()
```
    Details of the corporation entity. Will be present if structure is equal to corporation.
  - createdAt
```
 final OffsetDateTime createdAt()
```
    The ISO 8601 time at which the Entity was created.
  - creatingEntityOnboardingSessionId
```
 final Optional<String> creatingEntityOnboardingSessionId()
```
    The identifier of the Entity Onboarding Session that was used to create this Entity, if any.
  - description
```
 final Optional<String> description()
```
    The entity's description for display purposes.
  - detailsConfirmedAt
```
 final Optional<OffsetDateTime> detailsConfirmedAt()
```
    The ISO 8601 time at which the Entity's details were most recently confirmed.
  - governmentAuthority
```
 final Optional<Entity.GovernmentAuthority> governmentAuthority()
```
    Details of the government authority entity. Will be present if structure is equal to government_authority.
  - idempotencyKey
```
 final Optional<String> idempotencyKey()
```
    The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
  - joint
```
 final Optional<Entity.Joint> joint()
```
    Details of the joint entity. Will be present if structure is equal to joint.
  - naturalPerson
```
 final Optional<Entity.NaturalPerson> naturalPerson()
```
    Details of the natural person entity. Will be present if structure is equal to natural_person.
  - riskRating
```
 final Optional<Entity.RiskRating> riskRating()
```
    An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
  - status
```
 final Entity.Status status()
```
    The status of the entity.
  - structure
```
 final Entity.Structure structure()
```
    The entity's legal structure.
  - supplementalDocuments
```
 final List<EntitySupplementalDocument> supplementalDocuments()
```
    Additional documentation associated with the entity. This is limited to the first 10 documents for an entity. If an entity has more than 10 documents, use the GET /entity_supplemental_documents list endpoint to retrieve them.
  - termsAgreements
```
 final List<Entity.TermsAgreement> termsAgreements()
```
    The terms that the Entity agreed to. Not all programs are required to submit this data.
  - thirdPartyVerification
```
 final Optional<Entity.ThirdPartyVerification> thirdPartyVerification()
```
    If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service.
  - trust
```
 final Optional<Entity.Trust> trust()
```
    Details of the trust entity. Will be present if structure is equal to trust.
  - type
```
 final Entity.Type type()
```
    A constant representing the object's type. For this resource it will always be entity.
  - validation
```
 final Optional<Entity.Validation> validation()
```
    The validation results for the entity. Learn more about /documentation/entity-validation.
  - _id
```
 final JsonField<String> _id()
```
    Returns the raw JSON value of id.
    Unlike id, this method doesn't throw if the JSON field has an unexpected type.
  - _corporation
```
 final JsonField<Entity.Corporation> _corporation()
```
    Returns the raw JSON value of corporation.
    Unlike corporation, this method doesn't throw if the JSON field has an unexpected type.
  - _createdAt
```
 final JsonField<OffsetDateTime> _createdAt()
```
    Returns the raw JSON value of createdAt.
    Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
  - _creatingEntityOnboardingSessionId
```
 final JsonField<String> _creatingEntityOnboardingSessionId()
```
    Returns the raw JSON value of creatingEntityOnboardingSessionId.
    Unlike creatingEntityOnboardingSessionId, this method doesn't throw if the JSON field has an unexpected type.
  - _description
```
 final JsonField<String> _description()
```
    Returns the raw JSON value of description.
    Unlike description, this method doesn't throw if the JSON field has an unexpected type.
  - _detailsConfirmedAt
```
 final JsonField<OffsetDateTime> _detailsConfirmedAt()
```
    Returns the raw JSON value of detailsConfirmedAt.
    Unlike detailsConfirmedAt, this method doesn't throw if the JSON field has an unexpected type.
  - _governmentAuthority
```
 final JsonField<Entity.GovernmentAuthority> _governmentAuthority()
```
    Returns the raw JSON value of governmentAuthority.
    Unlike governmentAuthority, this method doesn't throw if the JSON field has an unexpected type.
  - _idempotencyKey
```
 final JsonField<String> _idempotencyKey()
```
    Returns the raw JSON value of idempotencyKey.
    Unlike idempotencyKey, this method doesn't throw if the JSON field has an unexpected type.
  - _joint
```
 final JsonField<Entity.Joint> _joint()
```
    Returns the raw JSON value of joint.
    Unlike joint, this method doesn't throw if the JSON field has an unexpected type.
  - _naturalPerson
```
 final JsonField<Entity.NaturalPerson> _naturalPerson()
```
    Returns the raw JSON value of naturalPerson.
    Unlike naturalPerson, this method doesn't throw if the JSON field has an unexpected type.
  - _riskRating
```
 final JsonField<Entity.RiskRating> _riskRating()
```
    Returns the raw JSON value of riskRating.
    Unlike riskRating, this method doesn't throw if the JSON field has an unexpected type.
  - _status
```
 final JsonField<Entity.Status> _status()
```
    Returns the raw JSON value of status.
    Unlike status, this method doesn't throw if the JSON field has an unexpected type.
  - _structure
```
 final JsonField<Entity.Structure> _structure()
```
    Returns the raw JSON value of structure.
    Unlike structure, this method doesn't throw if the JSON field has an unexpected type.
  - _supplementalDocuments
```
 final JsonField<List<EntitySupplementalDocument>> _supplementalDocuments()
```
    Returns the raw JSON value of supplementalDocuments.
    Unlike supplementalDocuments, this method doesn't throw if the JSON field has an unexpected type.
  - _termsAgreements
```
 final JsonField<List<Entity.TermsAgreement>> _termsAgreements()
```
    Returns the raw JSON value of termsAgreements.
    Unlike termsAgreements, this method doesn't throw if the JSON field has an unexpected type.
  - _thirdPartyVerification
```
 final JsonField<Entity.ThirdPartyVerification> _thirdPartyVerification()
```
    Returns the raw JSON value of thirdPartyVerification.
    Unlike thirdPartyVerification, this method doesn't throw if the JSON field has an unexpected type.
  - _trust
```
 final JsonField<Entity.Trust> _trust()
```
    Returns the raw JSON value of trust.
    Unlike trust, this method doesn't throw if the JSON field has an unexpected type.
  - _type
```
 final JsonField<Entity.Type> _type()
```
    Returns the raw JSON value of type.
    Unlike type, this method doesn't throw if the JSON field has an unexpected type.
  - _validation
```
 final JsonField<Entity.Validation> _validation()
```
    Returns the raw JSON value of validation.
    Unlike validation, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final Entity.Builder toBuilder()
```
  - validate
```
 final Entity validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static Entity.Builder builder()
```
    Returns a mutable builder for constructing an instance of Entity.
    The following fields are required:
    .id() .corporation() .createdAt() .creatingEntityOnboardingSessionId() .description() .detailsConfirmedAt() .governmentAuthority() .idempotencyKey() .joint() .naturalPerson() .riskRating() .status() .structure() .supplementalDocuments() .termsAgreements() .thirdPartyVerification() .trust() .type() .validation()

Class Entity

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

corporation

createdAt

creatingEntityOnboardingSessionId

description

detailsConfirmedAt

governmentAuthority

idempotencyKey

joint

naturalPerson

riskRating

status

structure

supplementalDocuments

termsAgreements

thirdPartyVerification

trust

type

validation

_id

_corporation

_createdAt

_creatingEntityOnboardingSessionId

_description

_detailsConfirmedAt

_governmentAuthority

_idempotencyKey

_joint

_naturalPerson

_riskRating

_status

_structure

_supplementalDocuments

_termsAgreements

_thirdPartyVerification

_trust

_type

_validation

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder