# Create representative

Endpoint: POST /people/{personId}/legal-representatives
Version: 2025-03-26
Security: oauth2, bearerAuth, apiKeyHeader

## Path parameters:

  - `personId` (string, required)
    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)
    Validate the contact through an external API. This is only used for addresses currently.

## Request fields (application/json):

  - `address` (object)
    The mailing address.

  - `address.POBox` (string)
    Post Office Box

  - `address.addressLine1` (string)
    Address line 1.
If `company.allowPartialAddress=false`, then this field is required, else it is not required

  - `address.addressLine2` (string)
    Address line 2.

  - `address.city` (string)
    City.

  - `address.country` (string, required)
    Country. English short name according to
[ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.

  - `address.countyOrRegion` (string)
    County or region.

  - `address.postalCode` (string, required)
    Postal code. Also known as ZIP code.

  - `address.state` (string)
    State/Province. This is a required field if the country is US or CA.

  - `email` (string)
    The email address of a legal entity.
Masked (e.g. `j***@example.com`) for callers lacking the `person:read.pii`
permission.

  - `name` (object)
    Name of the person.

  - `name.firstName` (string, required)
    A person's first name.

  - `name.lastName` (string, required)
    A person's last name.
Redacted to the first initial (e.g. `S.`) for callers lacking the
`person:read.pii` permission.

  - `name.maidenLastName` (string)
    A person's maiden name, if applicable.
Redacted to the first initial (e.g. `J.`) for callers lacking the
`person:read.pii` permission.

  - `name.middleName` (string)
    A person's middle name.
Redacted to the first initial (e.g. `A.`) for callers lacking the
`person:read.pii` permission.

  - `name.preferredFirstName` (string)
    A person's preferred first name. This name will be used for interactions
like emails, text messages, outbound calls, online portal, etc.
If no preferred name is provided, `firstName` will be used.

  - `name.prefix` (string)
    A person's name prefix.

  - `name.suffix` (string)
    A person's name suffix.

  - `otherEmail` (string)
    An additional email address of a legal entity.
Masked (e.g. `j***@example.com`) for callers lacking the `person:read.pii`
permission.

  - `otherPhone` (string)
    An additional phone number of a legal entity. This should be provided in
[E.164](https://en.wikipedia.org/wiki/E.164) format.
Masked to the last four digits (e.g. `********1234`) for callers lacking
the `person:read.pii` permission.

  - `phone` (string)
    The phone number of a legal entity. This should be provided in
[E.164](https://en.wikipedia.org/wiki/E.164) format.
Masked to the last four digits (e.g. `********1234`) for callers lacking
the `person:read.pii` permission.

  - `status` (string)
    Legal representative's status.
    Enum: "active", "nonResponsive", "inactive", "archived"

## Response 200 fields (application/json):

  - `message` (string)
    Description of the server action or error.

  - `status` (integer)
    HTTP status code.

  - `data` (object)
    Contains details about an entity that legally represents a borrower.

  - `data.createdAt` (string)

  - `data.deletedAt` (string)

  - `data.id` (string)

  - `data.updatedAt` (string)

  - `data.address` (object)
    The mailing address.

  - `data.address.POBox` (string)
    Post Office Box

  - `data.address.addressLine1` (string)
    Address line 1.
If `company.allowPartialAddress=false`, then this field is required, else it is not required

  - `data.address.addressLine2` (string)
    Address line 2.

  - `data.address.city` (string)
    City.

  - `data.address.country` (string, required)
    Country. English short name according to
[ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.

  - `data.address.countyOrRegion` (string)
    County or region.

  - `data.address.object` (string)
    Enum: "address"

  - `data.address.postalCode` (string, required)
    Postal code. Also known as ZIP code.

  - `data.address.state` (string)
    State/Province. This is a required field if the country is US or CA.

  - `data.address.timezone` (string)
    Timezone for the address.

  - `data.email` (string)
    The email address of a legal entity.
Masked (e.g. `j***@example.com`) for callers lacking the `person:read.pii`
permission.

  - `data.name` (object)
    Name of the person.

  - `data.name.createdAt` (string)

  - `data.name.current` (boolean)
    Name is flagged as current.

  - `data.name.deletedAt` (string)

  - `data.name.effectiveAt` (string)

  - `data.name.firstName` (string, required)
    A person's first name.

  - `data.name.id` (string)

  - `data.name.lastName` (string, required)
    A person's last name.
Redacted to the first initial (e.g. `S.`) for callers lacking the
`person:read.pii` permission.

  - `data.name.maidenLastName` (string)
    A person's maiden name, if applicable.
Redacted to the first initial (e.g. `J.`) for callers lacking the
`person:read.pii` permission.

  - `data.name.middleName` (string)
    A person's middle name.
Redacted to the first initial (e.g. `A.`) for callers lacking the
`person:read.pii` permission.

  - `data.name.object` (string)
    Enum: "name"

  - `data.name.originalValue` (object)
    The original value for name before an update.

  - `data.name.preferredFirstName` (string)
    A person's preferred first name. This name will be used for interactions
like emails, text messages, outbound calls, online portal, etc.
If no preferred name is provided, `firstName` will be used.

  - `data.name.prefix` (string)
    A person's name prefix.

  - `data.name.source` (string)
    Enum: "peach", "lender", "externalAPI"

  - `data.name.status` (string)
    Enum: "active", "inactive"

  - `data.name.suffix` (string)
    A person's name suffix.

  - `data.name.updatedAt` (string)

  - `data.object` (string)
    Enum: "legalRepresentative"

  - `data.otherEmail` (string)
    An additional email address of a legal entity.
Masked (e.g. `j***@example.com`) for callers lacking the `person:read.pii`
permission.

  - `data.otherPhone` (string)
    An additional phone number of a legal entity. This should be provided in
[E.164](https://en.wikipedia.org/wiki/E.164) format.
Masked to the last four digits (e.g. `********1234`) for callers lacking
the `person:read.pii` permission.

  - `data.phone` (string)
    The phone number of a legal entity. This should be provided in
[E.164](https://en.wikipedia.org/wiki/E.164) format.
Masked to the last four digits (e.g. `********1234`) for callers lacking
the `person:read.pii` permission.

  - `data.redactedFields` (array)
    Paths of fields on this object whose values were hidden because your credentials lack the `person:read.pii` permission. Always present on responses that can carry personal data — an empty array means nothing was hidden. Paths are relative to this object. Objects nested inside this one, including every element of an array of objects, carry their own list rather than appearing here. A path ending in `[]` is an array of plain values such as `selfEmails[]`, and means at least one element of that array was hidden — not necessarily all of them. This field is never accepted on requests.
    Example: ["name.lastName","dateOfBirth"]

  - `data.status` (string)
    Legal representative's status.
    Enum: "active", "nonResponsive", "inactive", "archived"

  - `data.statusUpdatedAt` (string)
    The time of status update.

  - `data.validAddress` (boolean)
    Identifies the address as valid or invalid.

