Borrowers

The Borrower object represent a borrower. It allows you to maintain different statuses that are associated with the same borrower. The API allows you to create, delete and update your borrowers. You can retrieve an individual borrower as well as a list of all your borrowers.

Create borrower

Create a new borrower.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
Any of:

Represents various users such as a borrower, co-borrower, co-signer, etc. A lender can choose to provide PII or not. If no PII is provided, Peach cannot monitor for bankruptcy, deceased and SCRA.

borrowerType
string
Default: "person"

The type of borrower.

Enum: "person" "business"
externalId
string or null

A lender's identifier for a borrower. After the object is successfully created, a lender can use id or externalId identifiers to fetch the object.

To fetch the object using externalId you need to add ext- to the URL.

Note: Don't add ext- to the identifier value. For example: if the external identifier is ABCDE, then pass externalId=ACBCE and NOT ext-ABCDE when creating the object.

status
string
Default: "active"

When a new borrower object is created, we set the value to active by default. Set to inactive at any time.

Enum: "active" "inactive"
collectionsIntensity
string
Default: "normal"

Defines the maximum number of interactions per period(s) on a compliance level related to FDCPA or state debt collection rules. Lenders can configure intensities based on their business needs. For example, prime borrowers can be defined as light, and a lender can define the maximum number of attempts or successful interactions to be 2 in any 7-calendar-day period.

Enum: "light" "normal" "heavy"
metaData
object or null

Store any type of key/value pairs in the form of a JSON dictionary.

object

The borrower's communication preferences.

required
object or null

Name of the person.

dateOfBirth
string or null <date>

The date of birth. All times are in UTC.

object

The borrower's identifier. For example, the Social Security number.

Responses
200

Success

post/people
Request samples
application/json
{
  • "borrowerType": "person",
  • "externalId": "string",
  • "status": "active",
  • "collectionsIntensity": "light",
  • "metaData": { },
  • "commPreferences": {
    },
  • "name": {
    },
  • "dateOfBirth": "2019-08-24",
  • "identity": {
    }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get borrowers

Get borrowers filtering with optional parameters.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
searchable
boolean
Default: false

If true, format the entire response as one suitable for an ElasticSearch search index.

status
string

The status used for filtering if a borrower has loans with the given status.

limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

sortBy
Array of strings

The data attributes by which to sort the results.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

borrowerType
string

The type of borrower.

Enum: "business" "person"
ids
Array of strings

List of IDs.

Responses
200

Success

get/people
Response samples
application/json
{
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Get borrower by ID

Get an existing borrower by ID.

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.

query Parameters
includeIdentity
boolean
Default: false

If set to true, includes the primary identity of the borrower. Use of this flag requires the person:read.sensitive permission.

Responses
200

Success

get/people/{personId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update borrower

Update an existing borrower.

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
Any of:

Represents various users such as a borrower, co-borrower, co-signer, etc. A lender can choose to provide PII or not. If no PII is provided, Peach cannot monitor for bankruptcy, deceased and SCRA.

borrowerType
string
Default: "person"

The type of borrower.

Enum: "person" "business"
externalId
string or null

A lender's identifier for a borrower. After the object is successfully created, a lender can use id or externalId identifiers to fetch the object.

To fetch the object using externalId you need to add ext- to the URL.

Note: Don't add ext- to the identifier value. For example: if the external identifier is ABCDE, then pass externalId=ACBCE and NOT ext-ABCDE when creating the object.

status
string
Default: "active"

When a new borrower object is created, we set the value to active by default. Set to inactive at any time.

Enum: "active" "inactive"
collectionsIntensity
string
Default: "normal"

Defines the maximum number of interactions per period(s) on a compliance level related to FDCPA or state debt collection rules. Lenders can configure intensities based on their business needs. For example, prime borrowers can be defined as light, and a lender can define the maximum number of attempts or successful interactions to be 2 in any 7-calendar-day period.

Enum: "light" "normal" "heavy"
metaData
object or null

Store any type of key/value pairs in the form of a JSON dictionary.

object

The borrower's communication preferences.

object or null

Name of the person.

dateOfBirth
string or null <date>

The date of birth. All times are in UTC.

caseId
string

An identifier for an existing case.

Responses
200

Success

put/people/{personId}
Request samples
application/json
{
  • "borrowerType": "person",
  • "externalId": "string",
  • "status": "active",
  • "collectionsIntensity": "light",
  • "metaData": { },
  • "commPreferences": {
    },
  • "name": {
    },
  • "dateOfBirth": "2019-08-24",
  • "caseId": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}