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.

• create

   CompletableFuture<Entity> create(EntityCreateParams params)

  Create an Entity

• create

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

• retrieve

   CompletableFuture<Entity> retrieve(String entityId)

  Retrieve an Entity

• retrieve

   CompletableFuture<Entity> retrieve(String entityId, EntityRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Entity> retrieve(String entityId, EntityRetrieveParams params)

• retrieve

   abstract CompletableFuture<Entity> retrieve(EntityRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Entity> retrieve(EntityRetrieveParams params)

• retrieve

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

• list

   CompletableFuture<EntityListPageAsync> list()

  List Entities

• list

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

• list

   CompletableFuture<EntityListPageAsync> list(EntityListParams params)

• list

   CompletableFuture<EntityListPageAsync> list(RequestOptions requestOptions)

• archive

   CompletableFuture<Entity> archive(String entityId)

  Archive an Entity

• archive

   CompletableFuture<Entity> archive(String entityId, EntityArchiveParams params, RequestOptions requestOptions)

• archive

   CompletableFuture<Entity> archive(String entityId, EntityArchiveParams params)

• archive

   abstract CompletableFuture<Entity> archive(EntityArchiveParams params, RequestOptions requestOptions)

• archive

   CompletableFuture<Entity> archive(EntityArchiveParams params)

• archive

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

• archiveBeneficialOwner

   CompletableFuture<Entity> archiveBeneficialOwner(String entityId, EntityArchiveBeneficialOwnerParams params)

  Archive a beneficial owner for a corporate Entity

• archiveBeneficialOwner

   CompletableFuture<Entity> archiveBeneficialOwner(String entityId, EntityArchiveBeneficialOwnerParams params, RequestOptions requestOptions)

• archiveBeneficialOwner

   CompletableFuture<Entity> archiveBeneficialOwner(EntityArchiveBeneficialOwnerParams params)

• archiveBeneficialOwner

   abstract CompletableFuture<Entity> archiveBeneficialOwner(EntityArchiveBeneficialOwnerParams params, RequestOptions requestOptions)

• confirm

   CompletableFuture<Entity> confirm(String entityId)

  Depending on your program, you may be required to re-confirm an Entity's details on a recurring basis. After making any required updates, call this endpoint to record that your user confirmed their details.

• confirm

   CompletableFuture<Entity> confirm(String entityId, EntityConfirmParams params, RequestOptions requestOptions)

• confirm

   CompletableFuture<Entity> confirm(String entityId, EntityConfirmParams params)

• confirm

   abstract CompletableFuture<Entity> confirm(EntityConfirmParams params, RequestOptions requestOptions)

• confirm

   CompletableFuture<Entity> confirm(EntityConfirmParams params)

• confirm

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

• createBeneficialOwner

   CompletableFuture<Entity> createBeneficialOwner(String entityId, EntityCreateBeneficialOwnerParams params)

  Create a beneficial owner for a corporate Entity

• createBeneficialOwner

   CompletableFuture<Entity> createBeneficialOwner(String entityId, EntityCreateBeneficialOwnerParams params, RequestOptions requestOptions)

• createBeneficialOwner

   CompletableFuture<Entity> createBeneficialOwner(EntityCreateBeneficialOwnerParams params)

• createBeneficialOwner

   abstract CompletableFuture<Entity> createBeneficialOwner(EntityCreateBeneficialOwnerParams params, RequestOptions requestOptions)

• updateAddress

   CompletableFuture<Entity> updateAddress(String entityId, EntityUpdateAddressParams params)

  Update a Natural Person or Corporation's address

• updateAddress

   CompletableFuture<Entity> updateAddress(String entityId, EntityUpdateAddressParams params, RequestOptions requestOptions)

• updateAddress

   CompletableFuture<Entity> updateAddress(EntityUpdateAddressParams params)

• updateAddress

   abstract CompletableFuture<Entity> updateAddress(EntityUpdateAddressParams params, RequestOptions requestOptions)

• updateBeneficialOwnerAddress

   CompletableFuture<Entity> updateBeneficialOwnerAddress(String entityId, EntityUpdateBeneficialOwnerAddressParams params)

  Update the address for a beneficial owner belonging to a corporate Entity

• updateBeneficialOwnerAddress

   CompletableFuture<Entity> updateBeneficialOwnerAddress(String entityId, EntityUpdateBeneficialOwnerAddressParams params, RequestOptions requestOptions)

• updateBeneficialOwnerAddress

   CompletableFuture<Entity> updateBeneficialOwnerAddress(EntityUpdateBeneficialOwnerAddressParams params)

• updateBeneficialOwnerAddress

   abstract CompletableFuture<Entity> updateBeneficialOwnerAddress(EntityUpdateBeneficialOwnerAddressParams params, RequestOptions requestOptions)

• updateIndustryCode

   CompletableFuture<Entity> updateIndustryCode(String entityId, EntityUpdateIndustryCodeParams params)

  Update the industry code for a corporate Entity

• updateIndustryCode

   CompletableFuture<Entity> updateIndustryCode(String entityId, EntityUpdateIndustryCodeParams params, RequestOptions requestOptions)

• updateIndustryCode

   CompletableFuture<Entity> updateIndustryCode(EntityUpdateIndustryCodeParams params)

• updateIndustryCode

   abstract CompletableFuture<Entity> updateIndustryCode(EntityUpdateIndustryCodeParams params, RequestOptions requestOptions)