> ## Documentation Index
> Fetch the complete documentation index at: https://docs.artu.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Enums

> Cross-scope SDK enums reference — ClientType, Currency, DocumentStatus, Workflow enums, and more

This page documents cross-scope enums exported by the TypeScript SDK. For Mexico-scope-specific enums (TipoOperacion, TipoAlerta, ActivoVirtual, Localidades, etc.), see the [Scopes tab](/scopes/overview) — each scope page includes the generated enum tables for that scope.

## Base Enums

These enums are available at the root level of the SDK.

```typescript theme={null}
import {
  ClientType,
  ClientRole,
  ClientRelationshipType,
  AddressType,
  BankAccountType,
  ContactMethodType,
  Currency,
  Country,
  DocumentCategory,
  DocumentStatus,
  TransactionStatus,
  AlertStatus,
} from "@artu-ai/compliance-sdk";
```

### ClientType

Type of client entity.

| Value        | Description |
| ------------ | ----------- |
| `Individual` | Individual  |
| `Company`    | Company     |
| `Trust`      | Trust       |

### ClientRole

Role of a client in a transaction.

| Value         | Description             |
| ------------- | ----------------------- |
| `Sender`      | Transaction sender      |
| `Receiver`    | Transaction receiver    |
| `Beneficiary` | Transaction beneficiary |
| `Other`       | Other role              |

### ClientRelationshipType

Type of relationship between clients.

| Value                    | Description             |
| ------------------------ | ----------------------- |
| `LegalRepresentative`    | Legal representative    |
| `ControllingBeneficiary` | Controlling beneficiary |

### AddressType

Purpose/category of an address.

| Value      | Description |
| ---------- | ----------- |
| `Home`     | Home        |
| `Business` | Business    |
| `Mailing`  | Mailing     |
| `Legal`    | Legal       |
| `Other`    | Other       |

### BankAccountType

Type of bank account.

| Value        | Description |
| ------------ | ----------- |
| `Checking`   | Checking    |
| `Savings`    | Savings     |
| `Investment` | Investment  |
| `Other`      | Other       |

### ContactMethodType

Type of contact method.

| Value    | Description |
| -------- | ----------- |
| `Email`  | Email       |
| `Phone`  | Phone       |
| `Mobile` | Mobile      |
| `Fax`    | Fax         |
| `Other`  | Other       |

### Currency

ISO 4217 currency codes plus cryptocurrency symbols. Includes 180+ fiat currencies and 600+ cryptocurrencies.

```typescript theme={null}
Currency.MXN; // "MXN"
Currency.USD; // "USD"
Currency.EUR; // "EUR"
Currency.BTC; // "BTC"
Currency.ETH; // "ETH"
```

### Country

ISO 3166-1 country codes (249 countries).

```typescript theme={null}
Country.MX; // "MX"
Country.US; // "US"
Country.GB; // "GB"
```

### DocumentCategory

Universal document categorization.

| Value           | Description            |
| --------------- | ---------------------- |
| `Identity`      | Identity Document      |
| `Tax`           | Tax Document           |
| `Address`       | Proof of Address       |
| `Incorporation` | Incorporation Document |
| `Financial`     | Financial Document     |
| `Other`         | Other                  |

### DocumentStatus

Lifecycle status of a document.

| Value           | Description          |
| --------------- | -------------------- |
| `PendingUpload` | Pending upload       |
| `Uploaded`      | File uploaded        |
| `Processing`    | File being processed |
| `Verified`      | Document verified    |
| `Rejected`      | Document rejected    |
| `Expired`       | Document expired     |
| `NoFile`        | Record without file  |

### TransactionStatus

Lifecycle status of a transaction.

| Value           | Description    |
| --------------- | -------------- |
| `NotApplicable` | Not applicable |
| `Pending`       | Pending        |
| `Completed`     | Completed      |
| `Failed`        | Failed         |
| `Cancelled`     | Cancelled      |

### AlertStatus

Alert lifecycle status.

| Value              | Description                                             |
| ------------------ | ------------------------------------------------------- |
| `New`              | Just created by a workflow; not yet reviewed            |
| `InReview`         | An analyst has opened/claimed the alert                 |
| `ReportDraft`      | Reporting started; no validation result yet             |
| `ReportValidating` | Report validation in progress                           |
| `ReportValid`      | Latest generated report passed validation               |
| `ReportInvalid`    | Latest generated report failed validation               |
| `Filed`            | Report submitted and acknowledgment uploaded (terminal) |
| `Resolved`         | Closed without filing (terminal)                        |
| `Dismissed`        | False positive / not actionable (terminal)              |

***

## Workflow Enums

Enums used by the monitoring workflows engine. Available from `@artu-ai/shared`.

```typescript theme={null}
import {
  WorkflowStatus,
  WorkflowTriggerType,
  WorkflowTriggerEntity,
  WorkflowTriggerEvent,
  WorkflowVariableScope,
  ConditionOperator,
  TimeUnit,
  AggregationFunction,
} from "@artu-ai/shared";
```

