# Organization

The **Organization** entity defines the foundational structure for different types of organizations, such as financial institutions, educational bodies, healthcare facilities, and corporations. This allows for flexible integration and management of organizational data.

***

#### Attributes

* **ID (`UUID`)**\
  A globally unique identifier automatically generated for each organization. This ID is used across the platform to uniquely identify an organization.
* **Name (`String`)**\
  The official name of the organization. This field is mandatory and is used to reference the organization throughout the platform.
* **Email (`String`)**\
  Optional contact email for the organization. Useful for communication and notifications.

<details>

<summary><strong>Organization Type (<code>Enum</code>)</strong><br></summary>

Defines the type or category of the organization. The available options include:

* Financial Institution

- Educational Institution

* Non-Profit Organization

- Government Entity

* Corporate Entity

- Healthcare Organization (Public/Private)

* Technology Company

- Other

</details>

<details>

<summary><strong>Organization Scope (<code>Enum</code>)</strong></summary>

Defines the operational reach of the organization. This helps classify the scope of their operations. The possible values are:

* Local (Municipal)

- Regional

* National

- International

* Continental

- Global

* Other

</details>

<details>

<summary><strong>Organization Status (<code>Enum</code>)</strong></summary>

Represents the current standing of the organization within the system. It reflects their operational readiness and system access:

* Active
* Suspended
* Inactive
* Pending Approval
* Dissolved
* Merged
* Under Review
* Sanctioned
* Other

</details>

* **Legal Data (`LegalData`)**\
  This field links to the organization’s legal details, including registration, tax information, and other legal identifiers. It is crucial for maintaining compliance and auditing.
* **Webhook URL (`String`)**\
  If the organization requires integration with external systems, this is the URL where the platform sends webhook notifications for key events.
* **Website URL (`String`)**\
  The official website of the organization, which may be useful for verification or display purposes.
* **API Key (`String`)**\
  A unique, mandatory key assigned to each organization for secure API interactions. This API key ensures that only authorized organizations can access platform services or request data.

<details>

<summary><strong>Enablement Status (<code>Embedded</code>)</strong></summary>

See Common Data

This embedded field tracks the organization’s compliance with payment, legal, and data integrity requirements. It includes:

* **Payment Status**: Whether the organization has outstanding payments or is debt-free.
* **Legal Status**: Whether the organization is in legal compliance or has unresolved legal issues.
* **Revocation Status**: Whether the organization's API key or permissions have been revoked.
* **Data Integrity Status**: Ensures the organization’s data is valid and complies with integrity checks.

</details>
