Peach Finance

Investors

This object represents institutional owners of loans. Investors must be created before they can be associated with loans.

Get loan investors

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

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/companies/{companyId}/people/{personId}/loans/{loanId}/investors
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Create investor

Create an investor under the umbrella of the given company.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

query Parameters
validate
boolean
Default: true

Validate the contact through an external API. This is only used for addresses currently.

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

A lender's identifier for the investor.

legalName
required
string

The legal name of the investor.

object (Address)

The mailing address.

contactEmail
string <email>

The email of the investor's primary contact person.

contactName
string

The name of the investor's primary contact person.

contactPhone
string <= 15 characters

The phone number of the investor's primary contact person.

default
boolean
Default: false

Mark this investor as the default investor.

At loan creation, if no investors are specified in the atOrigination.investors attribute, the investor with default=true is added with shares=1 (100%).

If a new investor is created and there is another investor with default=true, the system will set default=false for the other investor.

Responses
201

created

post/companies/{companyId}/investors
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "legalName": "string",
  • "address": {
    },
  • "contactEmail": "user@example.com",
  • "contactName": "string",
  • "contactPhone": "string",
  • "default": false
}
Response samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "legalName": "string",
  • "currency": "string",
  • "address": {
    },
  • "validAddress": true,
  • "contactEmail": "user@example.com",
  • "contactName": "string",
  • "contactPhone": "string",
  • "default": false
}

Get investors

Get all investors under the given company.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Responses
200

success

get/companies/{companyId}/investors
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Get investor by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

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

Unique investor identifier.

Responses
200

success

get/companies/{companyId}/investors/{investorId}
Response samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "externalId": "string",
  • "legalName": "string",
  • "currency": "string",
  • "address": {
    },
  • "validAddress": true,
  • "contactEmail": "user@example.com",
  • "contactName": "string",
  • "contactPhone": "string",
  • "default": false
}

Update investor

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

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

Unique investor identifier.

query Parameters
validate
boolean
Default: true

Validate the contact through an external API. This is only used for addresses currently.

Request Body schema: application/json
required
object (Address)

The mailing address.

contactEmail
string <email>

The email of the investor's primary contact person.

contactName
string

The name of the investor's primary contact person.

contactPhone
string <= 15 characters

The phone number of the investor's primary contact person.

default
boolean
Default: false

Mark this investor as the default investor.

At loan creation, if no investors are specified in the atOrigination.investors attribute, the investor with default=true is added with shares=1 (100%).

If a new investor is created and there is another investor with default=true, the system will set default=false for the other investor.

Responses
204

updated

put/companies/{companyId}/investors/{investorId}
Request samples
application/json
{
  • "address": {
    },
  • "contactEmail": "user@example.com",
  • "contactName": "string",
  • "contactPhone": "string",
  • "default": false
}
➔ Next to Settlement Instruments