Loan Investors

Investors associated with a loan.

Get loan investors

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.

loanId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

Responses
200

success

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

Update loan investors

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.

loanId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

Request Body schema: application/json
required
effectiveDate
string <date>

The date at which this ownership structure came into effect.

Array of objects (Loan Investor Association)
Responses
204

updated

put/people/{personId}/loans/{loanId}/investors
Request samples
application/json
{
  • "effectiveDate": "2019-08-24",
  • "investors": [
    ]
}