API Reference›Servicing Workspace›Servicing administration›Read document-evidence health

Read document-evidence health

GEThttps://sandbox.api.lendeasy.ai/v1/servicing/admin/document-evidence/healthImplementedBearer token ·ADMIN_SERVICING_CONFIG

Reports the evidence profile, the safety controls in force, the worker binding, and any open alerts. Distinguishes a worker that is configured from one that is qualified, and a provider failure from an unknown provider outcome.

Request

curl https://sandbox.api.lendeasy.ai/v1/servicing/admin/document-evidence/health \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/document-evidence/health`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/document-evidence/health",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant},
)

{
  "profile": "ACTIVE",
  "scanner": {
    "code": "CLAMD",
    "detectsMalware": true
  },
  "worker": {
    "configured": true,
    "qualified": true
  },
  "alerts": []
}

{
  "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.

Request

curl https://sandbox.api.lendeasy.ai/v1/servicing/admin/document-evidence/health \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/document-evidence/health`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/document-evidence/health",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant},
)

{
  "profile": "ACTIVE",
  "scanner": {
    "code": "CLAMD",
    "detectsMalware": true
  },
  "worker": {
    "configured": true,
    "qualified": true
  },
  "alerts": []
}

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