Verify authentication

POST/lokta-lms/api/v1/authentication

Authenticates the credentials provided and returns the set roles and permissions allowed.

When to use it

Call this first to confirm a username and password work on the tenant and to read the roles and permissions that user holds. Every other endpoint authenticates the same way, so there is no token to keep.

Request body application/json

passwordstring · required

usernamestring · required

Responses

200OK

400Unauthenticated. Please login

403Password reset required

Response fields

authenticatedboolean · optional

base64EncodedAuthenticationKeystring · optional

officeIdinteger · int64 · optional

officeNamestring · optional

organisationalRoleEnumOptionData · optional

permissionsarray · optional

rolesarray of RoleData · optional

staffDisplayNamestring · optional

staffIdinteger · int64 · optional

userIdinteger · int64 · optional

usernamestring · 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

curl -X POST \ 'https://default.lokta.tech/lokta-lms/api/v1/authentication' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "password": "password", "username": "admin" }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/authentication", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "password": "password", "username": "admin" }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/authentication", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "password": "password", "username": "admin" }), }); console.log(await response.json());

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

payload := strings.NewReader(`{ "password": "password", "username": "admin" }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/authentication", payload) req.SetBasicAuth("{username}", "{password}") req.Header.Set("Tenant-Identifier", "default") req.Header.Set("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(string(data))