Update representative

Request

Security

oauth2(Required scopes: legal.representative:update) 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.

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

The legal representative object unique identifier.

Query

validateboolean

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

Default:true

Bodyapplication/jsonrequired

addressobject(Address)

For callers lacking the person:read.pii permission the street-level fields (addressLine1, addressLine2, POBox) are returned as null; city, state, postal code, and country are retained.

emailstring

The email address of a legal entity.

Masked (e.g. j***@example.com) for callers lacking the person:read.pii permission.

nameobject or null(Name)

Name of the person.

otherEmailstring

An additional email address of a legal entity.

Masked (e.g. j***@example.com) for callers lacking the person:read.pii permission.

otherPhonestring

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

Masked to the last four digits (e.g. ********1234) for callers lacking the person:read.pii permission.

phonestring

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

Masked to the last four digits (e.g. ********1234) for callers lacking the person:read.pii permission.

statusstring

Legal representative's status.

Enum:"active""nonResponsive""inactive""archived"

PUT

/people/{personId}/legal-representatives/{legalRepresentativeId}

curl -i -X PUT \
  'https://sandboxapi.peach.finance/api/people/{personId}/legal-representatives/{legalRepresentativeId}?validate=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": {
      "POBox": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "country": "string",
      "countyOrRegion": "string",
      "postalCode": "string",
      "state": "strin"
    },
    "email": "string",
    "name": {
      "firstName": "string",
      "lastName": "string",
      "maidenLastName": "string",
      "middleName": "string",
      "preferredFirstName": "string",
      "prefix": "string",
      "suffix": "strin"
    },
    "otherEmail": "string",
    "otherPhone": "string",
    "phone": "string",
    "status": "active"
  }'

Responses

Success

Bodyapplication/json

messagestring

Description of the server action or error.

statusinteger

HTTP status code.

dataobject(legalRepresentative)

Contains details about an entity that legally represents a borrower.

Response

{
  "message": "string",
  "status": 0,
  "data": {
    "createdAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "address": { … },
    "email": "string",
    "name": { … },
    "object": "legalRepresentative",
    "otherEmail": "string",
    "otherPhone": "string",
    "phone": "string",
    "redactedFields": [ … ],
    "status": "active",
    "statusUpdatedAt": "2019-08-24T14:15:22Z",
    "validAddress": true
  }
}