API Reference›Servicing Plane›Hardship›Simulate a policy version

Simulate a policy version

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/{programCode}/versions/{versionId}/simulateImplementedBearer token ·ADMIN_SERVICING_HARDSHIP_POLICY

Runs the version's rules against a synthetic fact set and persists the always-synthetic run beside the version. Simulation never touches a case.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/$PROGRAM_CODE/versions/$VERSION_ID/simulate \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "requestedCount": 4,
  "facts": {
    "employmentActive": "true",
    "certificateState": "COMPLETE",
    "leaveStartDate": "2026-07-14",
    "expectedReturnDate": "2026-08-25",
    "canResumeAfterReturn": "true",
    "loanStatus": "ACTIVE",
    "daysOverdue": "0"
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/${programCode}/versions/${versionId}/simulate`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "requestedCount": 4,
  "facts": {
    "employmentActive": "true",
    "certificateState": "COMPLETE",
    "leaveStartDate": "2026-07-14",
    "expectedReturnDate": "2026-08-25",
    "canResumeAfterReturn": "true",
    "loanStatus": "ACTIVE",
    "daysOverdue": "0"
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/{program_code}/versions/{version_id}/simulate",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "requestedCount": 4,
  "facts": {
    "employmentActive": "true",
    "certificateState": "COMPLETE",
    "leaveStartDate": "2026-07-14",
    "expectedReturnDate": "2026-08-25",
    "canResumeAfterReturn": "true",
    "loanStatus": "ACTIVE",
    "daysOverdue": "0"
  }
},
)

{
  "resourceId": 8801,
  "changes": {
    "programVersionId": 9302,
    "simulationId": 8801,
    "operation": "SIMULATE",
    "synthetic": true
  }
}

{
  "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.
programCode required in path	string	Stable opaque programCode identifier.
versionId required in path	string	Stable opaque version 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
requestedCount required	integer
facts required	object
employmentActive	string
certificateState	string
leaveStartDate	string
expectedReturnDate	string
canResumeAfterReturn	string
loanStatus	string
daysOverdue	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/$PROGRAM_CODE/versions/$VERSION_ID/simulate \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "requestedCount": 4,
  "facts": {
    "employmentActive": "true",
    "certificateState": "COMPLETE",
    "leaveStartDate": "2026-07-14",
    "expectedReturnDate": "2026-08-25",
    "canResumeAfterReturn": "true",
    "loanStatus": "ACTIVE",
    "daysOverdue": "0"
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/${programCode}/versions/${versionId}/simulate`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "requestedCount": 4,
  "facts": {
    "employmentActive": "true",
    "certificateState": "COMPLETE",
    "leaveStartDate": "2026-07-14",
    "expectedReturnDate": "2026-08-25",
    "canResumeAfterReturn": "true",
    "loanStatus": "ACTIVE",
    "daysOverdue": "0"
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/admin/hardship-policies/{program_code}/versions/{version_id}/simulate",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "requestedCount": 4,
  "facts": {
    "employmentActive": "true",
    "certificateState": "COMPLETE",
    "leaveStartDate": "2026-07-14",
    "expectedReturnDate": "2026-08-25",
    "canResumeAfterReturn": "true",
    "loanStatus": "ACTIVE",
    "daysOverdue": "0"
  }
},
)

{
  "resourceId": 8801,
  "changes": {
    "programVersionId": 9302,
    "simulationId": 8801,
    "operation": "SIMULATE",
    "synthetic": true
  }
}

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