Entity Object

The Entity object represents a business in the Tupel system. Entities are associated with loans, payment methods, and recipients, serving as the primary business entities in the platform.

Attributes

• uid string
  Unique identifier for the entity.

• name string
  The name of the organization. Maximum length: 100 characters.

• jurisdiction string
  Two-letter country code representing the entity's jurisdiction. Possible values: BE, FR, GB, CH, NL, US, ES, DE, IT, PT, IE, PL, RO, CY or other accepted country codes.

• incorporated_at date
  Date when the entity was incorporated. Format: ISO 8601 date (YYYY-MM-DD).

• status string
  Current status of the entity. Possible values: ACTIVE, INACTIVE. Default: ACTIVE.

• type string
  Type of the entity. Possible values: PLC (Public Limited Company), LTD (Limited Company), PAR (Partnership), STR (Sole Trader), LLP (Limited Liability Partnership).

• registration_number nullable string
  Official registration number of the entity. Maximum length: 50 characters.

• tax_number nullable string
  Tax identification number of the entity. Maximum length: 50 characters.

• email string
  Primary email address for the entity. Maximum length: 128 characters.

• phone_number string
  Primary phone number for the entity. Number validation applies.

• created_at timestamp
  Time at which the entity was created in the system.

• updated_at timestamp
  Time at which the entity was last updated.

Entity Operations

The API provides several endpoints for managing entities:

• Get a Specific Entity - Retrieve a single entity by its UID
• List All Entities - Retrieve a paginated list of entities with filtering options

For detailed information about these operations, refer to the Entities documentation.