Skip to main content
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 apenas códigos de enriquecimento (*_enrichment).
Códigos *_check e POST /integration-execution/marketplace/check foram removidos (2026-06-04). Use o *_enrichment correspondente com Executar enrichment. Payloads legacy de create/import que ainda enviem *_check, checks ou executeAllActiveChecks são ignorados no parse.

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

Integrações marketplace tipo service

Integrações de catálogo com integration_type = service expõem rotas HTTP por organização (sessão ou API key com tenant). A organização precisa ativar a integração no Marketplace como qualquer outro produto.
  • Path base: /api/integration-services/:integrationCode/... (mesmo auth e contexto de organizationId que o restante da API).
  • Exemplo: ar_gueno_coelsa_service — totais de CBU/CVU vinculados a um CUIT (Argentina).
    • GET /api/integration-services/ar_gueno_coelsa_service/health — verificação de disponibilidade do serviço.
    • GET /api/integration-services/ar_gueno_coelsa_service/cuits/:cuit/cbu-count:cuit deve ter 11 dígitos; a resposta inclui cbuCount e cvuCount.
A cobrança por request segue as regras de pacote de execuções ou créditos como outras integrações de marketplace quando base_price_cents é maior que zero (a linha de catálogo é semeada grátis por padrão).

Integrações marketplace tipo lists (listas)

Integrações com integration_type = lists permitem apenas verificar se existe um valor nos itens da lista (primary_value / search_keys). Não há endpoint HTTP para tenant baixar ou paginar o catálogo completo.
  • Path base: /api/marketplace-list-lookups/:integrationCode/lookup (mesmo auth e contexto de organizationId que o restante da API). Exige permissão de leitura do marketplace (marketplace:read / equivalente legacy).
  • Request: POST com body JSON { "value": "<string>" } (comprimento máximo limitado no servidor).
  • Resposta de sucesso: { "success": true, "data": { "found": true | false } } — sem payloads de item, arrays de correspondências nem dumps da lista.
  • Integração não habilitada para a org: HTTP 404 com código LIST_INTEGRATION_NOT_ACTIVE (mesma ideia que integrações service inativas).
As consultas usam o mesmo fluxo de billing de marketplace que outros lookups de listas quando o produto é pago.

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

ARCA / AFIP (contribuinte)

Enriquecimentos:
  • ar_arca_contribuyente_enrichment - Dados fiscais do contribuinte (AFIP via ARCA: cadastro A13 e certidão por CUIT/CUIL). Complementa identidade e situação fiscal.

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

Integrações de compliance fiscal / AFIP e PEP para CUIT/CUIL (orquestração do marketplace + ms-providers). Enriquecimentos:
  • ar_gueno_uif_enrichment - UIF: sujeitos obrigados e inscrição
  • ar_gueno_kia_enrichment - KIA (compliance por CUIT/CUIL)
  • ar_gueno_tia_enrichment - MiPyme / TIA por CUIT/CUIL
Campos detalhados do TIA (mipymeRows, vigências, flags de módulo) ficam no mapped por provedor e na resposta bruta. No normalized_enrichment consolidado para regras/matrizes entram taxId (sujeito da busca) e isMyPyme. Ao adicionar chaves novas na raiz, atualizar normalized-field-providers.
  • ar_gueno_jia_enrichment - AFIP: contribuintes não confiáveis (JIA)
Além de taxId, os sinais consolidados vão em riskFlags / riskFlagsSummary.
  • ar_gueno_pia_enrichment - PIA: compliance PEP (CUIT/CUIL)
As linhas detalhadas (pepRows, CUIT relacionado, textos) ficam no mapped por provedor. No normalized_enrichment consolidado / regras o mapper expõe taxId, isPep / isCurrentPep (PEP confirmado, código 1), isPepPossible (possível PEP, código 2), pepComplianceRowCount, e riskFlags / riskFlagsSummary quando há correspondências.

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

Chile (CL)

BaseAPI (SII)

Enriquecimentos:
  • cl_baseapi_basic_data_person_enrichment — Situação tributária pública do SII por RUT (pessoa física). Rota KYB via ms-providers; o path inclui organizationId.
  • cl_baseapi_basic_data_company_enrichment — Mesma resposta upstream; use o código de empresa quando a entidade jurídica for empresa.
As chaves root mainActivityAfipCode / mainActivityAfipDescription são nomes compartilhados do modelo consolidado; no Chile representam código e descrição da atividade econômica conforme o SII (não a AFIP Argentina).

SRE (registro comercial)

Enriquecimentos:
  • cl_sre_info_person_enrichment — Identidade mínima por RUT (slot pessoa).
  • cl_sre_info_company_enrichment — O mesmo para empresas.

ruts.info

Enriquecimentos:
  • cl_rutsinfo_info_person_enrichment — Ficha comercial (atividades, endereços) quando disponíveis para o RUT.
  • cl_rutsinfo_info_company_enrichment — O mesmo para empresas.

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

Gu1 (sanções globais)

Enriquecimentos:
  • global_gueno_sanctions_enrichment - Sanções globais Gu1 (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, ARCA/AFIP, Gu1 (UIF/KIA/TIA/JIA), Renaper12+
Global 🌍ComplyAdvantage, Gu1 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