Interface EntityService
-
- All Implemented Interfaces:
public interface EntityServiceEntitiesrepresent a business or organization that uses the API, and their customers.Dinari Partners are represented as an organization
Entityin the API, with their own accounts. Individual customers of PartnerEntitiesare also represented asEntitiesin the API, which are managed by the PartnerEntity.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceEntityService.WithRawResponseA view of EntityService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract EntityService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract EntityServicewithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. abstract AccountServiceaccounts()Accountsrepresent the financial accounts of anEntity.abstract KycServicekyc()KYC (Know Your Customer) is a process of verifying the identity of customer Entities.Entitycreate(EntityCreateParams params)Create a new Entityto be managed by your organization.abstract Entitycreate(EntityCreateParams params, RequestOptions requestOptions)Entityupdate(String entityId)Update a specific customer Entityof your organization.Entityupdate(String entityId, EntityUpdateParams params, RequestOptions requestOptions)Entityupdate(String entityId, EntityUpdateParams params)abstract Entityupdate(EntityUpdateParams params, RequestOptions requestOptions)Entityupdate(EntityUpdateParams params)Entityupdate(String entityId, RequestOptions requestOptions)List<Entity>list()Get a list of direct Entitiesyour organization manages.abstract List<Entity>list(EntityListParams params, RequestOptions requestOptions)List<Entity>list(EntityListParams params)List<Entity>list(RequestOptions requestOptions)EntityretrieveById(String entityId)Get a specific customer Entityof your organization by their ID.EntityretrieveById(String entityId, EntityRetrieveByIdParams params, RequestOptions requestOptions)EntityretrieveById(String entityId, EntityRetrieveByIdParams params)abstract EntityretrieveById(EntityRetrieveByIdParams params, RequestOptions requestOptions)EntityretrieveById(EntityRetrieveByIdParams params)EntityretrieveById(String entityId, RequestOptions requestOptions)EntityretrieveCurrent()Get the current authenticated Entity, which represents your organization.abstract EntityretrieveCurrent(EntityRetrieveCurrentParams params, RequestOptions requestOptions)EntityretrieveCurrent(EntityRetrieveCurrentParams params)EntityretrieveCurrent(RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract EntityService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract EntityService 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 AccountService accounts()
Accountsrepresent the financial accounts of anEntity.Orders, dividends, and other transactions are associated with anAccount.
-
kyc
abstract KycService kyc()
KYC (Know Your Customer) is a process of verifying the identity of customer
Entities.KYC is required for all customer
Entitiesthat 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
Entity create(EntityCreateParams params)
Create a new
Entityto be managed by your organization. ThisEntityrepresents an individual customer of your organization.
-
create
abstract Entity create(EntityCreateParams params, RequestOptions requestOptions)
-
update
Entity update(String entityId, EntityUpdateParams params, RequestOptions requestOptions)
-
update
Entity update(String entityId, EntityUpdateParams params)
-
update
abstract Entity update(EntityUpdateParams params, RequestOptions requestOptions)
-
update
Entity update(EntityUpdateParams params)
-
update
Entity update(String entityId, RequestOptions requestOptions)
-
list
List<Entity> list()
Get a list of direct
Entitiesyour organization manages. TheseEntitiesrepresent individual customers of your organization.
-
list
abstract List<Entity> list(EntityListParams params, RequestOptions requestOptions)
-
list
List<Entity> list(EntityListParams params)
-
list
List<Entity> list(RequestOptions requestOptions)
-
retrieveById
Entity retrieveById(String entityId)
Get a specific customer
Entityof your organization by their ID.
-
retrieveById
Entity retrieveById(String entityId, EntityRetrieveByIdParams params, RequestOptions requestOptions)
-
retrieveById
Entity retrieveById(String entityId, EntityRetrieveByIdParams params)
-
retrieveById
abstract Entity retrieveById(EntityRetrieveByIdParams params, RequestOptions requestOptions)
-
retrieveById
Entity retrieveById(EntityRetrieveByIdParams params)
-
retrieveById
Entity retrieveById(String entityId, RequestOptions requestOptions)
-
retrieveCurrent
Entity retrieveCurrent()
Get the current authenticated
Entity, which represents your organization.
-
retrieveCurrent
abstract Entity retrieveCurrent(EntityRetrieveCurrentParams params, RequestOptions requestOptions)
-
retrieveCurrent
Entity retrieveCurrent(EntityRetrieveCurrentParams params)
-
retrieveCurrent
Entity retrieveCurrent(RequestOptions requestOptions)
-
-
-
-