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.

Para executar um enriquecimento de marketplace sem entidade persistida (sujeito em memória + apenas auditoria headless), veja Executar sem entidade (e os endpoints de lista e detalhe na mesma referência de API).

​
Resumo

Os códigos de provedores são usados ao configurar integrações automáticas durante a criação de entidades. Esta referência lista códigos de enriquecimento (*_enrichment). Códigos legados *_check podem ainda existir em payloads antigos da API, mas não são documentados aqui e não são recomendados para integrações novas.

​
Catálogo de campos em normalized_enrichment

Em Pontos de dados fornecidos, os nomes referem-se ao JSON consolidado de normalized_enrichment (pessoa ou empresa): campos raiz, arrays consolidados (ex.: sanctions, addresses) e campos *Summary quando aplicável.
Fonte no código: packages/integrations/src/normalization/normalized-field-providers.ts (NORMALIZED_FIELD_PROVIDERS, getFieldsProvidedBy). Para listar todos os valores de ValidProviderCodesEnum com campos mapeados (ou lista vazia), execute:
npm run docs:provider-normalized-fields
Saída JSON: npx tsx scripts/docs/provider-normalized-fields-report.ts --json.

​
Formato do Código de Provedor

Os códigos de provedores seguem esta convenção de nomenclatura: 
{país}_{provedor}_{tipo_verificação}_{tipo_integração}
  • país: Código ISO 3166-1 alfa-2 (ex: br, ar, mx) ou global
  • provedor: Nome do provedor de dados (ex: bdc, amldd, complyadvantage)
  • tipo_verificação: Tipo de dados que estão sendo recuperados (ex: kyc, pep, sanctions)
  • tipo_integração: Prefira enrichment para trabalho novo (*_enrichment).

​
Tipos de integração

​
Enrichments (enriquecimentos)

Enriquecimento de dados que retorna informações detalhadas para preencher perfis de entidades. Esta página documenta apenas códigos de enriquecimento.

​
Códigos de Provedores Disponíveis

​
Brasil (BR)

​
BDC (Big Data Corp)

Enriquecimentos:
  • br_bdc_basic_data_enrichment - Dados básicos de pessoa
  • br_bdc_basic_data_company_enrichment - Dados básicos de empresa
  • br_bdc_related_persons_enrichment - Dados de pessoas relacionadas
  • br_bdc_judicial_processes_enrichment - Registros judiciais completos
  • br_bdc_judicial_processes_shareholders_enrichment - Processos judiciais de sócios
  • br_bdc_financial_data_enrichment - Dados de perfil financeiro
  • br_bdc_addresses_extended_enrichment - Histórico completo de endereços
  • br_bdc_emails_extended_enrichment - Verificação e histórico de e-mails
  • br_bdc_phones_extended_enrichment - Verificação e histórico de telefones
  • br_bdc_related_companies_enrichment - Dados de empresas relacionadas
  • br_bdc_lawsuits_enrichment - Informações detalhadas de processos
  • br_bdc_kyc_person_enrichment - Dados completos de KYC de pessoa
  • br_bdc_kyc_business_enrichment - Dados completos de KYC empresarial
  • br_bdc_negative_media_enrichment - Artigos de mídia negativa
  • br_bdc_negative_media_company_enrichment - Mídia negativa para empresas (CNPJ)
  • br_bdc_revenue_estimate_enrichment - Estimativas e tendências de receita
  • br_bdc_shareholders_enrichment - Estrutura completa de sócios
  • br_bdc_reputation_reviews_enrichment - Pontuações de reputação e avaliações
Essas chaves são os principais campos de empresa produzidos por este enriquecimento (ver providersExpectedFields no código). Nem todas podem aparecer em getFieldsProvidedBy até serem mapeadas em normalized-field-providers.
  • br_bdc_protestos_enrichment - Registros detalhados de protestos
Resumo principal pessoa/empresa sobre protestos (formas esperadas no código). O mapeamento consolidado em normalized-field-providers pode ser parcial.
  • br_bdc_faturamento_presumido_enrichment - Análise de faturamento presumido
Indicadores de empresa de receita / atividade (campos esperados no código). Mesma ressalva dos outros BDC quanto a getFieldsProvidedBy.

