API Reference›Servicing Plane›Portal contracts›Create a borrower document download

Create a borrower document download

GEThttps://sandbox.api.lendeasy.ai/v1/servicing/portal-documents/{documentId}/contentImplementedBearer token ·READ_PORTAL_BORROWER_DOCUMENT

Returns a short-lived, no-store download envelope for one of the customer's own scan-clean uploads. Ownership is part of the query, so anything else answers 404.

Request

curl https://sandbox.api.lendeasy.ai/v1/servicing/portal-documents/$DOCUMENT_ID/content?customerRef=example \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/portal-documents/${documentId}/content?customerRef=example`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/portal-documents/{document_id}/content?customerRef=example",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant},
)

{
  "downloadUrl": "https://content.example/opaque-signed-token",
  "expiresAt": "2026-07-25T18: 45:00Z",
  "fileName": "doctors-letter.pdf",
  "contentType": "application/pdf",
  "checksumSha256": "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"
}

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

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.
customerRef required in query	string	Customer who owns the upload.

Request

curl https://sandbox.api.lendeasy.ai/v1/servicing/portal-documents/$DOCUMENT_ID/content?customerRef=example \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/portal-documents/${documentId}/content?customerRef=example`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/portal-documents/{document_id}/content?customerRef=example",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant},
)

{
  "downloadUrl": "https://content.example/opaque-signed-token",
  "expiresAt": "2026-07-25T18: 45:00Z",
  "fileName": "doctors-letter.pdf",
  "contentType": "application/pdf",
  "checksumSha256": "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"
}

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