lithic-kotlin-root/com.lithic.api.services.async/AccountHolderServiceAsyncImpl

AccountHolderServiceAsyncImpl

class AccountHolderServiceAsyncImpl : AccountHolderServiceAsync

Functions

Link copied to clipboard
open suspend override fun create(params: AccountHolderCreateParams, requestOptions: RequestOptions): AccountHolderCreateResponse

Create an account holder and initiate the appropriate onboarding workflow. Account holders and accounts have a 1:1 relationship. When an account holder is successfully created an associated account is also created. All calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cases, the response may indicate the workflow is under review or further action will be needed to complete the account creation process. This endpoint can only be used on accounts that are part of the program that the calling API key manages.

Link copied to clipboard
open suspend fun list(requestOptions: RequestOptions): AccountHolderListPageAsync

open suspend override fun list(params: AccountHolderListParams, requestOptions: RequestOptions): AccountHolderListPageAsync

Get a list of individual or business account holders and their KYC or KYB evaluation status.

Link copied to clipboard
open suspend fun listDocuments(accountHolderToken: String, requestOptions: RequestOptions): AccountHolderListDocumentsResponse
open suspend override fun listDocuments(params: AccountHolderListDocumentsParams, requestOptions: RequestOptions): AccountHolderListDocumentsResponse

open suspend fun listDocuments(accountHolderToken: String, params: AccountHolderListDocumentsParams = AccountHolderListDocumentsParams.none(), requestOptions: RequestOptions = RequestOptions.none()): AccountHolderListDocumentsResponse

Retrieve the status of account holder document uploads, or retrieve the upload URLs to process your image uploads.

Link copied to clipboard
open suspend fun retrieve(accountHolderToken: String, requestOptions: RequestOptions): AccountHolder
open suspend override fun retrieve(params: AccountHolderRetrieveParams, requestOptions: RequestOptions): AccountHolder

open suspend fun retrieve(accountHolderToken: String, params: AccountHolderRetrieveParams = AccountHolderRetrieveParams.none(), requestOptions: RequestOptions = RequestOptions.none()): AccountHolder

Get an Individual or Business Account Holder and/or their KYC or KYB evaluation status.

Link copied to clipboard
open suspend fun retrieveDocument(documentToken: String, params: AccountHolderRetrieveDocumentParams, requestOptions: RequestOptions = RequestOptions.none()): Document

Check the status of an account holder document upload, or retrieve the upload URLs to process your image uploads.

open suspend override fun retrieveDocument(params: AccountHolderRetrieveDocumentParams, requestOptions: RequestOptions): Document
Link copied to clipboard
open suspend override fun simulateEnrollmentDocumentReview(params: AccountHolderSimulateEnrollmentDocumentReviewParams, requestOptions: RequestOptions): Document

Simulates a review for an account holder document upload.

Link copied to clipboard
open suspend fun simulateEnrollmentReview(requestOptions: RequestOptions): AccountHolderSimulateEnrollmentReviewResponse

open suspend override fun simulateEnrollmentReview(params: AccountHolderSimulateEnrollmentReviewParams, requestOptions: RequestOptions): AccountHolderSimulateEnrollmentReviewResponse

Simulates an enrollment review for an account holder. This endpoint is only applicable for workflows that may required intervention such as KYB_BASIC.

Link copied to clipboard
open suspend fun update(accountHolderToken: String, params: AccountHolderUpdateParams, requestOptions: RequestOptions = RequestOptions.none()): AccountHolderUpdateResponse

Update the information associated with a particular account holder (including business owners and control persons associated to a business account). If Lithic is performing KYB or KYC and additional verification is required we will run the individual's or business's updated information again and return whether the status is accepted or pending (i.e., further action required). All calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cases, the response may indicate the workflow is under review or further action will be needed to complete the account creation process. This endpoint can only be used on existing accounts that are part of the program that the calling API key manages.

open suspend override fun update(params: AccountHolderUpdateParams, requestOptions: RequestOptions): AccountHolderUpdateResponse
Link copied to clipboard
open suspend fun uploadDocument(accountHolderToken: String, params: AccountHolderUploadDocumentParams, requestOptions: RequestOptions = RequestOptions.none()): Document

Use this endpoint to identify which type of supported government-issued documentation you will upload for further verification. It will return two URLs to upload your document images to - one for the front image and one for the back image.

open suspend override fun uploadDocument(params: AccountHolderUploadDocumentParams, requestOptions: RequestOptions): Document
Link copied to clipboard
open override fun withOptions(modifier: (ClientOptions.Builder) -> Unit): AccountHolderServiceAsync

Returns a view of this service with the given option modifications applied.

Link copied to clipboard
open override fun withRawResponse(): AccountHolderServiceAsync.WithRawResponse

Returns a view of this service that provides access to raw HTTP responses for each method.