You are viewing the latest API docs through the legacy docs viewer. The modern viewer can be found here: https://docs.peachfinance.com/api-docs.
Peach Finance

Case Types

This object allows you to create custom case types. You then can create case instances from a case type. Peach has a predefined collection of special case types, such as bankruptcy, identityTheft, and more. You can use any of the special types as your base case type. To customize your case type you can:

  • Add additional custom fields
  • Add and remove automatic Do Not Interact Types
  • Add custom name
  • Add custom description

If you don't want to use any of the special predefined case types, then use generic as your base type.

Create type

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
required
copyOf
integer

The ID of case type to copy and advance the version number

caseType
string (BaseCaseType)
Enum: "generic" "bankruptcy" "ceaseCommunication" "collection" "deceased" "disputeOfDebt" "federalEmergency" "identityTheft" "legalAction" "militaryDuty" "debtValidation" "oFACSanctionedIndividual" "disputeOfPurchase" "creditBureauDispute"
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
name
string <= 50 characters
Default: ""

The default name for instances of that type. The name could be shown in UI.

description
string <= 500 characters
Default: ""

The description for instances of that type. The description could be shown in UI.

status
string
Default: "draft"

The type status. A new type is normally created in the draft status. After you finish with the type configurations and ready to create instances of that type, update the status to active.

You can also update an existing type. Each update will create a new version of the type. Only one version of the type can be active. We'll automatically change the previous version to deprecated. Instances in-flight will continue to use the previous version(s). New instances will be created using the active version.

Enum: "draft" "active" "deprecated"
loanTypeId
string

The optional identifier of a loan type. This is useful when a lender has two or more financial products and need different case types per product.

workflowTypeId
string

The optional identifier of a workflow type. Instances of the workflow type are created for processing cases of this type.

Array of objects or null (customFieldSchema)

Array of custom fields definitions.

object
Responses
200

Success

post/case-types
Request samples
application/json
{
  • "copyOf": 0,
  • "caseType": "generic",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "name": "",
  • "description": "",
  • "status": "draft",
  • "loanTypeId": "string",
  • "workflowTypeId": "string",
  • "customFieldSchemas": [
    ],
  • "smartReviews": {
    }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get case types

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
loanTypeId
Array of strings (AnyId)

Use this to limit results to a specific lender product.

limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

smartReviewsEnable
boolean

Filter for case types that have enabled smart review tasks.

Responses
200

Success

get/case-types
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Get type by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
caseTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The case type unique identifier.

query Parameters
version
integer <int32>

Optional argument. If provided, the action will be performed on the specified version.

Responses
200

Success

get/case-types/{caseTypeId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update type

A PUT request is used to update an existing type configuration. While the type is in draft status requests can move it to active. Setting the status to deprecated will immediately hide it from future GET all requests, and spawn a draft replica which can be edited and published in its place.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
caseTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The case type unique identifier.

query Parameters
version
integer <int32>

Optional argument. If provided, the action will be performed on the specified version.

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
name
string <= 50 characters
Default: ""

The default name for instances of that type. The name could be shown in UI.

description
string <= 500 characters
Default: ""

The description for instances of that type. The description could be shown in UI.

status
string
Default: "draft"

The type status. A new type is normally created in the draft status. After you finish with the type configurations and ready to create instances of that type, update the status to active.

You can also update an existing type. Each update will create a new version of the type. Only one version of the type can be active. We'll automatically change the previous version to deprecated. Instances in-flight will continue to use the previous version(s). New instances will be created using the active version.

Enum: "draft" "active" "deprecated"
loanTypeId
string

The optional identifier of a loan type. This is useful when a lender has two or more financial products and need different case types per product.

workflowTypeId
string

The optional identifier of a workflow type. Instances of the workflow type are created for processing cases of this type.

Array of objects or null (customFieldSchema)

Array of custom fields definitions.

object
Responses
200

Success

put/case-types/{caseTypeId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "name": "",
  • "description": "",
  • "status": "draft",
  • "loanTypeId": "string",
  • "workflowTypeId": "string",
  • "customFieldSchemas": [
    ],
  • "smartReviews": {
    }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Add association

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
caseTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The case type unique identifier.

query Parameters
objectType
required
string
Enum: "doNotInteractType" "notificationType" "loanType"
objectId
required
integer <int32>

The ID of the object to associate with

Responses
204

Success no content

post/case-types/{caseTypeId}/associations

Remove association

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
caseTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The case type unique identifier.

query Parameters
objectType
required
string
Enum: "doNotInteractType" "notificationType" "loanType"
objectId
required
integer <int32>

The ID of the object to dissociate from

Responses
204

Success no content

delete/case-types/{caseTypeId}/associations

Create case type review tasks for ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
caseTypeId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The case type unique identifier.

query Parameters
asOfDate
string <date>

What date to process smart review criterion. If null, process today. Can not be a date in the future.

Responses
200

Run successful with no reminder tasks created

201

Run successful with created reminder tasks

post/case-types/{caseTypeId}/create-smart-review-tasks
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Smart Reviews