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.

Operations

Get representatives

Request

Security

oauth2(Required scopes: legal.representative:list) or bearerAuth or apiKeyHeader

Path

personIdstring(AnyId)^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+$write-onlyrequired

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

Query

limitinteger, [ 1 .. 100 ]

The maximum count of results to retrieve.

Default:25

startingAfterstring

Return results starting after the provided object identifier.

endingBeforestring

Return results ending before the provided object identifier.

includeArchivedboolean

Include archived representatives into the result.

Default:false

GET

/people/{personId}/legal-representatives

curl -i -X GET \
  'https://sandboxapi.peach.finance/api/people/{personId}/legal-representatives?limit=25&startingAfter=string&endingBefore=string&includeArchived=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

countintegerread-only

Total number of items in this result.

statusinteger

HTTP status code.

dataArray of objects(legalRepresentative)

Array of legal entities

Response

{
  "count": 0,
  "status": 0,
  "data": [
    { … }
  ]
}