Skip to main content
POST
Sync a single loan from LMS

Overview

This endpoint syncs a single loan and its associated customer from the company’s configured LMS. It is a loan-centric entry point for LMS platforms where customer lookups don’t reveal associated loans. The caller provides the external loan ID, and the endpoint discovers and syncs the customer automatically. This endpoint can be used:
  • Manually by client engineers for testing
  • As a webhook target for automated syncs when the LMS detects loan updates
The sync includes:
  • Customer/contact information (discovered from the loan)
  • The specified loan’s core data and balances

Request naming

Use camelCase request fields. Existing snake_case aliases are also accepted by the API.

Retries and results

Idempotency-Key is logged for correlation only; it does not deduplicate requests or replay earlier results. A repeated request can run the sync again. HTTP 200 means a sync result was returned. Inspect success, error, and each entry in loans before treating the operation as successful. Missing or invalid authentication returns 401; invalid request fields return 422.

Error responses

Invalid loan identifiers return 422; a loan or associated customer confirmed missing from the LMS returns 404. Unexpected provider failures and malformed provider data return 500. Unsupported LMS operations retain 400.

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string

Optional correlation key, logged for observability only. Does not deduplicate requests or replay previous results.

Body

application/json

Loan identifier to sync

loanId
string
required

Loan identifier in the external LMS

Minimum string length: 1
Example:

"99001"

Response

Sync result returned. Inspect success, error, and per-loan results.

success
boolean
required
lmsType
string
required

Identifier of the configured LMS platform

customerId
string
required

External LMS customer identifier discovered from the loan

finosuCustomerId
string<uuid>
required

Finosu internal customer UUID

loansSynced
integer
required
loans
object[]
error
string | null