Create a sourcing partner

POST/lokta-lms/api/v1/sourcing-partners

Creates a sourcing partner in the pending state.

Creates the partner in pending. It cannot be attributed until it is activated, and activation requires an agreement on file; onboarding is a sequence, not a form.

details and contacts may ride this call so onboarding is one request; afterwards each is maintained through its own sub-resource. If contacts are supplied and none is marked primary, the first becomes primary, because every screen downstream assumes a partner has a point of contact.

Requires an Idempotency-Key. Reusing a key with a different body is a 409 rather than a silent replay of the first response.

When to use it

This starts onboarding. The partner is created as pending. Add an agreement and then activate it, because a partner cannot be attributed a loan until it is active.

Worth knowing

Send an Idempotency-Key header. Reusing a key with a different body returns 409.

Header parameters

Idempotency-Keyheader · string · optional

Per-intent key; persist it before sending and reuse it on retry

Request body application/json

namestring · optional

Placeholder name, to be confirmed. The partner's name.

external_idstring · optional

Placeholder name, to be confirmed. The partner's external id.

partner_typestring · optional

Placeholder name, to be confirmed. A partner type code from the reference data.

detailsobject · optional

The partner's details. May ride this call so onboarding is one request.

contactsarray · optional

The partner's contacts. If none is marked primary, the first becomes primary.

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

curl -X POST \ 'https://default.lokta.tech/lokta-lms/api/v1/sourcing-partners' \ -u '{username}:{password}' \ -H 'Tenant-Identifier: default' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "external_id": "string", "partner_type": "string", "details": {}, "contacts": [ {} ] }'

import requests response = requests.post( "https://default.lokta.tech/lokta-lms/api/v1/sourcing-partners", auth=("{username}", "{password}"), headers={"Tenant-Identifier": "default"}, json={ "name": "string", "external_id": "string", "partner_type": "string", "details": {}, "contacts": [ {} ] }, ) print(response.json())

const response = await fetch("https://default.lokta.tech/lokta-lms/api/v1/sourcing-partners", { method: "POST", headers: { Authorization: "Basic " + Buffer.from("{username}:{password}").toString("base64"), "Tenant-Identifier": "default", "Content-Type": "application/json", }, body: JSON.stringify({ "name": "string", "external_id": "string", "partner_type": "string", "details": {}, "contacts": [ {} ] }), }); 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")) .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("{username}:{password}".getBytes())) .header("Tenant-Identifier", "default") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "name": "string", "external_id": "string", "partner_type": "string", "details": {}, "contacts": [ {} ] } """)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

payload := strings.NewReader(`{ "name": "string", "external_id": "string", "partner_type": "string", "details": {}, "contacts": [ {} ] }`) req, _ := http.NewRequest("POST", "https://default.lokta.tech/lokta-lms/api/v1/sourcing-partners", 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))