Skip to main content
POST
Create a entity on an account

Authorizations

Authorization
string
header
required

Owner-scoped bearer token. The owner all requests are scoped to is derived from the token.

Path Parameters

accountId
string<uuid>
required

Slate's UUID for the account (returned by the upsert). The canonical account identifier.

Body

application/json
type
enum<string>
required

The entity's role on the account.

Available options:
AUTHORIZED_USER,
BORROWER,
DEBT_SETTLEMENT_COMPANY,
NON_BORROWING_DEFENDANT
name
string

The entity's name ("FIRST MIDDLE LAST SUFFIX" for a person). Internal first/middle/last/suffix name fields are derived from it.

dateOfBirth
string<date>
phone
string
email
string
alsoKnown
string
externalEntityId
string

The entity's identifier in your system.

languagePreference
string
ssn
string

The entity's SSN/EIN in the clear (write-only). Stored encrypted; never returned.

officialAddress
object

Where communications to the entity are sent — the address of record for correspondence.

mailingAddress
object

A postal address.

physicalAddress
object

The entity's physical location — used to determine firm placement and which templates to use. When not provided, processes fall back to the official address in its place.

metadata
object

Custom key/value pairs you can attach to an object for reporting, analytics, or attributes Slate does not model natively — inspired by Stripe metadata. Values are strings. Limits: at most 50 keys, each key at most 40 characters and each value at most 500 characters. On a partial update (PATCH) the keys you send are merged into the existing metadata; send a key with an empty-string value to remove it. An account upsert (full snapshot) replaces the whole map.

Example:

Response

The created entity.

A entity (customer) on an account, with their addresses.

entityId
string<uuid>
required
read-only

Slate's stable UUID for the entity.

matterId
string<uuid>
required
read-only

The matter this entity belongs to.

type
enum<string>
required

The entity's role on the account.

Available options:
AUTHORIZED_USER,
BORROWER,
DEBT_SETTLEMENT_COMPANY,
NON_BORROWING_DEFENDANT
name
string

The entity's name — for a person, natural "FIRST MIDDLE LAST SUFFIX" form; for an organization, its name. Slate derives internal first/middle/last/suffix name fields from this.

dateOfBirth
string<date>
phone
string
email
string
alsoKnown
string
externalEntityId
string

The entity's identifier in your system.

languagePreference
string
ssnLastFour
string
read-only

The last four digits of the entity's SSN/EIN. The full value is never returned.

officialAddress
object

Where communications to the entity are sent — the address of record for correspondence.

mailingAddress
object

A postal address.

physicalAddress
object

The entity's physical location — used to determine firm placement and which templates to use. When not provided, processes fall back to the official address in its place.

metadata
object

Custom key/value pairs you can attach to an object for reporting, analytics, or attributes Slate does not model natively — inspired by Stripe metadata. Values are strings. Limits: at most 50 keys, each key at most 40 characters and each value at most 500 characters. On a partial update (PATCH) the keys you send are merged into the existing metadata; send a key with an empty-string value to remove it. An account upsert (full snapshot) replaces the whole map.

Example: