API Reference›Servicing Plane›Case documents›Upload a case document

Upload a case document

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/cases/{caseId}/documentsImplementedBearer token ·CREATE_SERVICING_DOCUMENT

Registers metadata and binary content through one controlled multipart intake, then creates scan/review work before use.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/documents \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -F 'metadata={};type=application/json' \
  -F "file=@./document.pdf;type=application/pdf"

const form = new FormData();
form.append("metadata", new Blob([JSON.stringify({})], { type: "application/json" }));
form.append("file", file);

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/documents`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey },
  body: form,
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/documents",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  files={
    "metadata": (None, r'''{}''', "application/json"),
    "file": ("document.pdf", open("./document.pdf", "rb"), "application/pdf"),
  },
)

{
  "documentId": 7001,
  "status": "PENDING_REVIEW",
  "reviewTaskId": 3301,
  "links": [
    {
      "targetType": "CASE",
      "targetRef": "1001"
    },
    {
      "targetType": "CUSTOMER",
      "targetRef": "123"
    },
    {
      "targetType": "LOAN",
      "targetRef": "456"
    }
  ],
  "resourceId": 7001
}

{
  "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.
caseId required in path	integer	Positive numeric case 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.

Multipart body parameters

Field	Type	Description
file required	string	The document bytes. PDF, JPEG, or PNG up to the configured size ceiling.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/cases/$CASE_ID/documents \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -F 'metadata={};type=application/json' \
  -F "file=@./document.pdf;type=application/pdf"

const form = new FormData();
form.append("metadata", new Blob([JSON.stringify({})], { type: "application/json" }));
form.append("file", file);

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/cases/${caseId}/documents`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey },
  body: form,
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/cases/{case_id}/documents",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  files={
    "metadata": (None, r'''{}''', "application/json"),
    "file": ("document.pdf", open("./document.pdf", "rb"), "application/pdf"),
  },
)

{
  "documentId": 7001,
  "status": "PENDING_REVIEW",
  "reviewTaskId": 3301,
  "links": [
    {
      "targetType": "CASE",
      "targetRef": "1001"
    },
    {
      "targetType": "CUSTOMER",
      "targetRef": "123"
    },
    {
      "targetType": "LOAN",
      "targetRef": "456"
    }
  ],
  "resourceId": 7001
}

{
  "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": []
}