Entity

An Entity represents an organizational unit within a company that can hold bank accounts, have financial connections, and manage operations.

Entity Object

{
  "id": "Z2lkOi8vd2FsbGV0LWFwcC9FbnRpdHkvMQ",
  "name": "US Subsidiary",
  "country_alpha2": "US",
  "company_id": "Z2lkOi8vd2FsbGV0LWFwcC9Db21wYW55LzE",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z"
}

Attributes

Attribute	Type	Description
id	string	Unique identifier for the entity
name	string	Entity name
country_alpha2	string	ISO 3166-1 alpha-2 two-letter country code (e.g., "US", "GB")
company_id	string	ID of the parent company
created_at	string	ISO 8601 timestamp when the entity was created
updated_at	string	ISO 8601 timestamp when the entity was last updated

Available Operations

• List Entities - Returns all entities for a specific company
• Create Entity - Create a new entity within a company
• Get Entity - Retrieve details of a specific entity by ID
• Update Entity - Update entity details (subject to restrictions below)
• Delete Entity - Remove an entity (subject to restrictions below)

Update and Delete Restrictions

• Entities with multi-currency accounts enabled cannot be updated or deleted if the multi-currency feature application is in any status other than CREATED

For detailed API endpoints and request/response examples, see the Entities API Reference.