Search borrowers

Request

Search for borrowers. Returns same resources as /people.

Security

oauth2(Required scopes: person:search) or bearerAuth or apiKeyHeader

Query

_hasTheWordsstring

Performs fuzzy matching on all fuzzy-matchable search fields and exact matching on all exact-matchable search fields.

For example, _hasTheWords=Rob will match a firstName of Robby a lastName of Roberts and street address of 123 Robinson Dr.

_notTheWordsstring

Performs fuzzy matching on all fuzzy-matchable search fields and exact matching on all exact-matchable search fields, and ensure that entries matching that search will not appear in results.

For example, _notTheWords=Rob will match a firstName of Robby a lastName of Roberts and street address of 123 Robinson Dr and ensure those results are not included in results.

addressstring

Fuzzy matches addresses associated with a borrower. For example address=fake will match an addressLine1 of 123 Fake St as well as a city of Fakeville.

Note that states are stored as their abbreviations, so you must search with the abbreviation to match. For example, address=MO will match Missouri, but address=Missouri will not.

bankruptcyCourtCasestring

Exactly matches a bankruptcy court case ID.

borrowerTypestring

Exactly match the type of borrower.

Enum:"business""person"

businessNamestring

Fuzzy matches the businessName or businessLegalName of business borrowers—never matches a person.

caseIdstring

Exactly matches a case ID. Can be either the Peach ID (like CS-XXXX-XXXX) or the external ID.

citystring

Fuzzy match the city in any of a borrower's addresses.

dateOfBirthstring, (date)

Exactly matches a borrower's date of birth. Specified like YYYY-MM-DD.

emailstring

Fuzzy matches any of a borrower's email addresses.

emailExactstring

Exactly matches any of a borrower's email addresses.

employeeEmailstring

Fuzzy matches any of a business borrower's employees' email addresses.

employeeEmailExactstring

Exactly matches any of a business borrower's employees' email addresses.

employeePhonestring

Exactly matches any of a business borrower's employees' phone numbers.

Note that Peach currently only supports US phone numbers.

You may search with any US phone number format. For example (570)123-1234, +15701231234 are all treated as identical 570-123-1234 numbers.

employeeNamestring

Fuzzy matches a business borrower's employee's name. This will never match a person borrower.

firstNamestring

Fuzzy matches a borrower's first name.

firstNamePartialstring

Exactly matches a substring of the borrower's first name.

For example, if a borrower's first name were 'William',

firstNamePartial=Will would match because it is exactly contained in the first name.
firstNamePartial=lia would match because it is exactly contained in the first name.
firstNamePartial=Bill would NOT match because, while close, it is not exactly contained in the first name.

fullNamestring

Fuzzy matches all parts of a borrower's full name. (If the borrower is a business this will also match against the business name and business legal name.)

incorporatedStatestring

Exactly matches the incorporatedState of business borrowers.

idstring

Exactly matches a borrower's ID. Can be either the Peach ID (like BO-XXXX-XXXX) or the external ID.

interactionIdstring

Exactly matches the ID of an interaction sent to or receieved from the borrower. Can be either the Peach ID (like IN-XXXX-XXXX) or the external ID.

Example:interactionId=IN-1234-ABCD

lastNamestring

Fuzzy matches a borrower's last name.

lastNamePartialstring

Exactly matches a substring of the borrower's last name, following the same rules as for firstNamePartial.

legalRepFirstNamestring

Fuzzy match the first name of any of a borrower's legal representatives.

legalRepLastNamestring

Fuzzy match the last name of any of a borrower's legal representatives.

legalRepEmailstring

Fuzzy match any email of any of a borrower's legal representatives.

legalRepPhonestring

Exactly match any phone number of any of a borrower's legal representatives.

Note that Peach currently only supports US phone numbers.

You may search with any US phone number format. For example (570)123-1234, +15701231234 are all treated as identical 570-123-1234 numbers.

loanIdstring

Exactly matches a loan's ID. Can be either the Peach ID (like LN-XXXX-XXXX) or the external ID.

Example:loanId=LN-1234-ABCD

loanIdPartialstring

Exactly matches a substring of the loan's external ID.

For example, if a loan's external ID were 6eeab840-3cbc-4c40-a19b-df3e9c040a54,

loanIdPartial=6eeab840 would match because it is exactly contained in the external ID.
loanIdPartial=cbc-4c40-a1 would match because it is exactly contained in the external ID.
loanIdPartial=9bdf3e would NOT match because, while close, it is not exactly contained in the external ID.

maidenNamestring

Fuzzy matches a borrower's maiden name.

maidenNamePartialstring

Exactly matches a substring of the borrower's maiden name, following the same rules as for firstNamePartial.

middleNamestring

Fuzzy matches a borrower's middle name.

middleNamePartialstring

Exactly matches a substring of the borrower's middle name, following the same rules as for firstNamePartial.

paymentMethodstring

Exactly match the last four digits of the borrower's payment methods on file.

phonestring

Exactly matches any of a borrower's phone numbers.

Note that Peach currently only supports US phone numbers.

You may search with any US phone number format. For example (570)123-1234, +15701231234 are all treated as identical 570-123-1234 numbers.

postalCodestring

Exactly match the postal code in any of a borrower's addresses.

statestring

Exactly match the state (as an abbreviation) for any of a borrower's addresses.

Note that the full name of a state will NOT match.

taxIdstring

Exactly matches the last four digits of any of the borrower's tax ID document numbers. The Tax ID document is either a Social Security Number (SSN), an Individual Taxpayer Identification Number (ITIN), or a passport number.

_forceIndexstring

For testing new search systems before wider deploy, specify the index to use for searching.

This parameter is for internal Peach use only and requires the superadmin person:search.force-index permission.

GET

/people/search

curl -i -X GET \
  'https://sandboxapi.peach.finance/api/people/search?_hasTheWords=string&_notTheWords=string&address=string&bankruptcyCourtCase=string&borrowerType=business&businessName=string&caseId=string&city=string&dateOfBirth=2019-08-24&email=string&emailExact=string&employeeEmail=string&employeeEmailExact=string&employeePhone=string&employeeName=string&firstName=string&firstNamePartial=string&fullName=string&incorporatedState=string&id=string&interactionId=IN-1234-ABCD&lastName=string&lastNamePartial=string&legalRepFirstName=string&legalRepLastName=string&legalRepEmail=string&legalRepPhone=string&loanId=LN-1234-ABCD&loanIdPartial=string&maidenName=string&maidenNamePartial=string&middleName=string&middleNamePartial=string&paymentMethod=string&phone=string&postalCode=string&state=string&taxId=string&_forceIndex=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

dataArray of objects(Person)

searchobject

Response

{
  "data": [
    { … }
  ],
  "search": {
    "maxScore": 0.1,
    "scores": {}
  }
}