Skip to main content
GET
Obter enrichment normalizado

Visão geral

Devolve o último dossiê normalizado persistido de uma entidade: um JSON no formato Gu1 (normalizedData) mesclado a partir de todos os enrichments que já rodaram nessa entidade. Este endpoint é uma leitura. Não chama integrações externas e não consome créditos de enrichment. Para preencher ou atualizar o dossiê, use Executar enrichment. Use quando precisar do perfil canônico (flags PEP, sanções, endereços, processos judiciais e os mesmos paths que as regras leem como enrichmentData.normalized.*). Para o último payload mapped/raw por código de integração, use Obter dados atuais de enrichment. Exige a permissão granular entities:read na API key (fallback legacy entities:read).

Endpoint

Autenticação

Parâmetros de rota

string
required
UUID da entidade na Gu1.

Resposta

Envelope: { "success": true, "data": { ... } }.
string
UUID da linha de enrichment normalizado.
string
UUID da entidade.
string
UUID da organização.
string
person ou company.
NormalizeType
Contrato flatten de normalização Gu1: RootData ∩ arrays de consolidadores ∩ objetos *Summary no mesmo JSON (não aninhado como { root, consolidated }). Mesmas chaves que as regras leem em enrichmentData.normalized.*. Consulte o contrato de normalizedData abaixo. Podem aparecer chaves legacy de mappers antigos; integrações novas devem usar só este contrato.
object
Métricas de completeza e confiança recalculadas na leitura conforme o país da entidade, mais recommendations opcionais de enrichments adicionais.
array
Códigos de integração que contribuíram para este dossiê (por exemplo br_cpf_enrichment). O nome do campo JSON é providersUsed.
number
Score de qualidade 0–100, quando presente.
number
Score de confiança 0–100, quando presente.
number
Score de completeza 0–100, quando presente.
array
Campos em que as fontes discordaram e como a Gu1 resolveu (field, values, resolution, selectedValue, confidence).
string
Timestamp ISO 8601 da linha.
string
Timestamp ISO 8601 da última atualização.

normalizedData contrato

TypeScript canônico: NormalizeType = RootData & ToConsolidateType & SummariesType. Todas as chaves são opcionais. A presença depende do tipo de entidade (person / company), do país e de quais enrichments rodaram. Uma chave ausente é “não preenchida”, não false / 0.
Paths de regras: enrichmentData.normalized.<key> (for example enrichmentData.normalized.isPep, enrichmentData.normalized.legalProceedings.$.type). Catálogo completo de paths: Condições de regras.

Proveniência nas linhas dos consolidadores

Cada item de consolidadores costuma incluir:

Root (RootData)

Escalares em normalizedData (flags de conveniência + identidade). Para listas, prefira consolidadores (riskFlags, sanctions, addresses). PEP Sanções / mídia / terrorismo Identidade e contato Identidade da empresa Fiscal / emprego / AML (principalmente AR) activities é a lista texto/XML AFIP; a lista estruturada é economicActivities. isAMLObligatedSubject é sujeito obrigado LA/FT (não PEP político). isUifObligatedSubject é inscrição UIF (distinto do SO Nosis). Crédito debtSituation são códigos de situação 1–5 únicos. Eleitoral (métricas root)

Consolidadores (ToConsolidateType + summaries)

Os arrays ficam ao lado do *Summary no mesmo objeto. P = pessoa, C = empresa. As linhas persistidas também podem expor electoralActivity (nome legado do array). Prefira electoralActivities.

Tipos de item

Os summaries (addressesSummary, legalProceedingsSummary, shareholdersSummary, …) expõem contagens, breakdowns byType / byStatus e flags como hasActiveCriminalCases, hasArrestWarrant, hasFamilyRelationships. A forma coincide com as interfaces TypeScript *Summary dos tipos compartilhados de consolidadores da Gu1.

Erros

Se ainda não existir linha normalizada, a API responde 404 (não um body vazio com success: true).

Exemplo

normalizedData em produção é bem maior que este exemplo. Trate-o como pista de forma, não como schema completo.

Relacionado