Peach Finance

Do Not Interact

This object allows you to block interactions on a borrower; and must be connected with a case. You can create multiple Do Not Interact instances on a borrower but only one instance on a case. There are two ways to create Do Not Interacts:

  1. Manually - after a case is created, you can manually create Do Not Interact objects on any borrower case.

  2. In bulk on a Supercase, on the related subcases. See Create Do Not Interact instances on all subcases for more details.

Create do not interact

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

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

caseId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The case object unique identifier.

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
channels
Array of strings (DoNotInteractChannel)

Channel(s) for which outbound interactions with a borrower are blocked. Use value all for all channels.

Items Enum: "all" "voice" "email" "fax" "text" "chat" "mail"
themes
Array of strings (DoNotInteractTheme)

Theme(s) for which outbound interactions with a borrower are blocked. Use value all for all themes. all doesn't include opsAccountCredentials. For example, use opsCollDebt to stop debt collection interactions.

Items Enum: "all" "opsCollDebt" "opsCollLocateBorrower" "opsCollVerifyEmployment" "opsCollContactEmployerNotice" "opsServicingDebtValidation" "opsServicingNegativeCreditReportNotice" "opsServicingTimeBarredNotice" "opsServicing"
endDate
string or null <date> (DoNotInteractEndDate)

A future date when interaction restrictions will be lifted. The value format is date only, without time. If today is endDate, the restriction will remain until the end of day in the product timezone. If no value is provided, doNotInteract will remain in effect until Remove do not interact is called or endDate is set to a date in the past.

daysOfWeek
Array of numbers <int32>

A list of days of week. Valid range is 1-7. 1=Monday...7=Sunday. For example: [1, 2, 4].

timezone
string

The time zone where the borrower is located. If provided, the time zone will be used for restriction. If not provided, the system will use the borrower's home address time zone.

Array of objects (TimeOfDay)

A list of times of day in hours resolution.

contactLabels
Array of strings (ContactLabel)

A list of contact labels. A person's mobile phone is labeled as personal. A person's work phone is labeled as work. A person's home phone is labeled as home. A person's home address is labeled as home.

Items Enum: "personal" "home" "work" "military"
startDate
string <date>

The start date for blocking interactions with a borrower. The value format is date only, without time. The start date can be a future date. If the value is not provided, or equal to today's date, or a date in the past, then the doNotIteract will be effective as soon as we process the request.

Responses
200

Success

post/people/{personId}/cases/{caseId}/do-not-interacts
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "channels": [
    ],
  • "themes": [
    ],
  • "endDate": "2019-08-24",
  • "daysOfWeek": [
    ],
  • "timezone": "string",
  • "timesOfDay": [
    ],
  • "contactLabels": [
    ],
  • "startDate": "2019-08-24"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get case do not interacts

Get the all DoNoInteract instances associated with a case.

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

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

caseId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The case object unique identifier.

query Parameters
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.

sortBy
Array of strings

The data attributes by which to sort the results.

Responses
200

Success

get/people/{personId}/cases/{caseId}/do-not-interacts
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Get do not interact by ID

Get a single DoNotInteract object instance for the borrower using a unique ID.

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

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

caseId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The case object unique identifier.

doNotInteractId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The Do Not Interact object unique identifier.

Responses
200

Success

get/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update do not interact

Update a DoNotInteract instance with new information.

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

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

caseId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The case object unique identifier.

doNotInteractId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The Do Not Interact object unique identifier.

Request Body schema: application/json
required
channels
Array of strings (DoNotInteractChannel)

Channel(s) for which outbound interactions with a borrower are blocked. Use value all for all channels.

Items Enum: "all" "voice" "email" "fax" "text" "chat" "mail"
themes
Array of strings (DoNotInteractTheme)

Theme(s) for which outbound interactions with a borrower are blocked. Use value all for all themes. all doesn't include opsAccountCredentials. For example, use opsCollDebt to stop debt collection interactions.

Items Enum: "all" "opsCollDebt" "opsCollLocateBorrower" "opsCollVerifyEmployment" "opsCollContactEmployerNotice" "opsServicingDebtValidation" "opsServicingNegativeCreditReportNotice" "opsServicingTimeBarredNotice" "opsServicing"
endDate
string or null <date> (DoNotInteractEndDate)

A future date when interaction restrictions will be lifted. The value format is date only, without time. If today is endDate, the restriction will remain until the end of day in the product timezone. If no value is provided, doNotInteract will remain in effect until Remove do not interact is called or endDate is set to a date in the past.

daysOfWeek
Array of numbers <int32>

A list of days of week. Valid range is 1-7. 1=Monday...7=Sunday. For example: [1, 2, 4].

timezone
string

The time zone where the borrower is located. If provided, the time zone will be used for restriction. If not provided, the system will use the borrower's home address time zone.

Array of objects (TimeOfDay)

A list of times of day in hours resolution.

contactLabels
Array of strings (ContactLabel)

A list of contact labels. A person's mobile phone is labeled as personal. A person's work phone is labeled as work. A person's home phone is labeled as home. A person's home address is labeled as home.

Items Enum: "personal" "home" "work" "military"
Responses
200

Success

put/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}
Request samples
application/json
{
  • "channels": [
    ],
  • "themes": [
    ],
  • "endDate": "2019-08-24",
  • "daysOfWeek": [
    ],
  • "timezone": "string",
  • "timesOfDay": [
    ],
  • "contactLabels": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Remove do not interact

Update a DoNotInteract instance to have inactive status, and set the end date.

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

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

caseId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The case object unique identifier.

doNotInteractId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The Do Not Interact object unique identifier.

Responses
204

Success no content

delete/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}

Get all do not interacts

Get the all DoNoInteract instances associated with a borrower.

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

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

query Parameters
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.

sortBy
Array of strings

The data attributes by which to sort the results.

Responses
200

Success

get/people/{personId}/do-not-interacts
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}
➔ Next to Do Not Interact Types

Request sandbox access