Borrowers

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

Status of borrower(s).

The maximum count of results to retrieve.

The data attributes by which to sort the results.

Return results starting after the provided object identifier.

Return results ending before the provided object identifier.

Exactly match the type of borrower.

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.

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.

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.

Exactly matches a bankruptcy court case ID.

Exactly match the type of borrower.

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

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

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

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

Fuzzy matches any of a borrower's email addresses.

Exactly matches any of a borrower's email addresses.

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

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

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.

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

Fuzzy matches a borrower's first name.

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.

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.)

Exactly matches the incorporatedState of business borrowers.

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

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.

Fuzzy matches a borrower's last name.

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

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

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

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

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.

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

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.

Fuzzy matches a borrower's maiden name.

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

Fuzzy matches a borrower's middle name.

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

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

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.

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

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.

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.