All Implemented Interfaces:
```
public interface EntityServiceAsync

                    
```
Entities represent a business or organization that uses the API, and their customers.
Dinari Partners are represented as an organization Entity in the API, with their own accounts. Individual customers of Partner Entities are also represented as Entities in the API, which are managed by the Partner Entity.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`EntityServiceAsync.WithRawResponse`	A view of EntityServiceAsync that provides access to raw HTTP responses for each method.

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
`abstract EntityServiceAsync.WithRawResponse`	`withRawResponse()`	Returns a view of this service that provides access to raw HTTP responses for each method.
`abstract EntityServiceAsync`	`withOptions(Consumer<ClientOptions.Builder> modifier)`	Returns a view of this service with the given option modifications applied.
`abstract AccountServiceAsync`	`accounts()`	`Accounts` represent the financial accounts of an `Entity`.
`abstract KycServiceAsync`	`kyc()`	KYC (Know Your Customer) is a process of verifying the identity of customer `Entities`.
`CompletableFuture<Entity>`	`create(EntityCreateParams params)`	Create a new `Entity` to be managed by your organization.
`abstract CompletableFuture<Entity>`	`create(EntityCreateParams params, RequestOptions requestOptions)`
`CompletableFuture<Entity>`	`update(String entityId)`	Update a specific customer `Entity` of your organization.
`CompletableFuture<Entity>`	`update(String entityId, EntityUpdateParams params, RequestOptions requestOptions)`
`CompletableFuture<Entity>`	`update(String entityId, EntityUpdateParams params)`
`abstract CompletableFuture<Entity>`	`update(EntityUpdateParams params, RequestOptions requestOptions)`
`CompletableFuture<Entity>`	`update(EntityUpdateParams params)`
`CompletableFuture<Entity>`	`update(String entityId, RequestOptions requestOptions)`
`CompletableFuture<List<Entity>>`	`list()`	Get a list of direct `Entities` your organization manages.
`abstract CompletableFuture<List<Entity>>`	`list(EntityListParams params, RequestOptions requestOptions)`
`CompletableFuture<List<Entity>>`	`list(EntityListParams params)`
`CompletableFuture<List<Entity>>`	`list(RequestOptions requestOptions)`
`CompletableFuture<Entity>`	`retrieveById(String entityId)`	Get a specific customer `Entity` of your organization by their ID.
`CompletableFuture<Entity>`	`retrieveById(String entityId, EntityRetrieveByIdParams params, RequestOptions requestOptions)`
`CompletableFuture<Entity>`	`retrieveById(String entityId, EntityRetrieveByIdParams params)`
`abstract CompletableFuture<Entity>`	`retrieveById(EntityRetrieveByIdParams params, RequestOptions requestOptions)`
`CompletableFuture<Entity>`	`retrieveById(EntityRetrieveByIdParams params)`
`CompletableFuture<Entity>`	`retrieveById(String entityId, RequestOptions requestOptions)`
`CompletableFuture<Entity>`	`retrieveCurrent()`	Get the current authenticated `Entity`, which represents your organization.
`abstract CompletableFuture<Entity>`	`retrieveCurrent(EntityRetrieveCurrentParams params, RequestOptions requestOptions)`
`CompletableFuture<Entity>`	`retrieveCurrent(EntityRetrieveCurrentParams params)`
`CompletableFuture<Entity>`	`retrieveCurrent(RequestOptions requestOptions)`

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

Constructor Detail

Method Detail

withRawResponse
```
 abstract EntityServiceAsync.WithRawResponse withRawResponse()
```
Returns a view of this service that provides access to raw HTTP responses for each method.

withOptions
```
 abstract EntityServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)
```
Returns a view of this service with the given option modifications applied.
The original service is not modified.

accounts
```
 abstract AccountServiceAsync accounts()
```
Accounts represent the financial accounts of an Entity.
Orders, dividends, and other transactions are associated with an Account.

kyc
```
 abstract KycServiceAsync kyc()
```
KYC (Know Your Customer) is a process of verifying the identity of customer Entities.
KYC is required for all customer Entities that transact on Dinari's platform.
Dinari provides a managed KYC process for its Partners, which provides a convenient KYC flow URL to present to the end customer.
For Dinari Partners that supply their own KYC data, the API provides a way to record a customer's KYC information using the Partner's KYC data. This requires an existing KYC agreement between Dinari and the Partner.

create
```
 CompletableFuture<Entity> create(EntityCreateParams params)
```
Create a new Entity to be managed by your organization. This Entity represents an individual customer of your organization.

create

 abstract CompletableFuture<Entity> create(EntityCreateParams params, RequestOptions requestOptions)

update
```
 CompletableFuture<Entity> update(String entityId)
```
Update a specific customer Entity of your organization.

update

 CompletableFuture<Entity> update(String entityId, EntityUpdateParams params, RequestOptions requestOptions)

update

 CompletableFuture<Entity> update(String entityId, EntityUpdateParams params)

update

 abstract CompletableFuture<Entity> update(EntityUpdateParams params, RequestOptions requestOptions)

update

 CompletableFuture<Entity> update(EntityUpdateParams params)

update

 CompletableFuture<Entity> update(String entityId, RequestOptions requestOptions)

list
```
 CompletableFuture<List<Entity>> list()
```
Get a list of direct Entities your organization manages. These Entities represent individual customers of your organization.

list

 abstract CompletableFuture<List<Entity>> list(EntityListParams params, RequestOptions requestOptions)

list

 CompletableFuture<List<Entity>> list(EntityListParams params)

list

 CompletableFuture<List<Entity>> list(RequestOptions requestOptions)

retrieveById
```
 CompletableFuture<Entity> retrieveById(String entityId)
```
Get a specific customer Entity of your organization by their ID.

retrieveById

 CompletableFuture<Entity> retrieveById(String entityId, EntityRetrieveByIdParams params, RequestOptions requestOptions)

retrieveById

 CompletableFuture<Entity> retrieveById(String entityId, EntityRetrieveByIdParams params)

retrieveById

 abstract CompletableFuture<Entity> retrieveById(EntityRetrieveByIdParams params, RequestOptions requestOptions)

retrieveById

 CompletableFuture<Entity> retrieveById(EntityRetrieveByIdParams params)

retrieveById

 CompletableFuture<Entity> retrieveById(String entityId, RequestOptions requestOptions)

retrieveCurrent
```
 CompletableFuture<Entity> retrieveCurrent()
```
Get the current authenticated Entity, which represents your organization.

retrieveCurrent

 abstract CompletableFuture<Entity> retrieveCurrent(EntityRetrieveCurrentParams params, RequestOptions requestOptions)

retrieveCurrent

 CompletableFuture<Entity> retrieveCurrent(EntityRetrieveCurrentParams params)

retrieveCurrent

 CompletableFuture<Entity> retrieveCurrent(RequestOptions requestOptions)

Interface EntityServiceAsync

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

withRawResponse

withOptions

accounts

kyc

create

create

update

update

update

update

update

update

list

list

list

list

retrieveById

retrieveById

retrieveById

retrieveById

retrieveById

retrieveById

retrieveCurrent

retrieveCurrent

retrieveCurrent

retrieveCurrent