API Reference›Servicing Workspace›Supercases›Transition a supercase

Transition a supercase

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/supercases/{supercaseId}/transitionsImplementedBearer token ·MANAGE_SERVICING_SUPERCASE

Moves the supercase through its own lifecycle and refuses to conclude one while subcases are still open, returning the open count in the refusal.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/supercases/$SUPERCASE_ID/transitions \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "COMPLETE",
  "note": "Every subcase has been closed or cancelled."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/supercases/${supercaseId}/transitions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "action": "COMPLETE",
  "note": "Every subcase has been closed or cancelled."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/supercases/{supercase_id}/transitions",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "action": "COMPLETE",
  "note": "Every subcase has been closed or cancelled."
},
)

{
  "supercaseId": 3301,
  "status": "COMPLETED",
  "externalSupercaseRef": "LE-SC-3301"
}

{
  "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.
supercaseId required in path	integer	Positive numeric supercase 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
action required	string
note optional	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/supercases/$SUPERCASE_ID/transitions \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "COMPLETE",
  "note": "Every subcase has been closed or cancelled."
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/supercases/${supercaseId}/transitions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "action": "COMPLETE",
  "note": "Every subcase has been closed or cancelled."
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/supercases/{supercase_id}/transitions",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "action": "COMPLETE",
  "note": "Every subcase has been closed or cancelled."
},
)

{
  "supercaseId": 3301,
  "status": "COMPLETED",
  "externalSupercaseRef": "LE-SC-3301"
}

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