Consent

Explicit consent to receive certain kinds of communications.

Get consents

Get all consent 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.

Responses
200

Success

get/people/{personId}/consents
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Update consents

Update the consents

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
caseId
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Optional case ID to be recorded with the change.

Request Body schema: application/json
required
Array
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
name
required
string

Represents special consents or permissions. Consents are typically given in writing to a lender.

  • electronicComms - Set to revoked if the borrower hasn't consented or has revoked consent to electronic communications. Default: consented

  • contactPersonWork - A borrower or their attorney gave a written consent to contact borrower’s employer for debt collection. Default: revoked

  • contactPersonRepByAttorney - Indicates whether a lender is allowed to contact a borrower represented by an attorney. If the attorney gave a written consent to interact with the borrower, set to consented. Default: revoked

  • contactPersonUnusualTime - A person or their attorney gave written consent to interact with the person at some unusual place or time. Default: revoked

  • autodialedColl - Consent to receive autodialed or pre-recorded collection calls from creditors or third-party collectors. If no value is provided, we will assume autodialedColl is consented. For more information read Telephone Consumer Protection Act (TCPA). Default: consented

  • executeWageAssignment - Set to consented if the person consented to execute a wage assignment agreement. Default: revoked

  • contactServicememberUnitOrCommander - Consent to contact a servicemember's military unit or chain of command to collect on a debt. Default: revoked.

Enum: "electronicComms" "contactPersonWork" "contactPersonRepByAttorney" "contactPersonUnusualTime" "autodialedColl" "executeWageAssignment" "contactServicememberUnitCollDebt"
value
required
string

Consent can be granted and revoked by a borrower.

Enum: "consented" "revoked"
Responses
200

Success

put/people/{personId}/consents
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}