Retrieve a Document

GET/lokta-lms/api/v1/{entityType}/{entityId}/documents/{documentId}

Returns the details of one document attached to an entity.

Example Requests:

clients/1/documents/1
loans/1/documents/1
client_identifiers/1/documents/1?fields=name,description

Path parameters

entityTypepath · string · required

entityIdpath · integer · int64 · required

documentIdpath · integer · int64 · required

Responses

defaultdefault response

Response fields

descriptionstring · optional

documentCategorystring · optional

documentTagstring · optional

fileNamestring · optional

idinteger · int64 · optional

locationstring · optional

namestring · optional

parentEntityIdinteger · int64 · optional

parentEntityTypestring · optional

sizeinteger · int64 · optional

storageTypeinteger · int32 · optional

typestring · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.

This is the API reference for Lokta, the agentic loan servicing platform. Go to lokta.ai

import requests response = requests.get( "https://default.lokta.tech/lokta-lms/api/v1/{entityType}/{entityId}/documents/{documentId}", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/{entityType}/{entityId}/documents/{documentId}", { method: "GET", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", }, }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://default.lokta.tech/lokta-lms/api/v1/{entityType}/{entityId}/documents/{documentId}")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

req, _ := http.NewRequest("GET", "https://default.lokta.tech/lokta-lms/api/v1/{entityType}/{entityId}/documents/{documentId}", nil) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))