Skip to main content

Overview

Provider codes are used when configuring automatic integrations during entity creation. This reference lists enrichment codes (*_enrichment) only.
*_check provider codes and POST /integration-execution/marketplace/check were removed (2026-06-04). Use the matching *_enrichment code with Execute enrichment. Legacy create/import payloads that still send *_check, checks, or executeAllActiveChecks are ignored at parse time.

Normalized enrichment field catalog

Under Data points provided, field names refer to consolidated normalized_enrichment data (NormalizedPersonEnrichment / NormalizedCompanyEnrichment): root scalars, consolidated arrays (e.g. sanctions, addresses), and matching *Summary fields when applicable.
Source of truth in code: packages/integrations/src/normalization/normalized-field-providers.ts (NORMALIZED_FIELD_PROVIDERS, getFieldsProvidedBy). To print every ValidProviderCodesEnum value with its mapped fields (or an empty list when not in this catalog), run:
npm run docs:provider-normalized-fields
Add --json to the script invocation for machine-readable output (npx tsx scripts/docs/provider-normalized-fields-report.ts --json).

Provider Code Format

Provider codes follow this naming convention:
{country}_{provider}_{check_type}_{integration_type}
  • country: ISO 3166-1 alpha-2 code (e.g., br, ar, cl, mx) or global
  • provider: Name of the data provider (e.g., bdc, amldd, complyadvantage)
  • check_type: Type of data being retrieved (e.g., kyc, pep, sanctions)
  • integration_type: Prefer enrichment for new work (*_enrichment).

Integration types

Enrichments

Data enrichment that returns detailed information to populate entity profiles. This page documents enrichment codes only.

Marketplace service integrations (service)

Catalog integrations with integration_type = service expose organization-scoped HTTP routes (session or API key with tenant). The organization must enable the integration in Marketplace like any other product.
  • Base path: /api/integration-services/:integrationCode/... (same auth and organizationId context as the rest of the API).
  • Example: ar_gueno_coelsa_service — CBU/CVU counts linked to a CUIT (Argentina).
    • GET /api/integration-services/ar_gueno_coelsa_service/health — service health check.
    • GET /api/integration-services/ar_gueno_coelsa_service/cuits/:cuit/cbu-count:cuit must be 11 digits; response includes cbuCount and cvuCount.
Per-request billing follows the same execution pack or credits rules as other paid marketplace integrations when base_price_cents is greater than zero (the catalog row is seeded free by default).

Marketplace list integrations (lists)

Catalog integrations with integration_type = lists allow an existence-only check: whether a given string appears in that list’s marketplace items (primary_value / search_keys). There is no tenant HTTP API to download or page the full list contents.
  • Base path: /api/marketplace-list-lookups/:integrationCode/lookup (same auth and organizationId context as the rest of the API). Requires permission to read marketplace (marketplace:read / legacy equivalent).
  • Request: POST with JSON body { "value": "<string>" } (value length capped server-side).
  • Success response: { "success": true, "data": { "found": true | false } } — no item payloads, match arrays, or catalog dumps.
  • Not enabled for org: HTTP 404 with error code LIST_INTEGRATION_NOT_ACTIVE (same idea as inactive service integrations).
Lookups use the same marketplace billing path as other list lookups when the product is priced.

Available Provider Codes

Brazil (BR)

BDC (Big Data Corp)

Enrichments:
  • br_bdc_basic_data_enrichment - Basic person/company data
  • br_bdc_related_persons_enrichment - Related persons data
  • br_bdc_judicial_processes_enrichment - Complete judicial records
  • br_bdc_financial_data_enrichment - Financial profile data
  • br_bdc_addresses_extended_enrichment - Complete address history
  • br_bdc_emails_extended_enrichment - Email verification and history
  • br_bdc_phones_extended_enrichment - Phone verification and history
  • br_bdc_related_companies_enrichment - Related companies data
  • br_bdc_lawsuits_enrichment - Detailed lawsuit information
  • br_bdc_kyc_person_enrichment - Complete person KYC data
  • br_bdc_kyc_business_enrichment - Complete business KYC data
  • br_bdc_negative_media_enrichment - Negative media articles
  • br_bdc_negative_media_company_enrichment - Negative media exposure for companies (CNPJ)
  • br_bdc_revenue_estimate_enrichment - Revenue estimates and trends
  • br_bdc_shareholders_enrichment - Complete shareholder structure
  • br_bdc_reputation_reviews_enrichment - Reputation scores and reviews