### WorkflowStatus

Lifecycle status of a monitoring workflow.

| Value      | Description |
| ---------- | ----------- |
| `Draft`    | Draft       |
| `Active`   | Active      |
| `Inactive` | Inactive    |

### WorkflowTriggerType

What triggers workflow execution.

| Value      | Description    |
| ---------- | -------------- |
| `Event`    | Event-based    |
| `Schedule` | Schedule-based |

### WorkflowTriggerEntity

Entity that triggers a workflow.

| Value         | Description |
| ------------- | ----------- |
| `Transaction` | Transaction |
| `Client`      | Client      |

### WorkflowTriggerEvent

Event that triggers a workflow.

| Value     | Description    |
| --------- | -------------- |
| `Created` | Entity created |
| `Updated` | Entity updated |

### WorkflowVariableScope

Scope of a workflow variable.

| Value          | Description                 |
| -------------- | --------------------------- |
| `System`       | System-wide variable        |
| `Organization` | Organization-level variable |

### ConditionOperator

Operators for workflow conditions.

| Value        | Description           |
| ------------ | --------------------- |
| `Eq`         | Equal                 |
| `Neq`        | Not equal             |
| `Gt`         | Greater than          |
| `Gte`        | Greater than or equal |
| `Lt`         | Less than             |
| `Lte`        | Less than or equal    |
| `In`         | In set                |
| `Nin`        | Not in set            |
| `Contains`   | Contains              |
| `StartsWith` | Starts with           |
| `EndsWith`   | Ends with             |
| `Exists`     | Exists                |
| `NotExists`  | Does not exist        |

### TimeUnit

Time units for workflow windows and schedules.

| Value     | Description |
| --------- | ----------- |
| `Minutes` | Minutes     |
| `Hours`   | Hours       |
| `Days`    | Days        |
| `Weeks`   | Weeks       |
| `Months`  | Months      |
| `Years`   | Years       |

### AggregationFunction

Aggregation functions for workflow conditions.

| Value   | Description |
| ------- | ----------- |
| `Sum`   | Sum         |
| `Count` | Count       |
| `Avg`   | Average     |
| `Min`   | Minimum     |
| `Max`   | Maximum     |

***

## Scope-Specific Enums

Mexico-specific and other scope-specific enums (document types, entity types, operation types, alert types, monetary instruments, and more) are documented on the individual scope pages in the [Scopes tab](/scopes/overview).

For example:

* **Mexico** — `MexDocumentType`, `MexEntityType`, `CodigoActividad`, `GiroMercantil`, and more → [Mexico](/scopes/mexico)
* **Mexico ARI** — `FormaPago`, `InstrumentoMonetario`, `TipoAlerta`, `TipoInmueble`, `TipoOperacion` → [Mexico ARI](/scopes/mx-av-ari)
* **Mexico AVI** — `ActivoVirtual`, `InstrumentoMonetario`, `TipoAlerta`, `TipoOperacion`, `TipoTransferencia` → [Mexico AVI](/scopes/mx-av-avi)
* **Mexico INM** — `FiguraCliente`, `FiguraSO`, `FormaPago`, `InstrumentoMonetario`, `TipoAlerta`, `TipoInmueble`, `TipoOperacion` → [Mexico INM](/scopes/mx-av-inm)
* **Mexico JYS** — `InstrumentoMonetario`, `LineaNegocio`, `MedioOperacion`, `TipoAlerta`, `TipoBien`, `TipoInmueble`, `TipoLiquidacion`, `TipoOperacion`, `TipoSucursal` → [Mexico JYS](/scopes/mx-av-jys)
* **Mexico MJR** — `FormaPago`, `InstrumentoMonetario`, `TipoAlerta`, `TipoBien`, `TipoOperacion`, `UnidadComercializada` → [Mexico MJR](/scopes/mx-av-mjr)
* **Mexico MPC** — `InstrumentoMonetario`, `TipoAlerta`, `TipoGarantia`, `TipoInmueble`, `TipoOperacion` → [Mexico MPC](/scopes/mx-av-mpc)
* **Mexico TSC** — `TipoAlerta`, `TipoOperacion`, `TipoTarjeta` → [Mexico TSC](/scopes/mx-av-tsc)
* **Mexico CNBV Transmisor** — `InstrumentoMonetario`, `TipoOperacion`, `TipoReporte` → [Mexico CNBV Transmisor](/scopes/mx-cnbv-transmisor)

Scope-specific enums are accessible via the `Enums` namespace on each sub-entry point:

```typescript theme={null}
import { Enums } from "@artu-ai/compliance-sdk/mx/av/avi";
const { TipoOperacion, TipoAlerta, ActivoVirtual, InstrumentoMonetario } = Enums;
```