​
JusBrasil

Enriquecimentos:
  • br_jusbrasil_criminal_lawsuits_enrichment - Detalhes de processos criminais
  • br_jusbrasil_civil_lawsuits_enrichment - Detalhes de processos cíveis
  • br_jusbrasil_labor_lawsuits_enrichment - Detalhes de processos trabalhistas
  • br_jusbrasil_public_ministry_enrichment - Registros do Ministério Público
  • br_jusbrasil_arrest_warrants_enrichment - Detalhes de mandados de prisão
  • br_jusbrasil_irregular_employer_enrichment - Registros de empregador irregular

​
AMLDD (Anti-Money Laundering Due Diligence)

Enriquecimentos:
  • br_amldd_esg_enrichment - Dados de conformidade ESG
  • br_amldd_lri_enrichment - Registros detalhados de LRI
  • br_amldd_pep_enrichment - Perfis completos de PEP
  • br_amldd_mtlsn_complete_enrichment - Dados completos de MTLSN
  • br_amldd_mtlsn_simple_enrichment - Dados simplificados de MTLSN
  • br_amldd_mtlsn_with_internal_enrichment - MTLSN com dados internos

​
CPF/CNPJ

Enriquecimentos:
  • br_cpfcnpj_complete_person_enrichment - Dados completos de CPF
  • br_cpfcnpj_complete_person_9_enrichment - Variante CPF (fluxo alternativo)
  • br_cpfcnpj_complete_company_enrichment - Dados completos de CNPJ

​
BrasilAPI

Enriquecimentos:
  • br_brasilapi_company_enrichment - Dados de empresa

​
Argentina (AR)

​
BCRA (Banco Central de la República Argentina)

Enriquecimentos:
  • ar_bcra_deudas_enrichment - Registros completos de dívidas
  • ar_bcra_historicas_enrichment - Registros financeiros históricos
  • ar_bcra_cheques_rechazados_enrichment - Detalhes de cheques rejeitados

​
Nosis

Enriquecimentos:
  • ar_nosis_extended_verification_enrichment - Dados de verificação estendida

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

Enriquecimentos:
  • ar_repet_person_enrichment - Dados de sanções trabalhistas de pessoa
  • ar_repet_entity_enrichment - Dados de sanções trabalhistas de entidade

​
Renaper

Enriquecimentos:
  • ar_renaper_validate_dni_enrichment - Validação de DNI (fluxo de identidade)
Os códigos ar_renaper_validate_dni_* não estão no mapa normalized-field-providers hoje (getFieldsProvidedBy vazio).
  • ar_renaper_data_enrichment - Dados de identidade

​
Global

​
ComplyAdvantage

Enriquecimentos:
  • global_complyadvantage_company_search_enrichment - Dados de sanções de empresa
  • global_complyadvantage_person_search_enrichment - Dados de sanções de pessoa
  • global_complyadvantage_sanctions_enrichment - Registros completos de sanções
  • global_complyadvantage_pep_enrichment - Perfis globais de PEP

​
Gueno (sanções globais)

Enriquecimentos:
  • global_gueno_sanctions_enrichment - Sanções globais Gueno (incl. monitoramento / watchlist quando habilitado)

​
Exemplos de Uso

​
Executar Integrações Específicas

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

​
Executar Todas as Integrações Ativas

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

​
Integração Seletiva para Sócios

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

​
Cobertura de Provedores por País

PaísProvedoresEnriquecimentos (documentados)
Brasil 🇧🇷BDC, JusBrasil, AMLDD, CPF/CNPJ, BrasilAPI40+
Argentina 🇦🇷BCRA, Nosis, REPET, Renaper7+
Global 🌍ComplyAdvantage, Gueno sanções6

​
Boas práticas

  1. Prefira enriquecimentos: Use os códigos *_enrichment listados aqui na configuração de execução.
  2. Use executeAllActiveEnrichments: Deixe a plataforma determinar quais integrações executar com base na sua configuração.
  3. Seja específico para sócios: Use integração seletiva para sócios para controlar custos.
  4. Combine provedores: Misture diferentes provedores para cobertura abrangente.
  5. Considere os custos: Alguns provedores são mais pesados que outros; limite ao que precisa.

​
Documentação Relacionada