Can interact use past interactions, current borrower status, loan status
and relevenat compliance rules to make a decision if you can interact
with a borrower.
You can provide contact details in two ways:
contactId/externalContactId - a reference an existing contact of the borrower.
contactDetails - new contact information. If we are able to match the new information to
one of the existing contacts we will not create the new contact information. Otherwise, we'll
create the new contact information.
Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string^ext-|^[A-Z]{2}-[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.
Request Body schema: application/json
One of:
The common parameters of a request to determine whether the interaction is
allowed based on the history of interactions with a borrower and the
associated cases.
Either a theme or subject is required.
loanId
string
An identifier of a loan to track interactions for. This can
either be Peach's or a lender's external identifier.
loanIds
Array of strings
Identifiers of loans to track interactions for. This can
either be Peach's or a lender's external identifier.
channel
required
string
The channel where interactions with a borrower occur. For example, an
outbound call with a borrower is considered voice.
Start time of the interaction. If not provided we'll assume it's a
timestamp of the API call. If time of day is not required provide only date.
isAutodialed
boolean or null
Default: false
true if an interaction is prerecorded or autodialed call. This attribute
is relevant when channel=voice. If no value is passed, we'll assume
isAutodialed=false (meaning manual call). If isAutodialed=true and
the contact's consentAutodialedCall=false we'll return result=false.
For more information read Telephone Consumer Protection Act (TCPA).
contactId
required
string
An identifier of an existing contact.
contactExternalId
string
The lender's identifier of the contact information.
