Skip to main content
WEBHOOK
/
webhooks
/
lms
/
sync
/
customer-full
{
  "customerId": "12345"
}
{
  "success": true,
  "lmsType": "nls",
  "customerId": "12345",
  "finosuCustomerId": "550e8400-e29b-41d4-a716-446655440000",
  "loansSynced": 2,
  "loans": [
    {
      "loanId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "nortridgeAcctrefno": 100001,
      "loanExternalReference": "LOAN-001",
      "transactionsRows": 15,
      "paymentsDueRows": 12,
      "paymentMethodsCreated": 1,
      "paymentMethodsUpdated": 0,
      "documentRows": 3,
      "transactionsError": "<string>",
      "paymentsDueError": "<string>",
      "paymentMethodsError": "<string>",
      "documentsError": "<string>",
      "setupError": "<string>"
    }
  ],
  "error": "<string>"
}

​
Overview

This endpoint can be used:
  • Manually by client engineers for testing
  • As a webhook target for automated syncs when the LMS detects updates
The sync includes:
  • Customer/contact information
  • All loans for the customer
  • For each loan: transactions, payments due, payment methods, and documents

Authorizations

​
X-API-Key
string
header
required

Headers

​
Idempotency-Key
string

Optional key for idempotent requests (logged for observability)

Body

application/json

Customer identifier to sync

​
customerId
string
required

Customer identifier in the external LMS (e.g., CIF number for NLS)

Minimum string length: 1
Example:

"12345"

Response

Sync completed successfully

​
success
boolean
required

Whether the sync completed successfully

​
lmsType
string
required

The LMS type used (e.g., 'nls')

Example:

"nls"

​
customerId
string
required

External LMS customer identifier

Example:

"12345"

​
finosuCustomerId
string<uuid>
required

Finosu internal customer UUID

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
loansSynced
integer
required

Number of loans synced

Example:

2

​
loans
object[]
required

Detailed results for each loan

​
error
string | null

Error message if sync failed