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


public final class EntityUpdateParams
 implements Params

Update an Entity

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`EntityUpdateParams.Builder`	A builder for EntityUpdateParams.
`public final class`	`EntityUpdateParams.Body`
`public final class`	`EntityUpdateParams.Corporation`	Details of the corporation entity to update. If you specify this parameter and the entity is not a corporation, the request will fail.
`public final class`	`EntityUpdateParams.GovernmentAuthority`	Details of the government authority entity to update. If you specify this parameter and the entity is not a government authority, the request will fail.
`public final class`	`EntityUpdateParams.NaturalPerson`	Details of the natural person entity to update. If you specify this parameter and the entity is not a natural person, the request will fail.
`public final class`	`EntityUpdateParams.RiskRating`	An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
`public final class`	`EntityUpdateParams.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`	`EntityUpdateParams.Trust`	Details of the trust entity to update. If you specify this parameter and the entity is not a trust, the request will fail.

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 Optional<String>`	`entityId()`	The entity identifier.
`final Optional<EntityUpdateParams.Corporation>`	`corporation()`	Details of the corporation entity to update.
`final Optional<OffsetDateTime>`	`detailsConfirmedAt()`	When your user last confirmed the Entity's details.
`final Optional<EntityUpdateParams.GovernmentAuthority>`	`governmentAuthority()`	Details of the government authority entity to update.
`final Optional<EntityUpdateParams.NaturalPerson>`	`naturalPerson()`	Details of the natural person entity to update.
`final Optional<EntityUpdateParams.RiskRating>`	`riskRating()`	An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
`final Optional<EntityUpdateParams.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<EntityUpdateParams.Trust>`	`trust()`	Details of the trust entity to update.
`final JsonField<EntityUpdateParams.Corporation>`	`_corporation()`	Returns the raw JSON value of corporation.
`final JsonField<OffsetDateTime>`	`_detailsConfirmedAt()`	Returns the raw JSON value of detailsConfirmedAt.
`final JsonField<EntityUpdateParams.GovernmentAuthority>`	`_governmentAuthority()`	Returns the raw JSON value of governmentAuthority.
`final JsonField<EntityUpdateParams.NaturalPerson>`	`_naturalPerson()`	Returns the raw JSON value of naturalPerson.
`final JsonField<EntityUpdateParams.RiskRating>`	`_riskRating()`	Returns the raw JSON value of riskRating.
`final JsonField<EntityUpdateParams.ThirdPartyVerification>`	`_thirdPartyVerification()`	Returns the raw JSON value of thirdPartyVerification.
`final JsonField<EntityUpdateParams.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 EntityUpdateParams.Builder`	`toBuilder()`
`final EntityUpdateParams.Body`	`_body()`
`final String`	`_pathParam(Integer index)`
`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 EntityUpdateParams`	`none()`
`final static EntityUpdateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of EntityUpdateParams.

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

- Constructor Detail
- Method Detail
  - entityId
```
 final Optional<String> entityId()
```
    The entity identifier.
  - corporation
```
 final Optional<EntityUpdateParams.Corporation> corporation()
```
    Details of the corporation entity to update. If you specify this parameter and the entity is not a corporation, the request will fail.
  - detailsConfirmedAt
```
 final Optional<OffsetDateTime> detailsConfirmedAt()
```
    When your user last confirmed the Entity's details. Depending on your program, you may be required to affirmatively confirm details with your users on an annual basis.
  - governmentAuthority
```
 final Optional<EntityUpdateParams.GovernmentAuthority> governmentAuthority()
```
    Details of the government authority entity to update. If you specify this parameter and the entity is not a government authority, the request will fail.
  - naturalPerson
```
 final Optional<EntityUpdateParams.NaturalPerson> naturalPerson()
```
    Details of the natural person entity to update. If you specify this parameter and the entity is not a natural person, the request will fail.
  - riskRating
```
 final Optional<EntityUpdateParams.RiskRating> riskRating()
```
    An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.
  - thirdPartyVerification
```
 final Optional<EntityUpdateParams.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<EntityUpdateParams.Trust> trust()
```
    Details of the trust entity to update. If you specify this parameter and the entity is not a trust, the request will fail.
  - _corporation
```
 final JsonField<EntityUpdateParams.Corporation> _corporation()
```
    Returns the raw JSON value of corporation.
    Unlike corporation, 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<EntityUpdateParams.GovernmentAuthority> _governmentAuthority()
```
    Returns the raw JSON value of governmentAuthority.
    Unlike governmentAuthority, this method doesn't throw if the JSON field has an unexpected type.
  - _naturalPerson
```
 final JsonField<EntityUpdateParams.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<EntityUpdateParams.RiskRating> _riskRating()
```
    Returns the raw JSON value of riskRating.
    Unlike riskRating, this method doesn't throw if the JSON field has an unexpected type.
  - _thirdPartyVerification
```
 final JsonField<EntityUpdateParams.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<EntityUpdateParams.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 EntityUpdateParams.Builder toBuilder()
```
  - _body
```
 final EntityUpdateParams.Body _body()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _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()
```
  - none
```
 final static EntityUpdateParams none()
```
  - builder
```
 final static EntityUpdateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of EntityUpdateParams.

Class EntityUpdateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

entityId

corporation

detailsConfirmedAt

governmentAuthority

naturalPerson

riskRating

thirdPartyVerification

trust

_corporation

_detailsConfirmedAt

_governmentAuthority

_naturalPerson

_riskRating

_thirdPartyVerification

_trust

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

none

builder