Entity

An Entity represents the legal person or business entity that uses Plane. In most cases, this is your company or organization. When you signed up for Plane, we requested information about your business. This information was used to populate the Entity record on your account, which serves as the foundational business identity for all operations within Plane. We use this Entity information for contracts, tax reporting, payment compliance, and any other situation where we need to precisely identify the legal entity on whose behalf we are acting.

Attributes

string

Unique identifier for the entity, e.g. ent_cNqYX2J3s9bI2Aa.

string

Object type. Always entity.

string

Identifier of the workspace the entity belongs to.

string

The legal name of the entity as registered with government authorities.

string

Two-letter ISO country code (ISO 3166-1 alpha-2) representing the country where the entity is legally domiciled.

object

The primary business address of the entity.

Show address attributes

string

Address line1 (e.g. street or company name).

string

Address line2 (e.g. apartment, suite, unit or building).

string

City, district, suburb, town, or village.

string

State, county, province, or region.

string

ZIP or postal code.

string

Two-letter country code (ISO 3166-1 alpha-2).

string

The entity’s verification (KYB) status. Possible values: unverified (verification has not yet cleared; the default at creation, and the status an entity returns to if verification fails), pending (details submitted and under review), or verified (verification cleared).

string

“Doing Business As” name - the trade name used by the entity if different from the legal name. Optional.

string

A brief description of the entity’s business activities or purpose. Optional.

string

Primary contact email address for the entity.

string

Primary contact phone number for the entity.

string

The entity’s primary website URL. Optional.

string

The legal structure of the entity. Allowed values are corporation, llc, or partnership.

object

Details about the entity’s legal formation.

Show formation attributes

string

Two-letter country code (ISO 3166-1 alpha-2) where the entity was formed.

string

The state or jurisdiction where the entity was formed.

string

The date when the entity was legally formed or incorporated.

object

Tax identification information for the entity. Write-only: accepted when creating or updating an entity, and never returned in API responses.

Show tax_id attributes

string

The tax identification number (e.g. EIN in the US, Business Number in Canada).

string

The type of tax ID (e.g. ein, ssn, business_number).

string

Two-letter country code for the jurisdiction that issued the tax ID.

object

Arbitrary key-value data attached to the entity.

string

Time at which the entity was created.

string

Time at which the entity was last updated.

{
  "id": "ent_cNqYX2J3s9bI2Aa",
  "object": "entity",
  "workspace": "wsp_Xb2fPlgnLc",
  "name": "Acme Corporation",
  "country": "US",
  "address": {
    "line1": "123 Business Ave",
    "line2": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "US"
  },
  "status": "verified",
  "dba": "Acme",
  "description": "Technology consulting and software development services",
  "email": "contact@acmecorp.com",
  "phone": "+15551234567",
  "website": "https://www.acmecorp.com",
  "structure": "corporation",
  "formation": {
    "country": "US",
    "state": "DE",
    "date": "2020-03-15"
  },
  "metadata": {},
  "created": "2024-01-15T00:00:00Z",
  "updated": "2024-02-01T00:00:00Z"
}

Working with the API

Core Resources

HR

Workforce

Benefits

Payments

Payroll

Documents

Time

Labor

Legal

Attributes

​Attributes

Attributes