All Implemented Interfaces:: com.increase.api.core.Params


public final class EntityCreateParams
 implements Params

Create an Entity

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`EntityCreateParams.Body`
`public final class`	`EntityCreateParams.Builder`	A builder for EntityCreateParams.
`public final class`	`EntityCreateParams.Structure`	The type of Entity to create.
`public final class`	`EntityCreateParams.Corporation`	Details of the corporation entity to create. Required if `structure` is equal to `corporation`.
`public final class`	`EntityCreateParams.GovernmentAuthority`	Details of the Government Authority entity to create. Required if `structure` is equal to `Government Authority`.
`public final class`	`EntityCreateParams.Joint`	Details of the joint entity to create. Required if `structure` is equal to `joint`.
`public final class`	`EntityCreateParams.NaturalPerson`	Details of the natural person entity to create. Required if `structure` is equal to `natural_person`. Natural people entities should be submitted with `social_security_number` or `individual_taxpayer_identification_number` identification methods.
`public final class`	`EntityCreateParams.SupplementalDocument`
`public final class`	`EntityCreateParams.ThirdPartyVerification`	A reference to data stored in a third-party verification service. Your integration may or may not use this field.
`public final class`	`EntityCreateParams.Trust`	Details of the trust entity to create. Required if `structure` is equal to `trust`.

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 EntityCreateParams.Structure`	`structure()`	The type of Entity to create.
`final Optional<EntityCreateParams.Corporation>`	`corporation()`	Details of the corporation entity to create.
`final Optional<String>`	`description()`	The description you choose to give the entity.
`final Optional<EntityCreateParams.GovernmentAuthority>`	`governmentAuthority()`	Details of the Government Authority entity to create.
`final Optional<EntityCreateParams.Joint>`	`joint()`	Details of the joint entity to create.
`final Optional<EntityCreateParams.NaturalPerson>`	`naturalPerson()`	Details of the natural person entity to create.
`final Optional<List<EntityCreateParams.SupplementalDocument>>`	`supplementalDocuments()`	Additional documentation associated with the entity.
`final Optional<EntityCreateParams.ThirdPartyVerification>`	`thirdPartyVerification()`	A reference to data stored in a third-party verification service.
`final Optional<EntityCreateParams.Trust>`	`trust()`	Details of the trust entity to create.
`final JsonField<EntityCreateParams.Structure>`	`_structure()`	The type of Entity to create.
`final JsonField<EntityCreateParams.Corporation>`	`_corporation()`	Details of the corporation entity to create.
`final JsonField<String>`	`_description()`	The description you choose to give the entity.
`final JsonField<EntityCreateParams.GovernmentAuthority>`	`_governmentAuthority()`	Details of the Government Authority entity to create.
`final JsonField<EntityCreateParams.Joint>`	`_joint()`	Details of the joint entity to create.
`final JsonField<EntityCreateParams.NaturalPerson>`	`_naturalPerson()`	Details of the natural person entity to create.
`final JsonField<List<EntityCreateParams.SupplementalDocument>>`	`_supplementalDocuments()`	Additional documentation associated with the entity.
`final JsonField<EntityCreateParams.ThirdPartyVerification>`	`_thirdPartyVerification()`	A reference to data stored in a third-party verification service.
`final JsonField<EntityCreateParams.Trust>`	`_trust()`	Details of the trust entity to create.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`final EntityCreateParams.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static EntityCreateParams.Builder`	`builder()`

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

- Constructor Detail
- Method Detail
  - structure
```
 final EntityCreateParams.Structure structure()
```
    The type of Entity to create.
  - corporation
```
 final Optional<EntityCreateParams.Corporation> corporation()
```
    Details of the corporation entity to create. Required if structure is equal to corporation.
  - description
```
 final Optional<String> description()
```
    The description you choose to give the entity.
  - governmentAuthority
```
 final Optional<EntityCreateParams.GovernmentAuthority> governmentAuthority()
```
    Details of the Government Authority entity to create. Required if structure is equal to Government Authority.
  - joint
```
 final Optional<EntityCreateParams.Joint> joint()
```
    Details of the joint entity to create. Required if structure is equal to joint.
  - naturalPerson
```
 final Optional<EntityCreateParams.NaturalPerson> naturalPerson()
```
    Details of the natural person entity to create. Required if structure is equal to natural_person. Natural people entities should be submitted with social_security_number or individual_taxpayer_identification_number identification methods.
  - supplementalDocuments
```
 final Optional<List<EntityCreateParams.SupplementalDocument>> supplementalDocuments()
```
    Additional documentation associated with the entity.
  - thirdPartyVerification
```
 final Optional<EntityCreateParams.ThirdPartyVerification> thirdPartyVerification()
```
    A reference to data stored in a third-party verification service. Your integration may or may not use this field.
  - trust
```
 final Optional<EntityCreateParams.Trust> trust()
```
    Details of the trust entity to create. Required if structure is equal to trust.
  - _structure
```
 final JsonField<EntityCreateParams.Structure> _structure()
```
    The type of Entity to create.
  - _corporation
```
 final JsonField<EntityCreateParams.Corporation> _corporation()
```
    Details of the corporation entity to create. Required if structure is equal to corporation.
  - _description
```
 final JsonField<String> _description()
```
    The description you choose to give the entity.
  - _governmentAuthority
```
 final JsonField<EntityCreateParams.GovernmentAuthority> _governmentAuthority()
```
    Details of the Government Authority entity to create. Required if structure is equal to Government Authority.
  - _joint
```
 final JsonField<EntityCreateParams.Joint> _joint()
```
    Details of the joint entity to create. Required if structure is equal to joint.
  - _naturalPerson
```
 final JsonField<EntityCreateParams.NaturalPerson> _naturalPerson()
```
    Details of the natural person entity to create. Required if structure is equal to natural_person. Natural people entities should be submitted with social_security_number or individual_taxpayer_identification_number identification methods.
  - _supplementalDocuments
```
 final JsonField<List<EntityCreateParams.SupplementalDocument>> _supplementalDocuments()
```
    Additional documentation associated with the entity.
  - _thirdPartyVerification
```
 final JsonField<EntityCreateParams.ThirdPartyVerification> _thirdPartyVerification()
```
    A reference to data stored in a third-party verification service. Your integration may or may not use this field.
  - _trust
```
 final JsonField<EntityCreateParams.Trust> _trust()
```
    Details of the trust entity to create. Required if structure is equal to trust.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - toBuilder
```
 final EntityCreateParams.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static EntityCreateParams.Builder builder()
```

Class EntityCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

structure

corporation

description

governmentAuthority

joint

naturalPerson

supplementalDocuments

thirdPartyVerification

trust

_structure

_corporation

_description

_governmentAuthority

_joint

_naturalPerson

_supplementalDocuments

_thirdPartyVerification

_trust

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

_headers

_queryParams

toBuilder

equals

hashCode

toString

builder