Skip to main content
WEBHOOK
/
webhooks
/
lms
/
sync
/
loan
{
  "loanId": "99001"
}
{
  "success": true,
  "lmsType": "<string>",
  "customerId": "<string>",
  "finosuCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "loansSynced": 123,
  "loans": [
    {
      "finosuLoanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "loanId": "<string>"
    }
  ],
  "error": "<string>"
}

​
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 (e.g., Tier 3). 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

Authorizations

​
X-API-Key
string
header
required

Headers

​
Idempotency-Key
string

Optional key for idempotent requests (logged for observability)

Body

application/json

Loan identifier to sync

​
loanId
string
required

Loan identifier in the external LMS (e.g., Tier 3 loan ID)

Minimum string length: 1
Example:

"99001"

Response

Sync completed successfully

​
success
boolean
​
lmsType
string

LMS platform identifier (e.g., TIER3)

​
customerId
string

External LMS customer identifier discovered from the loan

​
finosuCustomerId
string<uuid>

Finosu internal customer UUID

​
loansSynced
integer
​
loans
object[]
​
error
string | null