Skip to main content
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 — each scope page includes the generated enum tables for that scope.

​
Base Enums

These enums are available at the root level of the SDK. 
import {
  ClientType,
  ClientRole,
  ClientRelationshipType,
  AddressType,
  BankAccountType,
  ContactMethodType,
  Currency,
  Country,
  DocumentCategory,
  DocumentStatus,
  TransactionStatus,
  AlertStatus,
} from "@artu-ai/compliance-sdk";

​
ClientType

Type of client entity.
ValueDescription
IndividualIndividual
CompanyCompany
TrustTrust

​
ClientRole

Role of a client in a transaction.
ValueDescription
SenderTransaction sender
ReceiverTransaction receiver
BeneficiaryTransaction beneficiary
OtherOther role

​
ClientRelationshipType

Type of relationship between clients.
ValueDescription
LegalRepresentativeLegal representative
ControllingBeneficiaryControlling beneficiary

​
AddressType

Purpose/category of an address.
ValueDescription
HomeHome
BusinessBusiness
MailingMailing
LegalLegal
OtherOther

​
BankAccountType

Type of bank account.
ValueDescription
CheckingChecking
SavingsSavings
InvestmentInvestment
OtherOther

​
ContactMethodType

Type of contact method.
ValueDescription
EmailEmail
PhonePhone
MobileMobile
FaxFax
OtherOther

​
Currency

ISO 4217 currency codes plus cryptocurrency symbols. Includes 180+ fiat currencies and 600+ cryptocurrencies. 
Currency.MXN; // "MXN"
Currency.USD; // "USD"
Currency.EUR; // "EUR"
Currency.BTC; // "BTC"
Currency.ETH; // "ETH"

​
Country

ISO 3166-1 country codes (249 countries). 
Country.MX; // "MX"
Country.US; // "US"
Country.GB; // "GB"

​
DocumentCategory

Universal document categorization.
ValueDescription
IdentityIdentity Document
TaxTax Document
AddressProof of Address
IncorporationIncorporation Document
FinancialFinancial Document
OtherOther

​
DocumentStatus

Lifecycle status of a document.
ValueDescription
PendingUploadPending upload
UploadedFile uploaded
ProcessingFile being processed
VerifiedDocument verified
RejectedDocument rejected
ExpiredDocument expired
NoFileRecord without file

​
TransactionStatus

Lifecycle status of a transaction.
ValueDescription
NotApplicableNot applicable
PendingPending
CompletedCompleted
FailedFailed
CancelledCancelled

​
AlertStatus

Alert lifecycle status.
ValueDescription
NewJust created by a workflow; not yet reviewed
InReviewAn analyst has opened/claimed the alert
ReportDraftReporting started; no validation result yet
ReportValidatingReport validation in progress
ReportValidLatest generated report passed validation
ReportInvalidLatest generated report failed validation
FiledReport submitted and acknowledgment uploaded (terminal)
ResolvedClosed without filing (terminal)
DismissedFalse positive / not actionable (terminal)

​
Workflow Enums

Enums used by the monitoring workflows engine. Available from @artu-ai/shared. 
import {
  WorkflowStatus,
  WorkflowTriggerType,
  WorkflowTriggerEntity,
  WorkflowTriggerEvent,
  WorkflowVariableScope,
  ConditionOperator,
  TimeUnit,
  AggregationFunction,
} from "@artu-ai/shared";

​
WorkflowStatus

Lifecycle status of a monitoring workflow.
ValueDescription
DraftDraft
ActiveActive
InactiveInactive

​
WorkflowTriggerType

What triggers workflow execution.
ValueDescription
EventEvent-based
ScheduleSchedule-based

​
WorkflowTriggerEntity

Entity that triggers a workflow.
ValueDescription
TransactionTransaction
ClientClient

​
WorkflowTriggerEvent

Event that triggers a workflow.
ValueDescription
CreatedEntity created
UpdatedEntity updated

​
WorkflowVariableScope

Scope of a workflow variable.
ValueDescription
SystemSystem-wide variable
OrganizationOrganization-level variable

​
ConditionOperator

Operators for workflow conditions.
ValueDescription
EqEqual
NeqNot equal
GtGreater than
GteGreater than or equal
LtLess than
LteLess than or equal
InIn set
NinNot in set
ContainsContains
StartsWithStarts with
EndsWithEnds with
ExistsExists
NotExistsDoes not exist

​
TimeUnit

Time units for workflow windows and schedules.
ValueDescription
MinutesMinutes
HoursHours
DaysDays
WeeksWeeks
MonthsMonths
YearsYears

​
AggregationFunction

Aggregation functions for workflow conditions.
ValueDescription
SumSum
CountCount
AvgAverage
MinMinimum
MaxMaximum

​
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. For example:
  • Mexico — MexDocumentType, MexEntityType, CodigoActividad, GiroMercantil, and more → Mexico
  • Mexico ARI — FormaPago, InstrumentoMonetario, TipoAlerta, TipoInmueble, TipoOperacion → Mexico ARI
  • Mexico AVI — ActivoVirtual, InstrumentoMonetario, TipoAlerta, TipoOperacion, TipoTransferencia → Mexico AVI
  • Mexico INM — FiguraCliente, FiguraSO, FormaPago, InstrumentoMonetario, TipoAlerta, TipoInmueble, TipoOperacion → Mexico INM
  • Mexico JYS — InstrumentoMonetario, LineaNegocio, MedioOperacion, TipoAlerta, TipoBien, TipoInmueble, TipoLiquidacion, TipoOperacion, TipoSucursal → Mexico JYS
  • Mexico MJR — FormaPago, InstrumentoMonetario, TipoAlerta, TipoBien, TipoOperacion, UnidadComercializada → Mexico MJR
  • Mexico MPC — InstrumentoMonetario, TipoAlerta, TipoGarantia, TipoInmueble, TipoOperacion → Mexico MPC
  • Mexico TSC — TipoAlerta, TipoOperacion, TipoTarjeta → Mexico TSC
  • Mexico CNBV Transmisor — InstrumentoMonetario, TipoOperacion, TipoReporte → Mexico CNBV Transmisor
Scope-specific enums are accessible via the Enums namespace on each sub-entry point: 
import { Enums } from "@artu-ai/compliance-sdk/mx/av/avi";
const { TipoOperacion, TipoAlerta, ActivoVirtual, InstrumentoMonetario } = Enums;