> ## 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. # Create a workflow ## OpenAPI ````yaml /openapi/workflows.json post /workflows openapi: 3.1.1 info: title: ARTU Compliance API version: 1.0.0 description: 'API for compliance management. Documentation: https://docs.artu.ai' servers: - url: https://api.artu.ai security: - bearerAuth: [] environmentHeader: [] paths: /workflows: post: tags: - Workflows summary: Create a workflow operationId: workflows.create requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 255 description: Name description: type: string maxLength: 1000 description: Description externalId: type: string maxLength: 255 description: External ID status: enum: - draft - active - inactive type: string description: Status workflow: type: object properties: nodes: type: array items: anyOf: - type: object properties: id: type: string minLength: 1 type: const: trigger.event data: type: object properties: timeout: enum: - 1h - 6h - 24h - 72h - 7d - 14d - 30d type: string default: 72h entity: enum: - transaction - client type: string description: Entity events: type: array minItems: 1 items: enum: - created - updated type: string description: Events condition: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: anyOf: - {} - {} - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: anyOf: - type: object properties: type: {} field: {} operator: {} value: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} condition: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: anyOf: - type: object properties: type: {} field: {} operator: {} value: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} condition: {} required: - type - conditions - type: object properties: type: const: not condition: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: not condition: {} required: - type required: - type - condition description: Condition required: - entity - events required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: trigger.schedule data: type: object properties: timeout: enum: - 1h - 6h - 24h - 72h - 7d - 14d - 30d type: string default: 72h cron: type: string description: Cron timezone: type: string default: UTC description: Timezone required: - cron required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: trigger.manual data: type: object properties: timeout: enum: - 1h - 6h - 24h - 72h - 7d - 14d - 30d type: string default: 72h inputs: type: array items: type: object properties: key: type: string minLength: 1 maxLength: 255 label: type: string minLength: 1 maxLength: 255 type: enum: - string - number - boolean - date - timestamp type: string description: type: string maxLength: 1000 required: type: boolean default: true defaultValue: {} required: - key - label - type description: Inputs required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: trigger.manual_file data: type: object properties: timeout: enum: - 1h - 6h - 24h - 72h - 7d - 14d - 30d type: string default: 72h columns: type: array items: type: object properties: name: type: string minLength: 1 maxLength: 255 label: type: string minLength: 1 maxLength: 255 type: enum: - string - number - boolean - date - timestamp type: string required: - name - label - type default: [] description: Columns matching: enum: - exact - case_insensitive - fuzzy type: string default: fuzzy description: Matching sheetSelection: enum: - first - by_name type: string default: first description: Sheet Selection sheetName: type: string minLength: 1 description: Sheet Name required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: trigger.api data: type: object properties: timeout: enum: - 1h - 6h - 24h - 72h - 7d - 14d - 30d type: string default: 72h jsonSchema: type: object propertyNames: type: string additionalProperties: {} default: type: object properties: example: type: string required: - example description: JSON Schema required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: source.query_transactions data: type: object properties: timeWindow: type: object properties: field: type: string default: createdAt description: Field anchor: type: string default: '{{execution.timestamp}}' description: Anchor before: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: Before after: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: After filter: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: anyOf: - {} - {} - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: anyOf: - type: object properties: type: {} field: {} operator: {} value: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} condition: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: anyOf: - type: object properties: type: {} field: {} operator: {} value: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} condition: {} required: - type - conditions - type: object properties: type: const: not condition: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: not condition: {} required: - type required: - type - condition productIds: type: array items: type: string format: uuid tagIds: type: array items: type: string format: uuid limit: type: integer minimum: -9007199254740991 maximum: 50000 exclusiveMinimum: 0 matchInputColumn: type: string matchTargetField: enum: - externalId - id type: string required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: source.query_clients data: type: object properties: timeWindow: type: object properties: field: type: string default: createdAt description: Field anchor: type: string default: '{{execution.timestamp}}' description: Anchor before: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: Before after: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: After filter: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: anyOf: - {} - {} - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: anyOf: - type: object properties: type: {} field: {} operator: {} value: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} condition: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: anyOf: - type: object properties: type: {} field: {} operator: {} value: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} condition: {} required: - type - conditions - type: object properties: type: const: not condition: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: not condition: {} required: - type required: - type - condition productIds: type: array items: type: string format: uuid tagIds: type: array items: type: string format: uuid limit: type: integer minimum: -9007199254740991 maximum: 50000 exclusiveMinimum: 0 matchInputColumn: type: string matchTargetField: enum: - externalId - id type: string required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_address data: type: object properties: addressType: enum: - home - business - mailing - legal - other type: string isPrimary: type: boolean expand: type: object properties: mode: enum: - rows - columns type: string default: rows maxColumns: type: integer minimum: 1 maximum: 20 default: 3 required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_phone data: type: object properties: isPrimary: type: boolean expand: type: object properties: mode: enum: - rows - columns type: string default: rows maxColumns: type: integer minimum: 1 maximum: 20 default: 3 required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_email data: type: object properties: isPrimary: type: boolean expand: type: object properties: mode: enum: - rows - columns type: string default: rows maxColumns: type: integer minimum: 1 maximum: 20 default: 3 required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_bank_account data: type: object properties: country: type: string type: enum: - checking - savings - investment - other type: string isPrimary: type: boolean isActive: type: boolean expand: type: object properties: mode: enum: - rows - columns type: string default: rows maxColumns: type: integer minimum: 1 maximum: 20 default: 3 required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_legal_representative data: type: object properties: expand: type: object properties: mode: enum: - rows - columns type: string default: rows maxColumns: type: integer minimum: 1 maximum: 20 default: 3 required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_controlling_beneficiary data: type: object properties: expand: type: object properties: mode: enum: - rows - columns type: string default: rows maxColumns: type: integer minimum: 1 maximum: 20 default: 3 required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_document data: type: object properties: category: enum: - identity - tax - address - incorporation - financial - other - consent type: string type: type: string status: enum: - pending_upload - uploaded - pending_review - processing - verified - rejected - expired - no_file type: string scope: enum: - MX - US type: string required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_evidence data: type: object properties: category: enum: - invoice - receipt - bank_statement - proof_of_payment - contract - shipping - other type: string type: type: string status: enum: - pending_upload - uploaded - pending_review - processing - verified - rejected - expired - no_file type: string scope: enum: - MX - US type: string required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_transaction data: type: object properties: role: enum: - base - counterparty - guarantor type: string timeWindow: type: object properties: field: type: string default: createdAt description: Field anchor: type: string default: '{{execution.timestamp}}' description: Anchor before: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: Before after: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: After description: Time Window required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_client data: type: object properties: role: enum: - base - counterparty - guarantor type: string required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: enrich.add_exchange_rate data: type: object properties: targetCurrency: type: string minLength: 1 required: - targetCurrency required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: transform.aggregate data: type: object properties: groupBy: type: array items: type: string aggregations: type: array minItems: 1 items: type: object properties: function: enum: - sum - count - avg - min - max type: string description: Function field: type: string description: Field label: type: string minLength: 1 description: Label alias: type: string minLength: 1 pattern: ^[A-Za-z_][A-Za-z0-9_]*$ description: Alias required: - function - alias required: - aggregations required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: transform.time_bucket data: type: object properties: field: type: string minLength: 1 granularity: enum: - day - week - month - quarter - year type: string default: month alias: type: string minLength: 1 default: period required: - field required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: transform.window data: type: object properties: partitionBy: type: array items: type: string orderBy: type: array items: type: object properties: field: type: string minLength: 1 direction: enum: - asc - desc type: string default: asc required: - field functions: type: array minItems: 1 items: type: object properties: function: enum: - sum - count - avg - min - max - row_number - rank - dense_rank - lag - lead type: string description: Function field: type: string description: Field offset: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 default: 1 alias: type: string minLength: 1 description: Alias required: - function - alias required: - functions required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: transform.set_column data: type: object properties: columnLabel: type: string minLength: 1 columnName: type: string minLength: 1 pattern: ^[A-Za-z_][A-Za-z0-9_]*$ columnType: enum: - string - number - boolean - date type: string default: string value: anyOf: - type: object properties: kind: const: constant value: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - kind - value - type: object properties: kind: const: conditional branches: type: array minItems: 1 items: type: object properties: when: anyOf: - {} - {} - {} - {} then: anyOf: - {} - {} else: anyOf: - anyOf: - type: string - type: number - type: boolean - type: 'null' - type: object properties: expression: type: string minLength: 1 required: - expression default: null required: - kind - branches - type: object properties: kind: const: expression expression: type: string minLength: 1 required: - kind - expression - type: object properties: kind: const: template template: type: string minLength: 1 required: - kind - template - type: object properties: kind: const: text source: type: string minLength: 1 operation: enum: - first_word - after_first_word - split_part - before_delimiter - after_delimiter - lpad - rpad type: string delimiter: type: string minLength: 1 index: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 width: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 padChar: type: string minLength: 1 maxLength: 1 required: - kind - source - operation required: - columnName - value required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: transform.python data: type: object properties: code: type: string minLength: 1 maxLength: 50000 description: Code outputColumns: type: array items: type: object properties: name: type: string minLength: 1 description: Column label path: type: string minLength: 1 description: Column key type: enum: - string - number - boolean - date - timestamp type: string description: Type required: - name - path - type description: Output columns includeInputColumns: type: boolean default: true description: Include upstream columns timeoutMs: type: integer minimum: 1000 maximum: 60000 default: 30000 description: Timeout (ms) required: - code - outputColumns required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: ai.step data: anyOf: - type: object properties: includeFullRow: type: boolean default: true model: enum: - gpt-5-nano - gemini-2.5-flash-lite - gpt-5.4-nano - gpt-5-mini - gemini-2.5-flash - deepseek-v4-flash - deepseek-v4-pro - hy3-preview type: string default: gpt-5-nano mode: const: classify prompt: type: string outputColumn: type: object properties: label: type: string minLength: 1 name: type: string minLength: 1 pattern: >- ^[A-Za-z_][A-Za-z0-9_]*(?:\.(?:[A-Za-z_][A-Za-z0-9_]*|\d+))*$ labels: type: array minItems: 2 items: type: string minLength: 1 required: - label - name - labels required: - mode - outputColumn - type: object properties: includeFullRow: type: boolean default: true model: enum: - gpt-5-nano - gemini-2.5-flash-lite - gpt-5.4-nano - gpt-5-mini - gemini-2.5-flash - deepseek-v4-flash - deepseek-v4-pro - hy3-preview type: string default: gpt-5-nano mode: const: extract prompt: type: string outputColumns: type: array minItems: 1 items: type: object properties: label: type: string minLength: 1 name: type: string minLength: 1 pattern: >- ^[A-Za-z_][A-Za-z0-9_]*(?:\.(?:[A-Za-z_][A-Za-z0-9_]*|\d+))*$ type: enum: - string - number - boolean - date - timestamp - enum type: string isArray: type: boolean default: false description: type: string enumValues: type: array items: type: string minLength: 1 enumLabels: type: object propertyNames: type: string additionalProperties: type: string minLength: 1 required: type: boolean format: type: string placeholder: type: string renderHint: enum: - textarea type: string required: - label - name - type additionalProperties: false outputGroups: type: array items: type: object properties: name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]*$ maxItems: type: integer minimum: 1 maximum: 20 required: - name - maxItems default: [] required: - mode - outputColumns - type: object properties: includeFullRow: type: boolean default: false model: enum: - gpt-5-nano - gemini-2.5-flash-lite - gpt-5.4-nano - gpt-5-mini - gemini-2.5-flash - deepseek-v4-flash - deepseek-v4-pro - hy3-preview type: string default: gpt-5-nano mode: const: transform targetColumn: type: string minLength: 1 prompt: type: string minLength: 1 required: - mode - targetColumn - prompt required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: ocr.extract data: type: object properties: sourceFileColumn: type: string minLength: 1 outputColumns: type: array minItems: 1 items: type: object properties: label: type: string minLength: 1 name: type: string minLength: 1 pattern: >- ^[A-Za-z_][A-Za-z0-9_]*(?:\.(?:[A-Za-z_][A-Za-z0-9_]*|\d+))*$ type: enum: - string - number - boolean - date - timestamp - enum type: string isArray: type: boolean default: false description: type: string enumValues: type: array items: type: string minLength: 1 enumLabels: type: object propertyNames: type: string additionalProperties: type: string minLength: 1 required: type: boolean format: type: string placeholder: type: string renderHint: enum: - textarea type: string required: - label - name - type additionalProperties: false outputGroups: type: array items: type: object properties: name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]*$ maxItems: type: integer minimum: 1 maximum: 20 required: - name - maxItems default: [] prompt: type: string model: enum: - claude-sonnet-4.6 - gpt-5-mini - gpt-5.4-nano - gemini-2.5-flash - gpt-5-nano type: string default: claude-sonnet-4.6 required: - sourceFileColumn - outputColumns required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: detect.transaction_volume_anomaly data: type: object properties: metric: enum: - transaction_count - total_amount - average_amount - largest_amount - smallest_amount type: string description: Metric comparisonPreset: enum: - month_over_month - week_over_week - quarter_over_quarter - custom type: string default: month_over_month description: Comparison currentPeriod: type: object properties: field: type: string default: createdAt description: Field anchor: type: string default: '{{execution.timestamp}}' description: Anchor before: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: Before after: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: After description: Current Period priorPeriod: type: object properties: field: type: string default: createdAt description: Field anchor: type: string default: '{{execution.timestamp}}' description: Anchor before: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: Before after: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: After description: Prior Period direction: enum: - spike - drop type: string default: spike description: Direction thresholdPct: type: number exclusiveMinimum: 0 description: Threshold (%) missingPriorBehavior: enum: - drop - infinity type: string default: drop description: Missing Prior Behavior required: - metric - thresholdPct required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: detect.transaction_outlier data: type: object properties: baselineStatistic: enum: - max - average - p95 type: string default: max description: Baseline statistic direction: enum: - above - below type: string default: above description: Direction thresholdPct: type: number exclusiveMinimum: 0 description: Threshold percent required: - thresholdPct required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: detect.structuring data: type: object properties: reportingThreshold: anyOf: - type: number exclusiveMinimum: 0 - type: string pattern: ^\{\{[a-zA-Z_][a-zA-Z0-9_.]*\}\}$ description: Reporting threshold proximityPct: type: number maximum: 100 exclusiveMinimum: 0 description: Proximity percent timeBucketDays: type: integer minimum: -9007199254740991 maximum: 365 exclusiveMinimum: 0 description: Time window (days) minTxInBucket: type: integer minimum: 2 maximum: 9007199254740991 description: Minimum transactions in cluster minAggregateAmount: type: number exclusiveMinimum: 0 description: Minimum total amount in cluster required: - reportingThreshold - proximityPct - minTxInBucket required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: detect.dormant_account data: type: object properties: mode: enum: - inactive - reactivated type: string default: reactivated description: Mode inactivityPeriod: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: Inactivity period reactivationWindow: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: Reactivation window minLifetimeTransactions: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Minimum lifetime transactions required: - inactivityPeriod required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: combine.merge data: type: object properties: mode: enum: - union - inner_join - left_join type: string default: union joinKey: type: object properties: left: type: string minLength: 1 right: type: string minLength: 1 mode: enum: - strict - insensitive - fuzzy - exact type: string description: >- Match strictness; defaults to 'insensitive' at runtime. semantic: enum: - any - subset - superset - equal type: string description: >- Set-level quantifier for array join keys; defaults to 'any' at runtime. required: - left - right required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: combine.lookup data: type: object properties: matchField: type: string minLength: 1 mode: enum: - strict - insensitive - fuzzy - exact type: string description: >- Match strictness; defaults to 'insensitive' at runtime. semantic: enum: - any - subset - superset - equal type: string description: >- Set-level quantifier for array match fields; defaults to 'any' at runtime. required: - matchField required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: condition.filter data: type: object properties: condition: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: anyOf: - {} - {} - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: anyOf: - type: object properties: type: {} field: {} operator: {} value: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} condition: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: anyOf: - type: object properties: type: {} field: {} operator: {} value: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} condition: {} required: - type - conditions - type: object properties: type: const: not condition: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: not condition: {} required: - type required: - type - condition required: - condition required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: condition.if data: type: object properties: condition: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: anyOf: - {} - {} - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: anyOf: - type: object properties: type: {} field: {} operator: {} value: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} condition: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: anyOf: - type: object properties: type: {} field: {} operator: {} value: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} conditions: {} - type: object properties: type: {} condition: {} required: - type - conditions - type: object properties: type: const: not condition: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: not condition: {} required: - type required: - type - condition mode: enum: - per_row - any - all type: string default: per_row required: - condition required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: condition.threshold data: type: object properties: field: type: string minLength: 1 value: anyOf: - type: number - type: string required: - field - value required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: condition.time_window data: type: object properties: field: type: string default: createdAt description: Field anchor: type: string default: '{{execution.timestamp}}' description: Anchor before: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: Before after: type: array minItems: 1 items: type: object properties: value: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 description: Value unit: enum: - minutes - hours - days - weeks - months - years type: string description: Unit required: - value - unit description: After required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: action.create_alert data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string name: type: string description: type: string alertScopeData: type: object propertyNames: type: string additionalProperties: type: string itemScopeData: type: object propertyNames: type: string additionalProperties: type: string groupingKey: type: string rebuildOnRerun: type: boolean generateReport: type: boolean allowEmpty: type: boolean reportDefaults: type: object properties: scopeData: type: object properties: MX: type: object properties: actividadVulnerable: type: object properties: rfc: type: string description: RFC collegiateEntityCode: type: string minLength: 12 maxLength: 13 description: Collegiate Entity Code exempt: type: boolean default: false description: Exempt priority: enum: - '1' - '2' type: string description: Priority default: '1' alertDescription: type: string ARI: type: object properties: alertType: {} operationType: {} propertyType: {} paymentForm: {} monetaryInstrument: {} currency: {} AVI: type: object properties: platformDomain: {} alertType: {} monetaryInstrument: {} INM: type: object properties: alertType: {} operationType: {} propertyType: {} paymentForm: {} monetaryInstrument: {} currency: {} JYS: type: object properties: alertType: {} operationType: {} businessLine: {} operationMethod: {} monetaryInstrument: {} currency: {} assetType: {} realEstateType: {} MJR: type: object properties: alertType: {} operationType: {} goodType: {} unit: {} paymentForm: {} monetaryInstrument: {} currency: {} MPC: type: object properties: alertType: {} operationType: {} monetaryInstrument: {} currency: {} TSC: type: object properties: alertType: {} operationType: {} cardType: {} VEH: type: object properties: alertType: {} operationType: {} paymentForm: {} monetaryInstrument: {} currency: {} required: - rfc cnbv: type: object properties: organoSupervisor: type: string pattern: ^\d{2}-\d{3}$ description: Supervisory Body claveSujetoObligado: type: string pattern: ^\d{2}-(\d{3}|\d{5})$ description: Clave Sujeto Obligado TRANSMISOR: type: object properties: organoSupervisor: {} claveSujetoObligado: {} tipoOperacion: {} instrumentoMonetario: {} localidad: {} sucursal: {} agenteNombre: {} agenteApellidoPaterno: {} agenteApellidoMaterno: {} agenteRfc: {} agenteCurp: {} reportSplit: type: object properties: strategy: enum: - minimize - by_client type: string default: minimize maxFileSizeBytes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 tagIds: type: array items: type: string format: uuid required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: action.create_client_alert data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string name: type: string description: type: string alertScopeData: type: object propertyNames: type: string additionalProperties: type: string itemScopeData: type: object propertyNames: type: string additionalProperties: type: string groupingKey: type: string generateReport: type: boolean reportDefaults: type: object properties: scopeData: type: object properties: MX: type: object properties: actividadVulnerable: type: object properties: rfc: type: string description: RFC collegiateEntityCode: type: string minLength: 12 maxLength: 13 description: Collegiate Entity Code exempt: type: boolean default: false description: Exempt priority: enum: - '1' - '2' type: string description: Priority default: '1' alertDescription: type: string ARI: type: object properties: alertType: {} operationType: {} propertyType: {} paymentForm: {} monetaryInstrument: {} currency: {} AVI: type: object properties: platformDomain: {} alertType: {} monetaryInstrument: {} INM: type: object properties: alertType: {} operationType: {} propertyType: {} paymentForm: {} monetaryInstrument: {} currency: {} JYS: type: object properties: alertType: {} operationType: {} businessLine: {} operationMethod: {} monetaryInstrument: {} currency: {} assetType: {} realEstateType: {} MJR: type: object properties: alertType: {} operationType: {} goodType: {} unit: {} paymentForm: {} monetaryInstrument: {} currency: {} MPC: type: object properties: alertType: {} operationType: {} monetaryInstrument: {} currency: {} TSC: type: object properties: alertType: {} operationType: {} cardType: {} VEH: type: object properties: alertType: {} operationType: {} paymentForm: {} monetaryInstrument: {} currency: {} required: - rfc cnbv: type: object properties: organoSupervisor: type: string pattern: ^\d{2}-\d{3}$ description: Supervisory Body claveSujetoObligado: type: string pattern: ^\d{2}-(\d{3}|\d{5})$ description: Clave Sujeto Obligado TRANSMISOR: type: object properties: organoSupervisor: {} claveSujetoObligado: {} tipoOperacion: {} instrumentoMonetario: {} localidad: {} sucursal: {} agenteNombre: {} agenteApellidoPaterno: {} agenteApellidoMaterno: {} agenteRfc: {} agenteCurp: {} reportSplit: type: object properties: strategy: enum: - minimize - by_client type: string default: minimize maxFileSizeBytes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 tagIds: type: array items: type: string format: uuid required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: action.upsert_client data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string mappings: type: object propertyNames: type: string additionalProperties: anyOf: - type: object properties: kind: const: column path: type: string minLength: 1 required: - kind - path - type: object properties: kind: const: constant value: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - kind - value - type: object properties: kind: const: unset required: - kind - type: object properties: kind: const: indexedColumns pattern: type: string pattern: ^[^*]*\*[^*]*$ required: - kind - pattern - type: object properties: kind: const: columns paths: type: array minItems: 1 items: type: string minLength: 1 required: - kind - paths default: {} errorMode: enum: - partial - atomic type: string default: partial conflictMode: enum: - update - skip type: string default: update defaultCountry: type: string required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: action.upsert_transaction data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string mappings: type: object propertyNames: type: string additionalProperties: anyOf: - type: object properties: kind: const: column path: type: string minLength: 1 required: - kind - path - type: object properties: kind: const: constant value: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - kind - value - type: object properties: kind: const: unset required: - kind - type: object properties: kind: const: indexedColumns pattern: type: string pattern: ^[^*]*\*[^*]*$ required: - kind - pattern - type: object properties: kind: const: columns paths: type: array minItems: 1 items: type: string minLength: 1 required: - kind - paths default: {} errorMode: enum: - partial - atomic type: string default: partial conflictMode: enum: - update - skip type: string default: update defaultCountry: type: string required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: action.upsert_email data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string mappings: type: object propertyNames: type: string additionalProperties: anyOf: - type: object properties: kind: const: column path: type: string minLength: 1 required: - kind - path - type: object properties: kind: const: constant value: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - kind - value - type: object properties: kind: const: unset required: - kind - type: object properties: kind: const: indexedColumns pattern: type: string pattern: ^[^*]*\*[^*]*$ required: - kind - pattern - type: object properties: kind: const: columns paths: type: array minItems: 1 items: type: string minLength: 1 required: - kind - paths default: {} errorMode: enum: - partial - atomic type: string default: partial conflictMode: enum: - update - skip type: string default: update defaultCountry: type: string required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: action.upsert_phone data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string mappings: type: object propertyNames: type: string additionalProperties: anyOf: - type: object properties: kind: const: column path: type: string minLength: 1 required: - kind - path - type: object properties: kind: const: constant value: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - kind - value - type: object properties: kind: const: unset required: - kind - type: object properties: kind: const: indexedColumns pattern: type: string pattern: ^[^*]*\*[^*]*$ required: - kind - pattern - type: object properties: kind: const: columns paths: type: array minItems: 1 items: type: string minLength: 1 required: - kind - paths default: {} errorMode: enum: - partial - atomic type: string default: partial conflictMode: enum: - update - skip type: string default: update defaultCountry: type: string required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: action.upsert_address data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string mappings: type: object propertyNames: type: string additionalProperties: anyOf: - type: object properties: kind: const: column path: type: string minLength: 1 required: - kind - path - type: object properties: kind: const: constant value: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - kind - value - type: object properties: kind: const: unset required: - kind - type: object properties: kind: const: indexedColumns pattern: type: string pattern: ^[^*]*\*[^*]*$ required: - kind - pattern - type: object properties: kind: const: columns paths: type: array minItems: 1 items: type: string minLength: 1 required: - kind - paths default: {} errorMode: enum: - partial - atomic type: string default: partial conflictMode: enum: - update - skip type: string default: update defaultCountry: type: string required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: action.upsert_bank_account data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string mappings: type: object propertyNames: type: string additionalProperties: anyOf: - type: object properties: kind: const: column path: type: string minLength: 1 required: - kind - path - type: object properties: kind: const: constant value: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - kind - value - type: object properties: kind: const: unset required: - kind - type: object properties: kind: const: indexedColumns pattern: type: string pattern: ^[^*]*\*[^*]*$ required: - kind - pattern - type: object properties: kind: const: columns paths: type: array minItems: 1 items: type: string minLength: 1 required: - kind - paths default: {} errorMode: enum: - partial - atomic type: string default: partial conflictMode: enum: - update - skip type: string default: update defaultCountry: type: string required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: action.upsert_legal_representative data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string mappings: type: object propertyNames: type: string additionalProperties: anyOf: - type: object properties: kind: const: column path: type: string minLength: 1 required: - kind - path - type: object properties: kind: const: constant value: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - kind - value - type: object properties: kind: const: unset required: - kind - type: object properties: kind: const: indexedColumns pattern: type: string pattern: ^[^*]*\*[^*]*$ required: - kind - pattern - type: object properties: kind: const: columns paths: type: array minItems: 1 items: type: string minLength: 1 required: - kind - paths default: {} errorMode: enum: - partial - atomic type: string default: partial conflictMode: enum: - update - skip type: string default: update defaultCountry: type: string required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: action.upsert_controlling_beneficiary data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string mappings: type: object propertyNames: type: string additionalProperties: anyOf: - type: object properties: kind: const: column path: type: string minLength: 1 required: - kind - path - type: object properties: kind: const: constant value: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - kind - value - type: object properties: kind: const: unset required: - kind - type: object properties: kind: const: indexedColumns pattern: type: string pattern: ^[^*]*\*[^*]*$ required: - kind - pattern - type: object properties: kind: const: columns paths: type: array minItems: 1 items: type: string minLength: 1 required: - kind - paths default: {} errorMode: enum: - partial - atomic type: string default: partial conflictMode: enum: - update - skip type: string default: update defaultCountry: type: string required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: source.get_reference_data data: type: object properties: dataset: type: string minLength: 1 asOf: type: string format: date-time required: - dataset required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: source.get_custom_reference_data data: type: object properties: sourceId: type: string format: uuid asOf: type: string format: date-time required: - sourceId required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: risk.calculate_pillar_by_reference data: type: object properties: pillarName: type: string minLength: 1 matchColumns: type: array minItems: 1 items: type: object properties: sourceField: type: string minLength: 1 referenceField: type: string minLength: 1 matchType: enum: - strict - insensitive - fuzzy - exact type: string description: >- Match strictness: 'strict' (byte equality), 'insensitive' (case+accent+whitespace insensitive), 'fuzzy' (jaro-winkler similarity). 'exact' is a deprecated alias for 'strict'. default: insensitive semantic: enum: - any - subset - superset - equal type: string description: >- Set-level quantifier for array columns; defaults to 'any' at runtime. required: - sourceField - referenceField scoreField: type: string minLength: 1 scoreMapping: type: object propertyNames: type: string additionalProperties: type: number defaultScore: type: number minimum: 0 similarityFloor: type: number minimum: 0 maximum: 1 min: type: number max: type: number clampFloor: type: number clampCeiling: type: number required: - pillarName - matchColumns - scoreField required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: risk.calculate_pillar_by_expression data: type: object properties: pillarName: type: string minLength: 1 expression: type: string minLength: 1 min: type: number max: type: number clampFloor: type: number clampCeiling: type: number required: - pillarName - expression required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: risk.calculate_pillar_by_condition data: type: object properties: pillarName: type: string minLength: 1 branches: type: array minItems: 1 items: type: object properties: when: anyOf: - type: object properties: type: const: field description: Type field: type: string minLength: 1 description: Field operator: enum: - eq - neq - gt - gte - lt - lte - in - nin - contains - startsWith - endsWith - exists - notExists - arrayContains - arrayNotContains - arrayEmpty - arrayNotEmpty type: string description: Operator value: anyOf: - {} - {} description: Value required: - type - field - operator - type: object properties: type: const: and conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: or conditions: type: array minItems: 1 items: {} required: - type - conditions - type: object properties: type: const: not condition: anyOf: - {} - {} - {} - {} required: - type then: type: number required: - when - then else: type: number default: 0 min: type: number max: type: number clampFloor: type: number clampCeiling: type: number required: - pillarName - branches required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: risk.save_client_assessment data: type: object properties: assessmentName: type: string minLength: 1 default: Risk weights: type: object propertyNames: type: string additionalProperties: type: number minimum: 0 maximum: 1 roundingMode: enum: - ceil - floor - round type: string default: ceil decimalPlaces: type: integer minimum: 0 maximum: 2 default: 0 minScore: type: number minimum: 0 default: 0 maxScore: type: number minimum: 0 default: 100 riskLevels: type: array items: type: object properties: maxValue: type: number label: type: string minLength: 1 required: - maxValue - label required: - weights required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: risk.save_transaction_assessment data: type: object properties: assessmentName: type: string minLength: 1 default: Risk weights: type: object propertyNames: type: string additionalProperties: type: number minimum: 0 maximum: 1 roundingMode: enum: - ceil - floor - round type: string default: ceil decimalPlaces: type: integer minimum: 0 maximum: 2 default: 0 minScore: type: number minimum: 0 default: 0 maxScore: type: number minimum: 0 default: 100 riskLevels: type: array items: type: object properties: maxValue: type: number label: type: string minLength: 1 required: - maxValue - label required: - weights required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: trigger.form_link data: type: object properties: timeout: enum: - 1h - 6h - 24h - 72h - 7d - 14d - 30d type: string default: 72h branding: type: object properties: logo: anyOf: - type: string - type: 'null' primaryColor: anyOf: - type: string pattern: >- ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ - type: 'null' backgroundColor: anyOf: - type: string pattern: >- ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ - type: 'null' fontColor: anyOf: - type: string pattern: >- ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ - type: 'null' fontFamily: anyOf: - enum: - Satoshi - Inter - Geist - Plus Jakarta Sans - DM Sans - Manrope - Work Sans - Poppins - Space Grotesk - Fraunces - Playfair Display - Source Serif 4 type: string - type: 'null' required: - logo - primaryColor - backgroundColor - fontColor - fontFamily messages: type: object properties: welcome: type: object properties: title: anyOf: - type: string - type: 'null' description: anyOf: - type: string - type: 'null' required: - title - description success: type: object properties: title: anyOf: - type: string - type: 'null' description: anyOf: - type: string - type: 'null' required: - title - description required: - welcome - success required: - branding - messages required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.otp_verification data: type: object properties: title: type: string description: type: string required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.choice data: type: object properties: question: type: string minLength: 1 description: type: string key: type: string pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ options: type: array minItems: 2 items: type: object properties: id: type: string format: uuid label: type: string minLength: 1 value: type: string minLength: 1 required: - id - label - value required: - question - key - options required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.user_input data: type: object properties: title: type: string description: type: string fields: type: array minItems: 1 items: type: object properties: label: type: string minLength: 1 name: type: string minLength: 1 pattern: >- ^[A-Za-z_][A-Za-z0-9_]*(?:\.(?:[A-Za-z_][A-Za-z0-9_]*|\d+))*$ type: enum: - string - number - boolean - date - timestamp - enum type: string isArray: type: boolean default: false description: type: string enumValues: type: array items: type: string minLength: 1 enumLabels: type: object propertyNames: type: string additionalProperties: type: string minLength: 1 required: type: boolean format: type: string placeholder: type: string renderHint: enum: - textarea type: string required: - label - name - type additionalProperties: false fieldGroups: type: array items: type: object properties: name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]*$ maxItems: type: integer minimum: 1 maximum: 20 required: - name - maxItems default: [] required: - fields required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.file_input data: type: object properties: title: type: string description: type: string fields: type: array minItems: 1 items: type: object properties: label: type: string minLength: 1 name: type: string minLength: 1 pattern: >- ^[A-Za-z_][A-Za-z0-9_]*(?:\.(?:[A-Za-z_][A-Za-z0-9_]*|\d+))*$ required: type: boolean acceptedContentTypes: type: array items: type: string minLength: 1 maxSizeBytes: type: integer minimum: -9007199254740991 maximum: 26214400 exclusiveMinimum: 0 required: - label - name additionalProperties: false required: - fields required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.sign_document data: type: object properties: signableTemplateId: type: string format: uuid mandatory: type: boolean default: true title: type: string description: type: string required: - signableTemplateId required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.upsert_client data: type: object properties: scopes: type: array minItems: 1 items: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string description: type: string conflictMode: enum: - update - skip type: string default: update required: - scopes required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.upsert_address data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string count: type: integer minimum: 1 maximum: 10 default: 1 description: type: string conflictMode: enum: - update - skip type: string default: update required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.upsert_phone data: type: object properties: count: type: integer minimum: 1 maximum: 10 default: 1 description: type: string conflictMode: enum: - update - skip type: string default: update required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.upsert_email data: type: object properties: count: type: integer minimum: 1 maximum: 10 default: 1 description: type: string conflictMode: enum: - update - skip type: string default: update required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.upsert_bank_account data: type: object properties: scope: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string count: type: integer minimum: 1 maximum: 10 default: 1 description: type: string conflictMode: enum: - update - skip type: string default: update required: - scope required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: form.upsert_legal_representative data: type: object properties: scopes: type: array minItems: 1 items: enum: - base - MX:AV - MX:AV:ARI - MX:AV:AVI - MX:AV:INM - MX:AV:JYS - MX:AV:MJR - MX:AV:MPC - MX:AV:TSC - MX:AV:VEH - MX:CNBV - MX:CNBV:TRANSMISOR - MX type: string count: type: integer minimum: 1 maximum: 10 default: 1 description: type: string conflictMode: enum: - update - skip type: string default: update required: - scopes required: - id - type - data - type: object properties: id: type: string minLength: 1 type: const: trigger.workflow_completion data: type: object properties: timeout: enum: - 1h - 6h - 24h - 72h - 7d - 14d - 30d type: string default: 72h sourceWorkflowId: type: string format: uuid description: Source workflow ID triggerOn: type: array minItems: 1 items: enum: - completed - errored - timed_out - cancelled - abandoned type: string description: Trigger on statuses default: - completed required: - id - type - data default: [] edges: type: array items: type: object properties: id: type: string minLength: 1 source: type: string minLength: 1 target: type: string minLength: 1 sourceHandle: type: string targetHandle: type: string shape: enum: - table - object type: string required: - id - source - target default: [] description: Workflow metadata: type: object propertyNames: type: string additionalProperties: {} description: Metadata required: - name - status - workflow responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string format: uuid organizationId: type: string environment: enum: - test - live type: string name: type: string description: type: string externalId: type: string status: enum: - draft - active - inactive type: string workflow: type: object properties: nodes: type: array items: type: object properties: id: type: string minLength: 1 type: enum: - trigger.event - trigger.schedule - trigger.manual - trigger.manual_file - trigger.form_link - trigger.api - trigger.workflow_completion - source.query_transactions - source.query_clients - enrich.add_address - enrich.add_phone - enrich.add_email - enrich.add_legal_representative - enrich.add_controlling_beneficiary - enrich.add_document - enrich.add_evidence - enrich.add_transaction - enrich.add_bank_account - enrich.add_client - enrich.add_exchange_rate - transform.aggregate - transform.time_bucket - transform.window - transform.set_column - transform.python - detect.transaction_volume_anomaly - detect.transaction_outlier - detect.structuring - detect.dormant_account - combine.merge - combine.lookup - condition.filter - condition.if - condition.threshold - condition.time_window - action.create_alert - action.create_client_alert - action.upsert_client - action.upsert_transaction - action.upsert_email - action.upsert_phone - action.upsert_address - action.upsert_bank_account - action.upsert_legal_representative - action.upsert_controlling_beneficiary - ai.step - ocr.extract - form.otp_verification - form.choice - form.user_input - form.file_input - form.sign_document - form.upsert_client - form.upsert_address - form.upsert_phone - form.upsert_email - form.upsert_bank_account - form.upsert_legal_representative - source.get_reference_data - source.get_custom_reference_data - risk.calculate_pillar_by_reference - risk.calculate_pillar_by_expression - risk.calculate_pillar_by_condition - risk.save_client_assessment - risk.save_transaction_assessment type: string data: type: object propertyNames: type: string additionalProperties: {} default: {} required: - id - type default: [] edges: type: array items: type: object properties: id: type: string minLength: 1 source: type: string minLength: 1 target: type: string minLength: 1 sourceHandle: type: string targetHandle: type: string shape: enum: - table - object type: string required: - id - source - target default: [] metadata: type: object propertyNames: type: string additionalProperties: {} liveWorkflowId: anyOf: - type: string format: uuid - type: 'null' testWorkflowId: anyOf: - type: string format: uuid - type: 'null' promotedAt: anyOf: - type: string - type: 'null' createdAt: type: string updatedAt: type: string tags: type: array items: type: object properties: id: type: string format: uuid name: type: string color: anyOf: - type: string - type: 'null' required: - id - name - color required: - id - organizationId - environment - name - status - workflow - createdAt - updatedAt components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: API key authentication. Obtain your API key from the dashboard. environmentHeader: type: apiKey in: header name: X-Environment description: Target environment for the request. Must be "test" or "live". ````