API Reference›LMS API›Documents›Upload a document

Upload a document

POSThttps://sandbox.api.lendeasy.ai/v1/documentsBearer token ·CREATE_LMS_DOCUMENT

Uploads content and registers metadata in one multipart request with two parts: a JSON metadata part and the file part. At least one CUSTOMER or LOAN link is required. The server derives the checksum and content type; content is virus-scanned before it can be downloaded, and rejected content is quarantined and deleted. Marking a document sensitive requires the sensitive read permission.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/documents \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -F 'metadata={"title":"Pay statement — April","documentType":"INCOME_EVIDENCE","sensitive":false,"links":[{"targetType":"LOAN","targetRef":"7204"}]};type=application/json' \
  -F "file=@./document.pdf;type=application/pdf"

const form = new FormData();
form.append("metadata", new Blob([JSON.stringify({
  "title": "Pay statement — April",
  "documentType": "INCOME_EVIDENCE",
  "sensitive": false,
  "links": [
    {
      "targetType": "LOAN",
      "targetRef": "7204"
    }
  ]
})], { type: "application/json" }));
form.append("file", file);

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

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/documents",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  files={
    "metadata": (None, r'''{"title":"Pay statement — April","documentType":"INCOME_EVIDENCE","sensitive":false,"links":[{"targetType":"LOAN","targetRef":"7204"}]}''', "application/json"),
    "file": ("document.pdf", open("./document.pdf", "rb"), "application/pdf"),
  },
)

{
  "resourceId": 1204
}

{
  "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	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.
Idempotency-Key optional in header	string	Optional stable key (1-50 chars) for this one logical mutation. Replays of a completed request return the original result with x-served-from-cache: true; an in-flight duplicate returns 409 with Retry-After. Omitted keys are server-generated per attempt.

Multipart body parameters

Field	Type	Description
metadata required	object	JSON metadata part.
title	string
documentType	string
sensitive	boolean
links	array<object>
file required	string	Content bytes; the server derives the checksum and content type.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/documents \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -F 'metadata={"title":"Pay statement — April","documentType":"INCOME_EVIDENCE","sensitive":false,"links":[{"targetType":"LOAN","targetRef":"7204"}]};type=application/json' \
  -F "file=@./document.pdf;type=application/pdf"

const form = new FormData();
form.append("metadata", new Blob([JSON.stringify({
  "title": "Pay statement — April",
  "documentType": "INCOME_EVIDENCE",
  "sensitive": false,
  "links": [
    {
      "targetType": "LOAN",
      "targetRef": "7204"
    }
  ]
})], { type: "application/json" }));
form.append("file", file);

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

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/documents",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  files={
    "metadata": (None, r'''{"title":"Pay statement — April","documentType":"INCOME_EVIDENCE","sensitive":false,"links":[{"targetType":"LOAN","targetRef":"7204"}]}''', "application/json"),
    "file": ("document.pdf", open("./document.pdf", "rb"), "application/pdf"),
  },
)

{
  "resourceId": 1204
}

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