Create a Client

POST/lokta-lms/api/v1/clients

Creates a client, the borrower record that loans are applied against.

Note:

1. You can enter either:firstname/middlename/lastname - for a person (middlename is optional) OR fullname - for a business or organisation (or person known by one name).

2.If address is enable(enable-address=true), then additional field called address has to be passed.

Mandatory Fields: firstname and lastname OR fullname, officeId, active=true and activationDate OR active=false, if(address enabled) address

Optional Fields: externalId, accountNo, staffId, mobileNo, genderId, clientTypeId, clientClassificationId

When to use it

Create the client before anything else. A loan application takes a clientId, so a borrower has to exist first.

Worth knowing

Send firstname and lastname for a person, or fullname for a business or an organisation.
Send active=true with an activationDate, or active=false.
Send dateFormat and locale with every date. See the conventions page.

Request body application/json

activationDatestring · optional

activeboolean · optional

addressarray of ClientAddressRequest · optional

Address requests

datatablesarray of PostClientsDatatable · optional

List of PostClientsDatatable

dateFormatstring · optional

dateOfBirthstring · date · optional

emailAddressstring · optional

externalIdstring · optional

firstnamestring · optional

fullnamestring · optional

lastnamestring · optional

legalFormIdinteger · int64 · optional

localestring · optional

middlenamestring · optional

mobileNostring · optional

officeIdinteger · int64 · optional

submittedOnDatestring · optional

Responses

200OK

Response fields

clientIdinteger · int64 · optional

officeIdinteger · int64 · optional

resourceExternalIdstring · optional

resourceIdinteger · int64 · 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/clients' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "activationDate": "04 March 2009", "active": true, "address": [ { "addressId": 1, "addressLine1": "string", "addressLine2": "string", "addressLine3": "string" } ], "datatables": [ { "data": "data", "registeredTableName": "Client Beneficiary information" } ], "dateFormat": "dd MMMM yyyy", "dateOfBirth": "19 August 2026", "emailAddress": "[email protected]", "externalId": "123", "firstname": "Client_FirstName", "fullname": "Client full name" }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/clients", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "activationDate": "04 March 2009", "active": True, "address": [ { "addressId": 1, "addressLine1": "string", "addressLine2": "string", "addressLine3": "string" } ], "datatables": [ { "data": "data", "registeredTableName": "Client Beneficiary information" } ], "dateFormat": "dd MMMM yyyy", "dateOfBirth": "19 August 2026", "emailAddress": "[email protected]", "externalId": "123", "firstname": "Client_FirstName", "fullname": "Client full name" }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/clients", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "activationDate": "04 March 2009", "active": true, "address": [ { "addressId": 1, "addressLine1": "string", "addressLine2": "string", "addressLine3": "string" } ], "datatables": [ { "data": "data", "registeredTableName": "Client Beneficiary information" } ], "dateFormat": "dd MMMM yyyy", "dateOfBirth": "19 August 2026", "emailAddress": "[email protected]", "externalId": "123", "firstname": "Client_FirstName", "fullname": "Client full name" }), }); console.log(await response.json());

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://default.lokta.tech/lokta-lms/api/v1/clients")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "activationDate": "04 March 2009", "active": true, "address": [ { "addressId": 1, "addressLine1": "string", "addressLine2": "string", "addressLine3": "string" } ], "datatables": [ { "data": "data", "registeredTableName": "Client Beneficiary information" } ], "dateFormat": "dd MMMM yyyy", "dateOfBirth": "19 August 2026", "emailAddress": "[email protected]", "externalId": "123", "firstname": "Client_FirstName", "fullname": "Client full name" } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "activationDate": "04 March 2009", "active": true, "address": [ { "addressId": 1, "addressLine1": "string", "addressLine2": "string", "addressLine3": "string" } ], "datatables": [ { "data": "data", "registeredTableName": "Client Beneficiary information" } ], "dateFormat": "dd MMMM yyyy", "dateOfBirth": "19 August 2026", "emailAddress": "[email protected]", "externalId": "123", "firstname": "Client_FirstName", "fullname": "Client full name" }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/clients", 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))