Retrieve the onboarding document checklist

GET/lokta-lms/api/v1/sourcing-partners/{partnerId}/document-checklist

Returns the onboarding document checklist for a sourcing partner, one row per requirement.

One row per requirement for this partner's type; a DSA and an LSP see different checklists.

Three fields describe requirement and none is redundant. requirement (mandatory | conditional | optional) and condition_code (has_gstin | is_regulated_entity, null unless conditional) are the policy, unresolved, enough for a screen to state the rule. is_required is the verdict for this partner, already resolved against its own details. Publishing only the verdict leaves a policy view unable to state the rule; publishing only the policy makes every consumer re-derive the verdict, and a re-derivation that drifts is how two screens end up disagreeing about whether a partner is compliant. Do not re-derive it.

status is missing · pending · verified · rejected · expired. expired is derived from valid_to against today, never stored: nothing writes to a row on the day a certificate lapses, so a status read straight from storage would report a partner as verified on a document that stopped being valid years ago. Rejection outranks expiry.

The document shown against a requirement is the latest of that type; a partner who re-submits after a rejection or an expiry must not still read as rejected or expired.

A document of a type this partner's checklist never asks for is real and is not hidden; it appears under /documents, which answers "what do we hold" rather than "what is needed".

Path parameters

partnerIdpath · string · required

Opaque partner id, spr_…

Responses

defaultdefault response

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/sourcing-partners/{partnerId}/document-checklist", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/sourcing-partners/{partnerId}/document-checklist", { 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/sourcing-partners/{partnerId}/document-checklist")) .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/sourcing-partners/{partnerId}/document-checklist", 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))