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/person-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 · Pessoa ​

Cadastro base de um CPF na Receita Federal: existencia do documento, identificacao, filiacao, obito e situacao cadastral.

EntidadePessoa (CPF, entity: pf)
Móduloprofile
Versão1.0
Datasetperson-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 person-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.namestring
profile.genderstring
profile.birthDatestringdate
profile.nationalitystring
profile.isDeceasedboolean
profile.parents.motherstring
profile.parents.fatherstring
profile.alternativeIds.socialSecuritystring

taxStatus ​

CampoTipoObservação
profile.taxId.numberstring
profile.taxId.statusstring
profile.taxId.statusDatestringdate
profile.taxId.originstring
profile.taxId.countrystring
profile.taxId.fiscalRegionstring

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_PERSON_DECEASED, PROFILE_PERSON_IRREGULAR_STATUS — Nome do indicador.

Indicadores publicados por este dataset:

  • PROFILE_PERSON_DECEASED
  • PROFILE_PERSON_IRREGULAR_STATUS