Peach Finance

Legal Representation

If a borrower is represented by a legal entity you can add the legal entity details. Normally, if a borrower is represented by a status=active legal entity we block future debt collection related communications.

Create representative

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.

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
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
status
string

Legal representative's status.

Enum: "active" "nonResponsive" "inactive" "archived"
object or null (Name)

Name of the person.

object (Address)

The mailing address.

phone
string

The phone number of a legal entity. This should be provided in E.164 format.

otherPhone
string

An additional phone number of a legal entity. This should be provided in E.164 format.

email
string

The email address of a legal entity.

otherEmail
string

An additional email address of a legal entity.

Responses
200

Success

post/people/{personId}/legal-representatives
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "status": "active",
  • "name": {
    },
  • "address": {
    },
  • "phone": "string",
  • "otherPhone": "string",
  • "email": "string",
  • "otherEmail": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get representatives

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.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

includeArchived
boolean
Default: false

Include archived representatives into the result.

Responses
200

Success

get/people/{personId}/legal-representatives
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Get representative by ID

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.

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

The legal representative object unique identifier.

Responses
200

Success

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

Update representative

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.

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

The legal representative object unique 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
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
status
string

Legal representative's status.

Enum: "active" "nonResponsive" "inactive" "archived"
object or null (Name)

Name of the person.

object (Address)

The mailing address.

phone
string

The phone number of a legal entity. This should be provided in E.164 format.

otherPhone
string

An additional phone number of a legal entity. This should be provided in E.164 format.

email
string

The email address of a legal entity.

otherEmail
string

An additional email address of a legal entity.

Responses
200

Success

put/people/{personId}/legal-representatives/{legalRepresentativeId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "status": "active",
  • "name": {
    },
  • "address": {
    },
  • "phone": "string",
  • "otherPhone": "string",
  • "email": "string",
  • "otherEmail": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}
➔ Next to Verifications