Visão Geral
Esta referência lista todos os campos disponíveis que podem ser usados em condições de regras. Os campos estão organizados por tipo de entidade (Pessoa, Empresa, Transação, KYC) e país (BR, AR, Global).Esta documentação é gerada automaticamente a partir do código base. Última atualização: 2025-12-23
Como Usar Esta Referência
- Encontre seu tipo de entidade: Person, Company, Transaction, or KYC
- Verifique campos específicos do país: BR (Brazil), AR (Argentina), or GLOBAL
- Copie o caminho do campo: Use o caminho exato do campo em suas condições de regra
- Escolha um operador: Veja a seção Operadores Disponíveis
- Defina o valor: Forneça o valor para comparar
Navegação Rápida
- Campos de Pessoa
- Campos de Empresa
- Campos de Transação
- Campos de KYC
- Campos de Accionistas
- Operadores Disponíveis
- Exemplos de Uso
Campos de Pessoa
Campos disponibles para evaluar entidades de persona (clientes individuales).BR - Country-Specific Fields
AR - Country-Specific Fields
Global Fields
Estruturas de Campos Aninhados
Alguns campos contêm estruturas aninhadas (arrays ou objetos) com múltiplos subcampos:enrichmentData.normalized.documentsSummary - Resumo de Documentos
Tipo: Object
Descrição: Estatísticas agregadas sobre documentos
Subcampos Disponíveis:
enrichmentData.normalized.documents - Documentos
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os documentos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.addressesSummary - Resumo de Endereços
Tipo: Object
Descrição: Estatísticas agregadas sobre endereços
Subcampos Disponíveis:
enrichmentData.normalized.addresses - Endereços
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os endereços
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.emailsSummary - Resumo de E-mails
Tipo: Object
Descrição: Estatísticas agregadas sobre e-mails
Subcampos Disponíveis:
enrichmentData.normalized.emails - E-mails
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os e-mails
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.phonesSummary - Resumo de Telefones
Tipo: Object
Descrição: Estatísticas agregadas sobre telefones
Subcampos Disponíveis:
enrichmentData.normalized.phones - Telefones
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os telefones
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.sanctionsSummary - Resumo de Sanções
Tipo: Object
Descrição: Estatísticas agregadas sobre sanções
Subcampos Disponíveis:
enrichmentData.normalized.legalProceedingsSummary - Resumo de Processos Legais
Tipo: Object
Descrição: Estatísticas agregadas sobre processos legais
Subcampos Disponíveis:
enrichmentData.normalized.legalProceedings - Processos Judiciais
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os processos judiciais
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.riskFlags - Bandeiras de Risco
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas as bandeiras de risco
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.riskFlagsSummary - Resumo de Bandeiras de Risco
Tipo: Object
Descrição: Estatísticas agregadas sobre bandeiras de risco
Subcampos Disponíveis:
enrichmentData.normalized.violations - Violações Consolidadas
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas as violações consolidadas (ESG + crimes)
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.violationsSummary - Resumo de Violações
Tipo: Object
Descrição: Estatísticas agregadas sobre violações
Subcampos Disponíveis:
enrichmentData.normalized.mediaMentions - Menções em Mídia
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas as menções em mídia consolidadas
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.mediaSummary - Resumo de Mídia
Tipo: Object
Descrição: Estatísticas agregadas sobre menções na mídia
Subcampos Disponíveis:
enrichmentData.normalized.sanctions - Sanções Consolidadas
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas as sanções consolidadas
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.demographics - Demografia
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os dados demográficos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.demographicsSummary - Resumo Demográfico
Tipo: Object
Descrição: Estatísticas agregadas sobre dados demográficos
Subcampos Disponíveis:
enrichmentData.normalized.occupations - Ocupações
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os dados de ocupação
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.occupationsSummary - Resumo de Ocupações
Tipo: Object
Descrição: Estatísticas agregadas sobre ocupações profissionais
Subcampos Disponíveis:
enrichmentData.normalized.electoralActivitySummary - Resumo de Atividade Eleitoral
Tipo: Object
Descrição: Estatísticas agregadas sobre doações eleitorais
Subcampos Disponíveis:
enrichmentData.normalized.electoralActivity - Doações Eleitorais por Ano
Tipo: Array of objects
Descrição: Buscar doações eleitorais específicas por ano
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.taxReturnsSummary - Resumo de Declarações de IR
Tipo: Object
Descrição: Estatísticas agregadas sobre declarações de imposto de renda
Subcampos Disponíveis:
enrichmentData.normalized.taxReturns - Declarações de Imposto
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas as declarações de imposto
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.relationships - Relacionamentos
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os relacionamentos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.relationshipsSummary - Resumo de Relacionamentos
Tipo: Object
Descrição: Estatísticas agregadas sobre relacionamentos
Subcampos Disponíveis:
enrichmentData.normalized.aliases - Nomes Alternativos
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os nomes alternativos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
kyc.biometricResult - Resultado Biométrico
Tipo: Object
Descrição: Resultados de face match e liveness (KYC provider)
Subcampos Disponíveis:
kyc.documentsVerified - Documentos Verificados
Tipo: Array of objects
Descrição: Lista de documentos verificados no KYC
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
kyc.riskAssessment - Avaliação de Risco KYC
Tipo: Object
Descrição: Avaliação de risco realizada pelo KYC
Subcampos Disponíveis:
kyc.extractedData - Dados Extraídos do Documento
Tipo: Object
Descrição: Dados extraídos do documento de identidade
Subcampos Disponíveis:
enrichmentData.normalized.documents - Documentos
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los documentos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.riskFlags - Banderas de Riesgo
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas las banderas de riesgo
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.demographics - Demografía
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los datos demográficos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.occupations - Ocupaciones
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los datos de ocupación
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.addresses - Direcciones
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas las direcciones
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.aliases - Alias/Nombres Alternativos
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los nombres alternativos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.aliasesSummary - Resumen de Aliases
Tipo: Object
Descrição: Estadísticas agregadas sobre nombres alternativos
Subcampos Disponíveis:
enrichmentData.normalized.emails - Emails
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los emails
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.phones - Teléfonos
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los teléfonos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.sanctions - Sanciones Consolidadas
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas las sanciones consolidadas
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.sanctionsSummary - Resumen de Sanciones
Tipo: Object
Descrição: Estadísticas agregadas sobre listas de sanciones
Subcampos Disponíveis:
enrichmentData.normalized.legalProceedings - Procesos Judiciales
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los procesos judiciales
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
kyc.biometricResult - Resultado Biométrico
Tipo: Object
Descrição: Resultados de face match e liveness (KYC provider)
Subcampos Disponíveis:
kyc.documentsVerified - Documentos Verificados
Tipo: Array of objects
Descrição: Lista de documentos verificados no KYC
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
kyc.riskAssessment - Avaliação de Risco KYC
Tipo: Object
Descrição: Avaliação de risco realizada pelo KYC
Subcampos Disponíveis:
kyc.extractedData - Dados Extraídos do Documento
Tipo: Object
Descrição: Dados extraídos do documento de identidade
Subcampos Disponíveis:
enrichmentData.normalized.riskFlags - Banderas de Riesgo
Tipo: Array of objects
Descrição: Banderas de riesgo consolidadas (PEP, Sanciones). Solo se consolidan automáticamente si hay 1 hit relevante.
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.sanctions - Sanciones
Tipo: Array of objects
Descrição: Listas de sanciones donde aparece la persona
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.mediaMentions - Menciones en Medios
Tipo: Array of objects
Descrição: Menciones en medios adversos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.demographics - Demografía
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los datos demográficos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.occupations - Ocupaciones
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los datos de ocupación
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
kyc.biometricResult - Resultado Biométrico
Tipo: Object
Descrição: Resultados de face match e liveness (KYC provider)
Subcampos Disponíveis:
kyc.documentsVerified - Documentos Verificados
Tipo: Array of objects
Descrição: Lista de documentos verificados no KYC
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
kyc.riskAssessment - Avaliação de Risco KYC
Tipo: Object
Descrição: Avaliação de risco realizada pelo KYC
Subcampos Disponíveis:
kyc.extractedData - Dados Extraídos do Documento
Tipo: Object
Descrição: Dados extraídos do documento de identidade
Subcampos Disponíveis:
Campos de Empresa
Campos disponibles para evaluar entidades de empresa (negocios).BR - Country-Specific Fields
AR - Country-Specific Fields
Global Fields
Estruturas de Campos Aninhados
Alguns campos contêm estruturas aninhadas (arrays ou objetos) com múltiplos subcampos:enrichmentData.normalized.documents - Documentos
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os documentos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.documentsSummary - Resumo de Documentos
Tipo: Object
Descrição: Campos agregados sobre documentos
Subcampos Disponíveis:
enrichmentData.normalized.aliases - Nomes Alternativos
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os nomes alternativos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.aliasesSummary - Resumo de Aliases
Tipo: Object
Descrição: Estatísticas agregadas sobre nomes alternativos
Subcampos Disponíveis:
enrichmentData.normalized.cnaes - CNAEs (Atividades Econômicas)
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas as atividades econômicas
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.cnaesSummary - Resumo de CNAEs
Tipo: Object
Descrição: Estatísticas agregadas sobre atividades econômicas
Subcampos Disponíveis:
enrichmentData.normalized.addresses - Endereços
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os endereços
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.addressesSummary - Resumo de Endereços
Tipo: Object
Descrição: Estatísticas agregadas sobre endereços
Subcampos Disponíveis:
enrichmentData.normalized.emails - E-mails
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os e-mails
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.emailsSummary - Resumo de E-mails
Tipo: Object
Descrição: Estatísticas agregadas sobre e-mails
Subcampos Disponíveis:
enrichmentData.normalized.phones - Telefones
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os telefones
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.phonesSummary - Resumo de Telefones
Tipo: Object
Descrição: Estatísticas agregadas sobre telefones
Subcampos Disponíveis:
enrichmentData.normalized.legalProceedings - Processos Judiciais
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os processos judiciais
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.legalProceedingsSummary - Resumo de Processos Judiciais
Tipo: Object
Descrição: Estatísticas agregadas sobre processos judiciais
Subcampos Disponíveis:
enrichmentData.normalized.riskFlags - Bandeiras de Risco
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas as bandeiras de risco
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.riskFlagsSummary - Resumo de Bandeiras de Risco
Tipo: Object
Descrição: Estatísticas agregadas sobre bandeiras de risco
Subcampos Disponíveis:
enrichmentData.normalized.sanctionsSummary - Resumo de Sanções
Tipo: Object
Descrição: Estatísticas agregadas sobre listas de sanções
Subcampos Disponíveis:
enrichmentData.normalized.shareholdersSummary - Resumo de Sócios/Acionistas
Tipo: Object
Descrição: Estatísticas agregadas sobre estrutura societária
Subcampos Disponíveis:
enrichmentData.normalized.shareholders - Sócios/Acionistas Consolidados
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos os sócios consolidados (QSA + outras fontes)
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.violations - Violações Consolidadas
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas as violações consolidadas (ESG + crimes)
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.violationsSummary - Resumo de Violações
Tipo: Object
Descrição: Estatísticas agregadas sobre violações
Subcampos Disponíveis:
enrichmentData.normalized.mediaMentions - Menções em Mídia
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas as menções em mídia consolidadas
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.mediaSummary - Resumo de Mídia
Tipo: Object
Descrição: Estatísticas agregadas sobre menções na mídia
Subcampos Disponíveis:
enrichmentData.normalized.sanctions - Sanções Consolidadas
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas as sanções consolidadas
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.riskFlags - Banderas de Riesgo
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas las banderas de riesgo
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.sanctions - Sanciones Consolidadas
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas las sanciones consolidadas
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.sanctionsSummary - Resumen de Sanciones
Tipo: Object
Descrição: Estadísticas agregadas sobre listas de sanciones
Subcampos Disponíveis:
enrichmentData.normalized.occupations - Actividades/Ocupaciones
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas las actividades económicas
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.occupationsSummary - Resumen de Actividades
Tipo: Object
Descrição: Estadísticas agregadas sobre actividades económicas
Subcampos Disponíveis:
enrichmentData.normalized.aliases - Alias/Nombres Alternativos
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los nombres alternativos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.aliasesSummary - Resumen de Aliases
Tipo: Object
Descrição: Estadísticas agregadas sobre nombres alternativos
Subcampos Disponíveis:
enrichmentData.normalized.documents - Documentos
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todos los documentos
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.documentsSummary - Resumen de Documentos
Tipo: Object
Descrição: Estadísticas agregadas sobre documentos
Subcampos Disponíveis:
enrichmentData.normalized.addresses - Direcciones
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas las direcciones
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
enrichmentData.normalized.addressesSummary - Resumen de Direcciones
Tipo: Object
Descrição: Estadísticas agregadas sobre direcciones
Subcampos Disponíveis:
enrichmentData.normalized.riskFlags - Banderas de Riesgo
Tipo: Array of objects
Descrição: Buscar campos específicos dentro de todas las banderas de riesgo
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
Transaction Fields
Fields available for evaluating transaction data.Global Fields
KYC Fields
Fields available for evaluating KYC verification data.Global Fields
Estruturas de Campos Aninhados
Alguns campos contêm estruturas aninhadas (arrays ou objetos) com múltiplos subcampos:kyc.biometricResult - Resultado Biométrico
Tipo: Object
Descrição: Resultados de face match e liveness (KYC provider)
Subcampos Disponíveis:
kyc.documentsVerified - Documentos Verificados
Tipo: Array of objects
Descrição: Lista de documentos verificados no KYC
Subcampos Disponíveis:
Exemplo de Uso (Campo de Array):
kyc.riskAssessment - Avaliação de Risco KYC
Tipo: Object
Descrição: Avaliação de risco realizada pelo KYC
Subcampos Disponíveis:
kyc.extractedData - Dados Extraídos do Documento
Tipo: Object
Descrição: Dados extraídos do documento de identidade
Subcampos Disponíveis:
Shareholders Fields
Fields available for evaluating company shareholders and directors.Shareholder conditions allow you to create rules that evaluate the characteristics of a company’s shareholders and directors. These are relationship-based conditions that check if ANY shareholder matches the specified criteria.The fields listed below show what’s available for person and company shareholders. To use them in conditions, prefix with
shareholders.person. or shareholders.company. as shown in the examples.BR - Country-Specific Fields
AR - Country-Specific Fields
Available Operators
Comparison Operators
eq- Equalsne- Not equalsgt- Greater thangte- Greater than or equallt- Less thanlte- Less than or equalin- Value is in arraynot_in- Value is not in arraybetween- Value is between two numbers (inclusive)not_between- Value is not between two numbersis_null- Field is null or undefinedis_not_null- Field exists and is not null
String Operators
contains- Contains substringnot_contains- Does not contain substringstarts_with- Starts with substringends_with- Ends with substringregex- Matches regular expression patternnot_regex- Does not match regular expression pattern
Boolean Operators
eq:true- Boolean field is trueeq:false- Boolean field is false
Data List Operators
in_datalist- Value exists in a data list (blocklists, allowlists)not_in_datalist- Value does not exist in a data listmatches_datalist_pattern- Value matches a pattern in data list
Custom List Operators
in_custom_list- Value exists in a custom listnot_in_custom_list- Value does not exist in a custom list
Date & Time Operators
date_between- Date is between two datesdate_not_between- Date is not between two dates
Temporal Operators
within_last- Event occurred within last N days/hours/minutesbetween_dates- Date is between two specific datesbefore- Date is before a specific dateafter- Date is after a specific dateage_in_days- Calculate age in daysage_in_hours- Calculate age in hoursage_in_minutes- Calculate age in minutes
Mathematical Operators
add- Additionsubtract- Subtractionmultiply- Multiplicationdivide- Divisionmodulo- Modulo (remainder)power- Exponentiationsum- Sum of valuesavg- Average of valuescount- Count of itemsmin- Minimum valuemax- Maximum valueabs- Absolute valueround- Round to nearest integerceil- Round up to nearest integerfloor- Round down to nearest integer
Geographical Operators
distance_from- Calculate distance from coordinatesin_region- Check if location is in regioncountry_risk_level- Check country risk level
Aggregation Operators
count_in_period- Count occurrences in time periodsum_in_period- Sum values in time periodvelocity_change- Calculate rate of change over timefrequency_pattern- Detect frequency patterns
Logical Operators (for combining conditions)
AND- All conditions must be trueOR- At least one condition must be trueNOT- Inverts the condition resultXOR- Exactly one condition must be true
Usage Examples
Simple Condition - Text Field
Check if a company’s legal name equals a specific value:Number Field with Comparison
Check if company revenue is greater than 1 million:Boolean Field
Check if a company is sanctioned:Date Comparison
Check if incorporation date is after a specific date:Data List Checking
Check if tax ID is in a blocklist:Working with Arrays - The .$. Notation
Array Traversal Syntax
The.$. notation tells the rules engine to:
- Iterate through each element in the array
- Access the specified property within each element
- Apply the condition to matching elements (optionally filtered)
arrayField.$.propertyName
Example 1: Array Field with Filters
Check if a company has active legal proceedings with amount > 100,000:legalProceedingsis an array of objects.$.traverses each legal proceeding in the arrayamountaccesses the amount property of each proceedingfiltersensures we only check proceedings wherestatus === "active"
Example 2: Check Sanction Types
Check if a person has any sanction of type “TERRORIST”:sanctionsis an array containing all sanctions records.$.iterates through each sanctiontypeaccesses the type field of each sanction- The condition matches if ANY sanction has type “TERRORIST”
Example 3: Array with Multiple Filters
Check if a person has any sanction from a specific country and program:enrichmentData.normalized.sanctions.$.type- Sanction typesenrichmentData.normalized.sanctions.$.origin- Sanction originsenrichmentData.normalized.sanctions.$.program- Sanction programsenrichmentData.normalized.legalProceedings.$.amount- Legal proceeding amountsenrichmentData.normalized.legalProceedings.$.status- Legal proceeding statusenrichmentData.normalized.pepLevels.$.level- PEP level values
Working with Shareholders
Shareholder fields use a special structure:
shareholders.(person|company).fieldPathShareholder Field Structure
Shareholders can be either person or company entities. To access shareholder properties, use: Format:shareholders.(person|company).fieldPath
Where:
person- For individual shareholders (uses person entity fields)company- For corporate shareholders (uses company entity fields)fieldPath- Any valid field path from the respective entity type
Example 1: Check Shareholder Tax ID
Check if any shareholder (person) has a specific tax ID:shareholders.person- Look at person-type shareholdersenrichmentData.normalized.taxId- Access their normalized tax ID- This checks ALL person shareholders for a match
Example 2: Check if Shareholder is PEP
Check if any shareholder (person) is a Politically Exposed Person:Example 3: Check if Shareholder is Sanctioned
Check if any shareholder (person) is sanctioned:Example 4: Corporate Shareholder Revenue
Check if any corporate shareholder has revenue greater than 10 million:Example 5: Shareholder Array Fields
Check if any shareholder (person) has sanctions of a specific type:shareholders.person- Look at person shareholdersenrichmentData.normalized.sanctions- Access their sanctions array.$.- Traverse each sanction in the arraytype- Check the type of each sanction
Common Shareholder Patterns
Person Shareholders:shareholders.person.enrichmentData.normalized.taxId- Tax IDshareholders.person.enrichmentData.normalized.isPep- PEP statusshareholders.person.enrichmentData.normalized.sanctioned- Sanction statusshareholders.person.enrichmentData.normalized.isDeceased- Death statusshareholders.person.entityData.person.firstName- First nameshareholders.person.entityData.person.lastName- Last name
shareholders.company.enrichmentData.normalized.taxId- Company tax IDshareholders.company.enrichmentData.normalized.revenue- Revenueshareholders.company.enrichmentData.normalized.sanctioned- Sanction statusshareholders.company.entityData.company.legalName- Legal name
Complex Condition with Multiple Checks
Check if a person is a PEP OR has sanctions OR has criminal records:Notes
Country Metadata
Each condition can include country metadata to provide context about where the field comes from:Array Field Syntax
When working with array fields, use the$ symbol to indicate you’re evaluating items within the array:
enrichmentData.normalized.sanctions.$.type- Checks thetypefield of ANY item in thesanctionsarrayenrichmentData.normalized.legalProceedings.$.amount- Checks theamountfield of ANY item in thelegalProceedingsarray
Filters
Filters allow you to pre-filter array items before applying the main condition. They work with AND logic:See Also
- Create Rule - Learn how to create rules using these fields
- Execute Rule - Test rules against entities
- Provider Codes - Integration provider reference