These keys are the main company fields produced by this enrichment (see providersExpectedFields in code). They may not all appear in getFieldsProvidedBy until mapped in normalized-field-providers.
  • br_bdc_protestos_enrichment - Detailed protestos records
Main person/company summary fields from protest data (expected shapes in code). Consolidated top-level mapping in normalized-field-providers may be partial.
  • br_bdc_faturamento_presumido_enrichment - Presumed revenue analysis
Company revenue / activity indicators (expected fields in code). Same caveat as other BDC enrichments for getFieldsProvidedBy.
  • br_bdc_judicial_processes_shareholders_enrichment - Judicial processes for shareholders
  • br_bdc_basic_data_company_enrichment - Basic company data

JusBrasil

Enrichments:
  • br_jusbrasil_criminal_lawsuits_enrichment - Criminal lawsuit details
  • br_jusbrasil_civil_lawsuits_enrichment - Civil lawsuit details
  • br_jusbrasil_labor_lawsuits_enrichment - Labor lawsuit details
  • br_jusbrasil_public_ministry_enrichment - Public ministry records
  • br_jusbrasil_arrest_warrants_enrichment - Arrest warrant details
  • br_jusbrasil_irregular_employer_enrichment - Irregular employer records

AMLDD (Anti-Money Laundering Due Diligence)

Enrichments:
  • br_amldd_esg_enrichment - ESG compliance data
  • br_amldd_lri_enrichment - LRI detailed records
  • br_amldd_pep_enrichment - PEP complete profiles
  • br_amldd_mtlsn_complete_enrichment - Complete MTLSN data
  • br_amldd_mtlsn_simple_enrichment - Simple MTLSN data
  • br_amldd_mtlsn_with_internal_enrichment - MTLSN with internal data

CPF/CNPJ

Enrichments:
  • br_cpfcnpj_complete_person_enrichment - Complete CPF data
  • br_cpfcnpj_complete_person_9_enrichment - CPF data variant (9-digit / alternate flow)
  • br_cpfcnpj_complete_company_enrichment - Complete CNPJ data

BrasilAPI

Enrichments:
  • br_brasilapi_company_enrichment - Company data from BrasilAPI

Argentina (AR)

BCRA (Banco Central de la República Argentina)

Enrichments:
  • ar_bcra_deudas_enrichment - Complete debt records
  • ar_bcra_historicas_enrichment - Historical financial records
  • ar_bcra_cheques_rechazados_enrichment - Rejected checks details

Nosis

Enrichments:
  • ar_nosis_extended_verification_enrichment - Extended verification data

REPET (Registro Público de Empleadores con Sanciones Laborales)

Enrichments:
  • ar_repet_person_enrichment - Person labor sanctions data
  • ar_repet_entity_enrichment - Entity labor sanctions data

ARCA / AFIP (taxpayer registry)

Enrichments:
  • ar_arca_contribuyente_enrichment - AFIP taxpayer data via ARCA (registry A13 and tax certificate by CUIT/CUIL). Complements identity and tax status.

Gu1 (UIF, KIA, MiPyme/TIA, JIA, PIA/PEP)

AFIP-related and PEP compliance integrations for CUIT/CUIL (marketplace orchestration + ms-providers). Enrichments:
  • ar_gueno_uif_enrichment - UIF: obligated subjects and registration
  • ar_gueno_kia_enrichment - KIA compliance module (CUIT/CUIL)
  • ar_gueno_tia_enrichment - MiPyme / TIA (CUIT/CUIL)
Row-level TIA fields (mipymeRows, vigencias, flags de módulo) live in the per-provider mapped payload and raw response. The consolidated normalized_enrichment surface for rules/matrices includes taxId (subject of search) and isMyPyme (boolean from TIA). Keep normalized-field-providers in sync when adding new root keys.
  • ar_gueno_jia_enrichment - AFIP “non-reliable” taxpayers (JIA)
