API Reference›Servicing Plane›Case documents›Replace document loan links

Replace document loan links

PUThttps://sandbox.api.lendeasy.ai/v1/servicing/documents/{documentId}/loan-linksImplementedBearer token ·UPDATE_SERVICING_DOCUMENT

Atomically replaces optional selected-loan links while retaining required case/customer links and historical retention scope.

Request

curl -X PUT https://sandbox.api.lendeasy.ai/v1/servicing/documents/$DOCUMENT_ID/loan-links \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "loanRefs": [
    "456",
    "457"
  ],
  "reason": "Reviewer confirmed both loans are covered by the filing."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/documents/${documentId}/loan-links`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "loanRefs": [
    "456",
    "457"
  ],
  "reason": "Reviewer confirmed both loans are covered by the filing."
}),
});

requests.put(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/documents/{document_id}/loan-links",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "loanRefs": [
    "456",
    "457"
  ],
  "reason": "Reviewer confirmed both loans are covered by the filing."
},
)

{
  "resourceId": 7001,
  "changes": {
    "loanRefs": [
      "456",
      "457"
    ]
  }
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Opaque active LendEasy tenant-registry identifier. Supply exactly one instance; no alternate tenant selector is accepted.
documentId required in path	integer	Positive numeric document identifier.
Idempotency-Key optional in header	string	Optional replay key for this logical mutation. Omission creates a fresh server-owned key for this attempt; blank, repeated, or longer-than-50-character values are rejected.

Body parameters

Field	Type	Description
loanRefs required	array<string>
reason required	string

Request

curl -X PUT https://sandbox.api.lendeasy.ai/v1/servicing/documents/$DOCUMENT_ID/loan-links \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "loanRefs": [
    "456",
    "457"
  ],
  "reason": "Reviewer confirmed both loans are covered by the filing."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/documents/${documentId}/loan-links`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "loanRefs": [
    "456",
    "457"
  ],
  "reason": "Reviewer confirmed both loans are covered by the filing."
}),
});

requests.put(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/documents/{document_id}/loan-links",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "loanRefs": [
    "456",
    "457"
  ],
  "reason": "Reviewer confirmed both loans are covered by the filing."
},
)

{
  "resourceId": 7001,
  "changes": {
    "loanRefs": [
      "456",
      "457"
    ]
  }
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}