Skip to content
Vai integrar a API REST da Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a API REST da Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/id-v3/datasets/company-profile-1-0
- Autenticação Bearer JWT e hosts: https://developers.zarv.com/setup
- Índice das APIs: https://developers.zarv.com/api
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

Os specs OpenAPI publicados são a fonte da verdade para rotas e schemas — use o spec da API que você escolher antes de escrever qualquer request.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: escolher a API certa e fazer a primeira chamada autenticada]

profile 1.0 · Empresa ​

Cadastro de um CNPJ na Receita Federal: existencia, nomes, situacao cadastral e seu motivo, natureza juridica, capital declarado, atividades e historico de mudancas.

EntidadeEmpresa (CNPJ, entity: pj)
Móduloprofile
Versão1.0 (mais recente)
Datasetcompany-profile-1.0
ExecuçãoSempre roda: é o módulo que localiza o titular

Este é o formato de data.profile em GET /api/v3/enrichments/{id}?include=profile e o corpo de GET /api/v3/enrichments/{id}/modules/profile. Os campos são publicados como o dataset os entrega: um campo ausente significa que o dado não foi obtido, não que o valor é falso ou zero. Os caminhos abaixo são relativos a data.profile.

Envelope ​

CampoTipoObservação
datasetstringsempre company-profile-1.0
modulestringsempre profile
profileobjectos dados do módulo (abaixo)
rulesarray<object>os indicadores avaliados pelo dataset (abaixo)

Dados ​

identification ​

CampoTipoObservação
profile.existsboolean
profile.officialNamestring
profile.tradeNamestring
profile.foundedAtstringdate
profile.isHeadquarterboolean
profile.headquarterStatestring
profile.isConglomerateboolean
profile.aliases.officialNamestring
profile.aliases.tradeNamestring
profile.uniqueness.namenumber
profile.uniqueness.officialNamenumber
profile.uniqueness.tradeNamenumber

taxStatus ​

CampoTipoObservação
profile.taxId.numberstring
profile.taxId.statusstring
profile.taxId.statusReasonstring
profile.taxId.statusDatestringdate
profile.taxId.registrationDatestringdate
profile.taxId.originstring
profile.taxId.countrystring
profile.taxId.regimestring
profile.taxId.companyTypestring
profile.taxId.simplesOptantboolean
profile.specialSituationstring

constitution ​

CampoTipoObservação
profile.legalNature.codestring
profile.legalNature.activitystring
profile.capital.valuenumber
profile.capital.descriptionstring
profile.registration.nirestring
profile.registration.headquartersCapitalnumber
profile.registration.lastCaptureDatestringdate

activities ​

CampoTipoObservação
profile.activitiesarray<object>
profile.activities[].activitystring
profile.activities[].classstring
profile.activities[].codestring
profile.activities[].divisionstring
profile.activities[].groupstring
profile.activities[].isMainboolean

foreignTrade ​

CampoTipoObservação
profile.foreignTrade.codestring
profile.foreignTrade.lastUpdatestringdate

history ​

CampoTipoObservação
profile.history.tradeNameChangedboolean
profile.history.taxRegimeChangedboolean
profile.history.tradeNamearray<object>
profile.history.tradeName[].endDatestringdate
profile.history.tradeName[].startDatestringdate
profile.history.tradeName[].valuestring
profile.history.taxRegimearray<object>
profile.history.taxRegime[].endDatestringdate
profile.history.taxRegime[].startDatestringdate
profile.history.taxRegime[].valuestring

record ​

CampoTipoObservação
profile.record.createdAtstringdate
profile.record.updatedAtstringdate

Indicadores (rules) ​

CampoTipoObservação
rules[].evidenceobjectOs dados que sustentam o indicador, quando disparou.
rules[].firedbooleantrue quando o indicador se aplica aos dados.
rules[].magnitudenumberIntensidade do achado, quando ele tem uma (ex.: uma contagem ou um valor).
rules[].notApplicablebooleantrue quando o indicador não pôde ser avaliado porque o dado que ele lê está ausente. Não é o mesmo que não disparar.
rules[].reasonstringPor que o indicador não pôde ser avaliado (com notApplicable).
rules[].rulestringPROFILE_COMPANY_BANKRUPTCY, PROFILE_COMPANY_IRREGULAR_STATUS, PROFILE_COMPANY_REGIME_MEI, PROFILE_COMPANY_STATUS_CLOSED, PROFILE_COMPANY_STATUS_INAPT — Nome do indicador.

Indicadores publicados por este dataset:

  • PROFILE_COMPANY_BANKRUPTCY
  • PROFILE_COMPANY_IRREGULAR_STATUS
  • PROFILE_COMPANY_REGIME_MEI
  • PROFILE_COMPANY_STATUS_CLOSED
  • PROFILE_COMPANY_STATUS_INAPT