Besides taxId, consolidated signals are exposed under riskFlags / riskFlagsSummary.
  • ar_gueno_pia_enrichment - PIA: compliance PEP (CUIT/CUIL)
Detail rows (pepRows, related CUIT, free-text fields) stay in the per-provider mapped payload. For consolidated normalized_enrichment / rules, the mapper promotes taxId, isPep / isCurrentPep (confirmed PEP, upstream code 1), isPepPossible (possible PEP, code 2), pepComplianceRowCount, plus riskFlags / riskFlagsSummary when hits exist.

Renaper

Enrichments:
  • ar_renaper_validate_dni_enrichment - DNI validation enrichment (identity flow)
ar_renaper_validate_dni_* codes are not listed in normalized-field-providers today (getFieldsProvidedBy returns no keys). They drive validation / session flows rather than consolidated normalized scalars in this catalog.
  • ar_renaper_data_enrichment - Person identity data from Renaper

Chile (CL)

BaseAPI (SII)

Enrichments:
  • cl_baseapi_basic_data_person_enrichment — Public SII taxpayer status by RUT (natural person). Routed via ms-providers KYB; the HTTP path includes organizationId.
  • cl_baseapi_basic_data_company_enrichment — Same upstream SII response; use this code when the entity is a company.
Root keys mainActivityAfipCode / mainActivityAfipDescription are shared consolidated field names; for Chile they hold the primary economic activity code and description from SII (not Argentina AFIP).

SRE (commercial registry)

Enrichments:
  • cl_sre_info_person_enrichment — Minimal registry-style identity by RUT (person slot).
  • cl_sre_info_company_enrichment — Same for companies.

ruts.info

Enrichments:
  • cl_rutsinfo_info_person_enrichment — Commercial sheet data (activities, addresses) when available for the RUT.
  • cl_rutsinfo_info_company_enrichment — Same for companies.

Global

ComplyAdvantage

Enrichments:
  • global_complyadvantage_company_search_enrichment - Company sanctions data
  • global_complyadvantage_person_search_enrichment - Person sanctions data
  • global_complyadvantage_sanctions_enrichment - Complete sanctions records
  • global_complyadvantage_pep_enrichment - Global PEP profiles

Gu1 (global sanctions)

Enrichments:
  • global_gueno_sanctions_enrichment - Gu1 global sanctions enrichment (incl. watchlist / monitoring when enabled)

Usage Examples

Execute Specific Integrations

{
  "autoExecuteIntegrations": {
    "enrichments": [
      "br_bdc_basic_data_enrichment",
      "br_bdc_shareholders_enrichment",
      "br_amldd_pep_enrichment",
      "global_complyadvantage_sanctions_enrichment"
    ]
  }
}

Execute All Active Integrations

{
  "autoExecuteIntegrations": {
    "executeAllActiveEnrichments": true
  }
}

Selective Integration for Shareholders

{
  "autoExecuteIntegrationsShareholders": {
    "enrichments": {
      "company": ["br_bdc_basic_data_enrichment", "br_bdc_kyc_business_enrichment"],
      "person": ["br_cpfcnpj_complete_person_enrichment", "br_amldd_pep_enrichment"]
    }
  }
}

Provider Coverage by Country

CountryProvidersEnrichments (documented)
Brazil 🇧🇷BDC, JusBrasil, AMLDD, CPF/CNPJ, BrasilAPI40+
Argentina 🇦🇷BCRA, Nosis, REPET, ARCA/AFIP, Gu1 (UIF/KIA/TIA/JIA), Renaper12+
Global 🌍ComplyAdvantage, Gu1 sanctions6

Best practices

  1. Prefer enrichments: Use the enrichment codes listed here for execution configuration.
  2. Use executeAllActiveEnrichments: Let the platform determine which integrations to run based on your configuration.
  3. Be specific for shareholders: Use selective integration for shareholders to control costs.
  4. Combine providers: Mix different providers for comprehensive coverage.
  5. Consider costs: Some providers are heavier than others; scope integrations to what you need.