Create a Document

POST/lokta-lms/api/v1/{entityType}/{entityId}/documents

Uploads a document and attaches it to an entity, as a multipart form.

Note: A document is created using a Multi-part form upload

Body parts

name : name or summary of the document
description : description of the document
file : the file to be uploaded
documentCategory : label of a DocumentCategory code value offered for this entity type
documentTag : label of a DocumentTags code value offered under that category

Mandatory fields :

file
description

Classification (documentCategory, documentTag) is optional, and validated against the mapping this entity
type has configured; read GET .../documents/template for the labels on offer. A documentTag without a
documentCategory, a label that is not an active code value, or a pair the taxonomy does not offer is a 400,
and nothing is stored. Both labels are snapshotted onto the document: renaming the code value later does not
rewrite what this document says it is.

Path parameters

entityTypepath · string · required

entityIdpath · integer · int64 · required

Header parameters

Content-Lengthheader · integer · int64 · optional

Responses

200OK

Response fields

resourceIdinteger · int64 · optional

resourceIdentifierstring · 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.post( "https://default.lokta.tech/lokta-lms/api/v1/{entityType}/{entityId}/documents", 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", { method: "POST", 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")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .method("POST", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/{entityType}/{entityId}/documents", 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))