Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gu1.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Provider codes are used when configuring automatic integrations during entity creation. This reference lists enrichment codes (*_enrichment). Legacy *_check codes may still exist in older API payloads but are not documented here and are not recommended for new integrations.

​
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, 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.

​
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

​
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

​
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

​
Gueno (global sanctions)

Enrichments:
  • global_gueno_sanctions_enrichment - Gueno 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, Renaper7+
Global 🌍ComplyAdvantage, Gueno 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.