--- url: https://developers.zarv.com/api/id-v3/datasets.md description: >- Os datasets que um enriquecimento do Zarv ID v3 pode devolver, por entidade, módulo e versão, com o formato do corpo de cada módulo. --- # Datasets Um enriquecimento devolve, em `data`, um objeto por módulo. Cada módulo é respondido por um **dataset** — uma versão publicada e imutável do módulo, como `person-profile-2.0`. Qual versão roda é definido pelo **perfil** (`profileId`); o campo `modules.{módulo}.dataset` da resposta diz qual respondeu. Para saber qual dataset cada módulo do seu perfil usa antes de criar um enriquecimento, consulte [`GET /api/v3/profiles/{id}`](/api/id-v3/getProfile): o `modules` do perfil traz o mesmo `dataset` que a resposta do enriquecimento. [`GET /api/v3/profiles`](/api/id-v3/listProfiles) lista os perfis do seu workspace. Uma versão publicada nunca muda de formato: uma mudança incompatível sai como uma nova versão, e o perfil escolhe quando migrar. * **Base**: roda sempre que o perfil inclui o módulo. O `profile` roda em todo enriquecimento: é ele que localiza o titular (`outcome: subject_not_found` quando não há titular). * **Add-on**: só roda quando pedido em `options.modules` na criação e habilitado no perfil. | Entidade | Módulo | Versões | Tipo | Descrição (versão mais recente) | | -------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Pessoa | `finance` | [1.0](/api/id-v3/datasets/person-finance-1-0), [1.1](/api/id-v3/datasets/person-finance-1-1) | Base | Renda estimada de um CPF convertida em reais, patrimonio, historico de declaracao de imposto de renda e beneficios sociais com extrato de pagamentos. | | Pessoa | `financeAdvanced` | [2.0](/api/id-v3/datasets/person-financeAdvanced-2-0) | Add-on | Registro negativo de credito de uma pessoa: dividas vencidas, protestos em cartorio, cheques devolvidos, acoes e execucoes judiciais e falencia, com a situacao do CPF na Receita Federal. | | Pessoa | `lawsuits` | [1.0](/api/id-v3/datasets/person-lawsuits-1-0), [2.0](/api/id-v3/datasets/person-lawsuits-2-0), [3.0](/api/id-v3/datasets/person-lawsuits-3-0) | Base | Processos judiciais de um CPF classificados na taxonomia do CNJ, de três fontes processuais: contadores por natureza, janelas de tempo, indicadores, e cada processo por inteiro. | | Pessoa | `profile` | [1.0](/api/id-v3/datasets/person-profile-1-0), [2.0](/api/id-v3/datasets/person-profile-2-0) | Base | Cadastro base de um CPF mais os contatos conhecidos: telefones, e-mails e enderecos com quantas fontes confirmam cada um, o canal preferencial, e os sinais de estrangeiro e de exposicao politica. | | Pessoa | `related` | [1.0](/api/id-v3/datasets/person-related-1-0), [1.1](/api/id-v3/datasets/person-related-1-1), [2.0](/api/id-v3/datasets/person-related-2-0) | Base | Rede de relacionamentos de um CPF com o parentesco lido de registro alem do inferido, e a natureza de cada linha declarada em basis. | | Empresa | `finance` | [1.0](/api/id-v3/datasets/company-finance-1-0) | Base | Porte e trajetoria de um CNPJ: faixa de faturamento, funcionarios hoje e nas medias de 1, 3 e 5 anos, filiais, socios, capital, indice de atividade e historico de cobranca. | | Empresa | `financeAdvanced` | [2.0](/api/id-v3/datasets/company-financeAdvanced-2-0) | Add-on | Registro negativo de credito de uma empresa: dividas vencidas, protestos em cartorio, cheques devolvidos e declaracao de contumacia, com a situacao cadastral do CNPJ. | | Empresa | `lawsuits` | [1.0](/api/id-v3/datasets/company-lawsuits-1-0), [2.0](/api/id-v3/datasets/company-lawsuits-2-0), [3.0](/api/id-v3/datasets/company-lawsuits-3-0) | Base | Processos judiciais de um CNPJ classificados na taxonomia do CNJ, de três fontes processuais: contadores por natureza, janelas de tempo, indicadores, e cada processo por inteiro. | | Empresa | `ownersLawsuits` | [1.0](/api/id-v3/datasets/company-ownersLawsuits-1-0) | Base | Processos judiciais dos sócios do quadro societário de um CNPJ, um histórico por pessoa: contadores por natureza, indicadores, e cada processo por inteiro. | | Empresa | `profile` | [1.0](/api/id-v3/datasets/company-profile-1-0), [2.0](/api/id-v3/datasets/company-profile-2-0) | Base | Cadastro de um CNPJ na Receita Federal: existencia, nomes, situacao cadastral e seu motivo, natureza juridica, capital declarado, atividades e historico de mudancas. Mais os telefones, e-mails e enderecos associados ao CNPJ, com quantos outros documentos usam cada um. | | Empresa | `related` | [1.0](/api/id-v3/datasets/company-related-1-0), [2.0](/api/id-v3/datasets/company-related-2-0) | Base | Quadro societario de um CNPJ mais o grupo por raiz do documento: matriz e filiais, com a distribuicao de situacao cadastral e de regime sobre o grupo inteiro. | Todo dataset tem o mesmo envelope: ```json { "dataset": "person-profile-2.0", "module": "profile", "profile": { "...": "os dados do módulo, sob o nome do módulo" } } ``` Veja cada página para os campos de cada versão.