This object allows for the management of many cases across a number of borrowers. That is to say that a supercase can create, manage, and close many cases at once.
This is particularly useful if an issue occurs which effects a large group of borrowers.
subcases
/cases
endpoint)Managing "who" is effected by a supercase is an important aspect of supercases:
member
of a supercase is one "borrower-loan" pairing.population
is a set of members added at once.population
's membership may be changed until it is "committed" by setting
isDraft: false
, at which time the memberships are locked and subcases are created.Creates a new supercase.
Success
{- "externalId": "string",
- "supercaseType": "generic",
- "name": "string",
- "description": "string",
- "eventStartedAt": "2019-08-24T14:15:22Z",
- "status": "initiated",
- "outcome": "approved",
- "subcaseTypeId": "string",
- "subcaseName": "string",
- "autoCreated": true,
- "femaDisasterNumber": 0,
- "femaMonitoringEndDate": "2019-08-24"
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "companyId": "string",
- "supercaseType": "generic",
- "name": "string",
- "description": "string",
- "eventStartedAt": "2019-08-24T14:15:22Z",
- "status": "initiated",
- "statusUpdatedAt": "2019-08-24T14:15:22Z",
- "outcome": "approved",
- "subcaseTypeId": "string",
- "subcaseName": "string",
- "createdBy": {
- "id": "string",
- "name": "string",
- "userType": "string",
- "descriptor": "Agent bob@acme.com"
}, - "autoCreated": true,
- "femaDisasterNumber": 0,
- "femaDisasterDetails": { },
- "femaMonitoringEndDate": "2019-08-24"
}
}
Success
{- "count": 0,
- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "companyId": "string",
- "supercaseType": "generic",
- "name": "string",
- "description": "string",
- "eventStartedAt": "2019-08-24T14:15:22Z",
- "status": "initiated",
- "statusUpdatedAt": "2019-08-24T14:15:22Z",
- "outcome": "approved",
- "subcaseTypeId": "string",
- "subcaseName": "string",
- "createdBy": {
- "id": "string",
- "name": "string",
- "userType": "string",
- "descriptor": "Agent bob@acme.com"
}, - "autoCreated": true,
- "femaDisasterNumber": 0,
- "femaDisasterDetails": { },
- "femaMonitoringEndDate": "2019-08-24"
}
]
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "companyId": "string",
- "supercaseType": "generic",
- "name": "string",
- "description": "string",
- "eventStartedAt": "2019-08-24T14:15:22Z",
- "status": "initiated",
- "statusUpdatedAt": "2019-08-24T14:15:22Z",
- "outcome": "approved",
- "subcaseTypeId": "string",
- "subcaseName": "string",
- "createdBy": {
- "id": "string",
- "name": "string",
- "userType": "string",
- "descriptor": "Agent bob@acme.com"
}, - "autoCreated": true,
- "femaDisasterNumber": 0,
- "femaDisasterDetails": { },
- "femaMonitoringEndDate": "2019-08-24"
}
}
Success
{- "externalId": "string",
- "supercaseType": "generic",
- "name": "string",
- "description": "string",
- "eventStartedAt": "2019-08-24T14:15:22Z",
- "status": "initiated",
- "outcome": "approved",
- "subcaseTypeId": "string",
- "subcaseName": "string",
- "autoCreated": true,
- "femaDisasterNumber": 0,
- "femaMonitoringEndDate": "2019-08-24"
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "companyId": "string",
- "supercaseType": "generic",
- "name": "string",
- "description": "string",
- "eventStartedAt": "2019-08-24T14:15:22Z",
- "status": "initiated",
- "statusUpdatedAt": "2019-08-24T14:15:22Z",
- "outcome": "approved",
- "subcaseTypeId": "string",
- "subcaseName": "string",
- "createdBy": {
- "id": "string",
- "name": "string",
- "userType": "string",
- "descriptor": "Agent bob@acme.com"
}, - "autoCreated": true,
- "femaDisasterNumber": 0,
- "femaDisasterDetails": { },
- "femaMonitoringEndDate": "2019-08-24"
}
}
{- "count": 0,
- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "isDraft": true
}
]
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "isDraft": true
}
}
{- "status": 0,
- "message": "string",
- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "caseId": "string",
- "borrowerId": "string",
- "loanId": "string",
- "createdBy": "string"
}
]
}
Set the draft population membership to the population in this request. (Removing all current members if they exist.)
Success
[- {
- "borrowerId": "string",
- "loanId": "string"
}
]
Add to the current population membership the members in this request.
Success
[- {
- "borrowerId": "string",
- "loanId": "string"
}
]
Set the current population membership to the population in this request. (Removing all current members if they exist.) Format is a CSV document.
Success
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "isDraft": true
}
}
Update the population.
Success
{- "externalId": "string"
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "externalId": "string",
- "isDraft": true
}
}
{- "status": 0,
- "message": "string",
- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "caseId": "string",
- "borrowerId": "string",
- "loanId": "string",
- "createdBy": "string"
}
]
}
{- "count": 0,
- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "caseId": "string",
- "supercaseId": "string",
- "status": "active",
- "type": "caseNote",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "edited": false,
- "archived": false,
- "taskableInstruction": false,
- "createdBy": "string",
- "updatedBy": "string",
- "archivedBy": "string",
- "archivedAt": "2019-08-24T14:15:22Z"
}
]
}
The new note
Success
{- "status": "active",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "archived": false,
- "taskableInstruction": false
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "caseId": "string",
- "supercaseId": "string",
- "status": "active",
- "type": "caseNote",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "edited": false,
- "archived": false,
- "taskableInstruction": false,
- "createdBy": "string",
- "updatedBy": "string",
- "archivedBy": "string",
- "archivedAt": "2019-08-24T14:15:22Z"
}
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "caseId": "string",
- "supercaseId": "string",
- "status": "active",
- "type": "caseNote",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "edited": false,
- "archived": false,
- "taskableInstruction": false,
- "createdBy": "string",
- "updatedBy": "string",
- "archivedBy": "string",
- "archivedAt": "2019-08-24T14:15:22Z"
}
}
Note fields
Success
{- "status": "active",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "archived": false,
- "taskableInstruction": false
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "caseId": "string",
- "supercaseId": "string",
- "status": "active",
- "type": "caseNote",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "edited": false,
- "archived": false,
- "taskableInstruction": false,
- "createdBy": "string",
- "updatedBy": "string",
- "archivedBy": "string",
- "archivedAt": "2019-08-24T14:15:22Z"
}
}
{- "count": 0,
- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "caseId": "string",
- "supercaseId": "string",
- "status": "active",
- "type": "caseNote",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "edited": false,
- "archived": false,
- "taskableInstruction": false,
- "createdBy": "string",
- "updatedBy": "string",
- "archivedBy": "string",
- "archivedAt": "2019-08-24T14:15:22Z"
}
]
}
The new note
Success
{- "status": "active",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "archived": false,
- "taskableInstruction": false
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "caseId": "string",
- "supercaseId": "string",
- "status": "active",
- "type": "caseNote",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "edited": false,
- "archived": false,
- "taskableInstruction": false,
- "createdBy": "string",
- "updatedBy": "string",
- "archivedBy": "string",
- "archivedAt": "2019-08-24T14:15:22Z"
}
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "caseId": "string",
- "supercaseId": "string",
- "status": "active",
- "type": "caseNote",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "edited": false,
- "archived": false,
- "taskableInstruction": false,
- "createdBy": "string",
- "updatedBy": "string",
- "archivedBy": "string",
- "archivedAt": "2019-08-24T14:15:22Z"
}
}
Note fields
Success
{- "status": "active",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "archived": false,
- "taskableInstruction": false
}
{- "status": 0,
- "message": "string",
- "data": {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "caseId": "string",
- "supercaseId": "string",
- "status": "active",
- "type": "caseNote",
- "content": "string",
- "important": false,
- "category": "generic",
- "sensitiveData": false,
- "edited": false,
- "archived": false,
- "taskableInstruction": false,
- "createdBy": "string",
- "updatedBy": "string",
- "archivedBy": "string",
- "archivedAt": "2019-08-24T14:15:22Z"
}
}
Keyword parameters unique to bankruptcies.
Accepted
{- "externalId": "string",
- "people": [
- "string"
], - "name": "string",
- "caseType": "generic",
- "creationProcedure": "automatedCollectionsDetection",
- "autoCreated": true,
- "status": "initiated",
- "outcome": "approved",
- "matchToDataSource": true,
- "matchDetails": {
- "ssnMatch": "match",
- "last4SSNMatch": "match",
- "nameMatch": "match",
- "addressMatch": "match",
- "dateOfBirthMatch": "match",
- "matchDoneBy": "dataVendor",
- "externalMatchCode": "string"
}, - "lenderAck": false,
- "customFields": { },
- "metaData": { },
- "workflowId": "string",
- "escalatedTeamId": "string",
- "escalatedEmployeeId": "string",
- "escalationIsUrgent": true,
- "lastViewedBy": {
- "id": "string",
- "userType": "agent",
- "name": "string",
- "employee": {
- "id": "string"
}
}, - "lastSubresourceUpdatedBy": {
- "id": "string",
- "userType": "agent",
- "name": "string",
- "employee": {
- "id": "string"
}
}, - "courtCaseFiledDate": "2019-08-24",
- "courtCaseNumber": "string",
- "courtCaseChapter": "chapter7",
- "courtCaseDebtorDisposition": "dismissed",
- "courtCaseDebtorDispositionDate": "2019-08-24",
- "courtCaseLastStatus": "filed",
- "courtCaseLastStatusUpdatedDate": "2019-08-24",
- "courtCaseClosedDate": "2019-08-24",
- "creditorClaimDeadlineDate": "2019-08-24",
- "anticipatedCaseCompletionDate": "2019-08-24",
- "listedOutstandingDebt": true,
- "createReviewTask": true
}
{- "status": 0,
- "message": "string",
- "data": {
- "operationId": "string"
}
}
Accepted
{- "subject": "annualPrivacyPolicyNotice",
- "channel": "voice",
- "theme": "agentNotification",
- "context": { },
- "isTransactional": true,
- "attachments": [
- "string"
]
}
{- "status": 0,
- "message": "string",
- "data": {
- "operationId": "string"
}
}
Accepted
{- "subject": "annualPrivacyPolicyNotice",
- "channel": "voice",
- "theme": "agentNotification",
- "context": { },
- "isTransactional": true,
- "attachments": [
- "string"
]
}
{- "status": 0,
- "message": "string",
- "data": {
- "operationId": "string"
}
}
Accepted
{- "channels": [
- "all"
], - "themes": [
- "all"
], - "endDate": "2019-08-24",
- "daysOfWeek": [
- 0
], - "timezone": "string",
- "timesOfDay": [
- {
- "fromHour": 0,
- "toHour": 0
}
], - "contactLabels": [
- "personal"
], - "startDate": "2019-08-24"
}
{- "status": 0,
- "message": "string",
- "data": {
- "operationId": "string"
}
}
OK
{- "count": 0,
- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "supercaseId": "string",
- "operationType": "update",
- "completed": true,
- "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "casesProcessed": 0,
- "casesFailed": 0,
- "requestBody": { },
- "errorLog": [ ]
}
]
}
OK
{- "data": [
- {
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "supercaseId": "string",
- "operationType": "update",
- "completed": true,
- "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "casesProcessed": 0,
- "casesFailed": 0,
- "requestBody": { },
- "errorLog": [ ]
}
]
}
OK
{- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": "2019-08-24T14:15:22Z",
- "supercaseId": "string",
- "operationType": "update",
- "completed": true,
- "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "casesProcessed": 0,
- "casesFailed": 0,
- "requestBody": { },
- "errorLog": [ ]
}