Get a entity
Returns a entity on the account by its entityId.
Authorizations
Owner-scoped bearer token. The owner all requests are scoped to is derived from the token.
Path Parameters
Slate's UUID for the account (returned by the upsert). The canonical account identifier.
Slate's UUID for the entity (customer). The canonical entity identifier.
Response
The entity.
A entity (customer) on an account, with their addresses.
Slate's stable UUID for the entity.
The matter this entity belongs to.
The entity's role on the account.
AUTHORIZED_USER, BORROWER, DEBT_SETTLEMENT_COMPANY, NON_BORROWING_DEFENDANT 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.
The entity's identifier in your system.
The last four digits of the entity's SSN/EIN. The full value is never returned.
Where communications to the entity are sent — the address of record for correspondence.
A postal address.
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.
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.
