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.Builder`	A builder for EntityCreateParams.
`public final class`	`EntityCreateParams.Body`
`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.RiskRating`	An assessment of the entity's potential risk of involvement in financial crimes, such as money laundering.
`public final class`	`EntityCreateParams.SupplementalDocument`
`public final class`	`EntityCreateParams.TermsAgreement`
`public final class`	`EntityCreateParams.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`	`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<EntityCreateParams.RiskRating>`	`riskRating()`	An assessment of the entity's potential risk of involvement in financial crimes, such as money laundering.
`final Optional<List<EntityCreateParams.SupplementalDocument>>`	`supplementalDocuments()`	Additional documentation associated with the entity.
`final Optional<List<EntityCreateParams.TermsAgreement>>`	`termsAgreements()`	The terms that the Entity agreed to.
`final Optional<EntityCreateParams.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<EntityCreateParams.Trust>`	`trust()`	Details of the trust entity to create.
`final JsonField<EntityCreateParams.Structure>`	`_structure()`	Returns the raw JSON value of structure.
`final JsonField<EntityCreateParams.Corporation>`	`_corporation()`	Returns the raw JSON value of corporation.
`final JsonField<String>`	`_description()`	Returns the raw JSON value of description.
`final JsonField<EntityCreateParams.GovernmentAuthority>`	`_governmentAuthority()`	Returns the raw JSON value of governmentAuthority.
`final JsonField<EntityCreateParams.Joint>`	`_joint()`	Returns the raw JSON value of joint.
`final JsonField<EntityCreateParams.NaturalPerson>`	`_naturalPerson()`	Returns the raw JSON value of naturalPerson.
`final JsonField<EntityCreateParams.RiskRating>`	`_riskRating()`	Returns the raw JSON value of riskRating.
`final JsonField<List<EntityCreateParams.SupplementalDocument>>`	`_supplementalDocuments()`	Returns the raw JSON value of supplementalDocuments.
`final JsonField<List<EntityCreateParams.TermsAgreement>>`	`_termsAgreements()`	Returns the raw JSON value of termsAgreements.
`final JsonField<EntityCreateParams.ThirdPartyVerification>`	`_thirdPartyVerification()`	Returns the raw JSON value of thirdPartyVerification.
`final JsonField<EntityCreateParams.Trust>`	`_trust()`	Returns the raw JSON value of trust.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final EntityCreateParams.Builder`	`toBuilder()`
`final EntityCreateParams.Body`	`_body()`
`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.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static EntityCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of EntityCreateParams.

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.
  - riskRating
```
 final Optional<EntityCreateParams.RiskRating> riskRating()
```
    An assessment of the entity's potential risk of involvement in financial crimes, such as money laundering.
  - supplementalDocuments
```
 final Optional<List<EntityCreateParams.SupplementalDocument>> supplementalDocuments()
```
    Additional documentation associated with the entity.
  - termsAgreements
```
 final Optional<List<EntityCreateParams.TermsAgreement>> termsAgreements()
```
    The terms that the Entity agreed to. Not all programs are required to submit this data.
  - thirdPartyVerification
```
 final Optional<EntityCreateParams.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<EntityCreateParams.Trust> trust()
```
    Details of the trust entity to create. Required if structure is equal to trust.
  - _structure
```
 final JsonField<EntityCreateParams.Structure> _structure()
```
    Returns the raw JSON value of structure.
    Unlike structure, this method doesn't throw if the JSON field has an unexpected type.
  - _corporation
```
 final JsonField<EntityCreateParams.Corporation> _corporation()
```
    Returns the raw JSON value of corporation.
    Unlike corporation, 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.
  - _governmentAuthority
```
 final JsonField<EntityCreateParams.GovernmentAuthority> _governmentAuthority()
```
    Returns the raw JSON value of governmentAuthority.
    Unlike governmentAuthority, this method doesn't throw if the JSON field has an unexpected type.
  - _joint
```
 final JsonField<EntityCreateParams.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<EntityCreateParams.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<EntityCreateParams.RiskRating> _riskRating()
```
    Returns the raw JSON value of riskRating.
    Unlike riskRating, this method doesn't throw if the JSON field has an unexpected type.
  - _supplementalDocuments
```
 final JsonField<List<EntityCreateParams.SupplementalDocument>> _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<EntityCreateParams.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<EntityCreateParams.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<EntityCreateParams.Trust> _trust()
```
    Returns the raw JSON value of trust.
    Unlike trust, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final EntityCreateParams.Builder toBuilder()
```
  - _body
```
 final EntityCreateParams.Body _body()
```
  - _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.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static EntityCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of EntityCreateParams.
    The following fields are required:
    .structure()

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

riskRating

supplementalDocuments

termsAgreements

thirdPartyVerification

trust

_structure

_corporation

_description

_governmentAuthority

_joint

_naturalPerson

_riskRating

_supplementalDocuments

_termsAgreements

_thirdPartyVerification

_trust

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder