Download the original document image for the document represented by documentId to the saveDir folder. Only the saveDir is provided. The actual filename will be determined by this method. This method will create saveDir if it doesn't already exist. This method will fail if saveDir exists but is not a directory.

editDocument

abstract suspend fun editDocument(id: String, requestBody: EditDocumentBody): DataProviderResponse<String>

Edit the document with id - will modify the provided fields in the requestBody

getDocumentById

abstract suspend fun getDocumentById(id: String): DataProviderResponse<GetDocumentResponse>

Fetch a full document model by document id

getDocumentList

abstract suspend fun getDocumentList(params: DocumentListRequestParams): DataProviderResponse<DocumentListResponse>

Fetch a list of documents with configurable limit/search/filter parameters

longPollDocumentsStatus

abstract suspend fun longPollDocumentsStatus(vararg ids: String): DataProviderResponse<GetDocumentStatusResponse>

Long poll / wait for the DocumentStatus of one or more documents. The api will wait until one of the queried documents' statuses has changed, or when one or more documents have reached a terminal state to respond.

abstract suspend fun longPollDocumentsStatus(ids: List<String>): DataProviderResponse<GetDocumentStatusResponse>

uploadDocument

abstract suspend fun uploadDocument(payload: DocumentUploadPayload): DataProviderResponse<String>