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-3-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 3.0 · Pessoa ​

Cadastro base de um CPF mais os contatos conhecidos: telefones, e-mails e enderecos com quantas fontes confirmam cada um e quando cada um foi visto pela ultima vez, o canal preferencial, e os sinais de estrangeiro e de exposicao politica.

EntidadePessoa (CPF, entity: pf)
Móduloprofile
Versão3.0 (mais recente)
Datasetperson-profile-3.0
ExecuçãoSempre roda: é o módulo que localiza o titular

Este é o formato do corpo de GET /api/v3/enrichments/{id}/modules/profile, a rota que a url do módulo, na raiz do enriquecimento, aponta. 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 ao corpo da resposta.

Envelope ​

CampoTipoObservação
datasetstringsempre person-profile-3.0
modulestringsempre profile
profileobjectos dados do módulo (abaixo)

Dados ​

identification ​

CampoTipoObservação
profile.existsboolean
profile.namestring
profile.genderstring
profile.birthDatestringdate
profile.nationalitystring
profile.isForeignboolean
profile.originstring
profile.isDeceasedboolean
profile.politicallyExposedboolean
profile.parents.motherstring
profile.parents.fatherstring
profile.parents.motherConfirmedboolean
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

contactPhones ​

CampoTipoObservação
profile.contacts.phones.oldestPassageAtstringdate
profile.contacts.phones.newestPassageAtstringdate
profile.contacts.phones.itemsarray<object>
profile.contacts.phones.items[].activeboolean
profile.contacts.phones.items[].areaCodestring
profile.contacts.phones.items[].carrierstring
profile.contacts.phones.items[].confirmationsinteger
profile.contacts.phones.items[].countryCodestring
profile.contacts.phones.items[].createdAtstringdate
profile.contacts.phones.items[].doNotCallboolean
profile.contacts.phones.items[].footprintobject
profile.contacts.phones.items[].footprint.addressStatesarray<string>
profile.contacts.phones.items[].footprint.areaCodeVsAddressesstring
profile.contacts.phones.items[].footprint.firstSeenAtstring
profile.contacts.phones.items[].footprint.lineTypestring
profile.contacts.phones.items[].footprint.listedobject
profile.contacts.phones.items[].footprint.listed.sincestring
profile.contacts.phones.items[].footprint.listed.typestring
profile.contacts.phones.items[].footprint.sharedDocumentsinteger
profile.contacts.phones.items[].footprint.verificationobject
profile.contacts.phones.items[].footprint.verification.atstring
profile.contacts.phones.items[].footprint.verification.channelstring
profile.contacts.phones.items[].footprint.verifiedByOthersinteger
profile.contacts.phones.items[].lastSeenAtstringdate
profile.contacts.phones.items[].mainboolean
profile.contacts.phones.items[].numberstring
profile.contacts.phones.items[].planTypestring
profile.contacts.phones.items[].preferredboolean
profile.contacts.phones.items[].typestring
profile.contacts.phones.items[].updatedAtstringdate

contactEmails ​

CampoTipoObservação
profile.contacts.emails.oldestPassageAtstringdate
profile.contacts.emails.newestPassageAtstringdate
profile.contacts.emails.itemsarray<object>
profile.contacts.emails.items[].activeboolean
profile.contacts.emails.items[].addressstring
profile.contacts.emails.items[].confirmationsinteger
profile.contacts.emails.items[].createdAtstringdate
profile.contacts.emails.items[].domainstring
profile.contacts.emails.items[].footprintobject
profile.contacts.emails.items[].footprint.disposableboolean
profile.contacts.emails.items[].footprint.domainBlocklistedboolean
profile.contacts.emails.items[].footprint.domainCheckedboolean
profile.contacts.emails.items[].footprint.domainRecentboolean
profile.contacts.emails.items[].footprint.firstSeenAtstring
profile.contacts.emails.items[].footprint.freeProviderboolean
profile.contacts.emails.items[].footprint.hasGravatarboolean
profile.contacts.emails.items[].footprint.listedobject
profile.contacts.emails.items[].footprint.listed.sincestring
profile.contacts.emails.items[].footprint.listed.typestring
profile.contacts.emails.items[].footprint.mxboolean
profile.contacts.emails.items[].footprint.randomLocalPartboolean
profile.contacts.emails.items[].footprint.roleAccountboolean
profile.contacts.emails.items[].footprint.sharedDocumentsinteger
profile.contacts.emails.items[].footprint.typoDomainboolean
profile.contacts.emails.items[].footprint.verificationobject
profile.contacts.emails.items[].footprint.verification.atstring
profile.contacts.emails.items[].footprint.verification.channelstring
profile.contacts.emails.items[].footprint.verifiedByOthersinteger
profile.contacts.emails.items[].lastSeenAtstringdate
profile.contacts.emails.items[].mainboolean
profile.contacts.emails.items[].preferredboolean
profile.contacts.emails.items[].typestring
profile.contacts.emails.items[].updatedAtstringdate
profile.contacts.emails.items[].validationStatusstring

contactAddresses ​

CampoTipoObservação
profile.contacts.addresses.oldestPassageAtstringdate
profile.contacts.addresses.newestPassageAtstringdate
profile.contacts.addresses.itemsarray<object>
profile.contacts.addresses.items[].activeboolean
profile.contacts.addresses.items[].citystring
profile.contacts.addresses.items[].complementstring
profile.contacts.addresses.items[].confirmationsinteger
profile.contacts.addresses.items[].countrystring
profile.contacts.addresses.items[].createdAtstringdate
profile.contacts.addresses.items[].footprintobject
profile.contacts.addresses.items[].footprint.companiesAtAddressstring
profile.contacts.addresses.items[].footprint.firstSeenAtstring
profile.contacts.addresses.items[].footprint.listedobject
profile.contacts.addresses.items[].footprint.listed.sincestring
profile.contacts.addresses.items[].footprint.listed.typestring
profile.contacts.addresses.items[].footprint.locationobject
profile.contacts.addresses.items[].footprint.location.geometryobject
profile.contacts.addresses.items[].footprint.location.geometry.coordinatesarray<number>
profile.contacts.addresses.items[].footprint.location.geometry.typestring
profile.contacts.addresses.items[].footprint.location.propertiesobject
profile.contacts.addresses.items[].footprint.location.properties.precisionMnumber
profile.contacts.addresses.items[].footprint.location.properties.sourcestring
profile.contacts.addresses.items[].footprint.location.typestring
profile.contacts.addresses.items[].footprint.riskobject
profile.contacts.addresses.items[].footprint.risk.categoriesarray<string>
profile.contacts.addresses.items[].footprint.risk.levelinteger
profile.contacts.addresses.items[].footprint.risk.municipalityLevelinteger
profile.contacts.addresses.items[].footprint.sharedDocumentsinteger
profile.contacts.addresses.items[].footprint.useobject
profile.contacts.addresses.items[].footprint.use.basisstring
profile.contacts.addresses.items[].footprint.use.usestring
profile.contacts.addresses.items[].footprint.verificationobject
profile.contacts.addresses.items[].footprint.verification.atstring
profile.contacts.addresses.items[].footprint.verification.channelstring
profile.contacts.addresses.items[].lastSeenAtstringdate
profile.contacts.addresses.items[].mainboolean
profile.contacts.addresses.items[].neighborhoodstring
profile.contacts.addresses.items[].numberstring
profile.contacts.addresses.items[].preferredboolean
profile.contacts.addresses.items[].statestring
profile.contacts.addresses.items[].streetstring
profile.contacts.addresses.items[].typestring
profile.contacts.addresses.items[].updatedAtstringdate
profile.contacts.addresses.items[].zipCodestring

timeline ​

CampoTipoObservação
profile.timelinearray<object>
profile.timeline[].amountBrlnumber
profile.timeline[].basisstring
profile.timeline[].datestring
profile.timeline[].detailstring
profile.timeline[].eventstring
profile.timeline[].precisionstring
profile.timeline[].refstring
profile.timeline[].sourcestring

contactFootprint ​

CampoTipoObservação
profile.contacts.phones.discardedinteger
profile.contacts.emails.discardedinteger
profile.contacts.addresses.discardedinteger

wanted ​

CampoTipoObservação
profile.wantedobject
profile.wanted.crimesarray<string>
profile.wanted.deceasedboolean
profile.wanted.delistedAtstring
profile.wanted.lastSeenAtstring
profile.wanted.listedboolean
profile.wanted.listsarray<object>
profile.wanted.lists[].delistedAtstring
profile.wanted.lists[].firstSeenAtstring
profile.wanted.lists[].lastSeenAtstring
profile.wanted.lists[].liststring
profile.wanted.lists[].listedboolean
profile.wanted.lists[].matchstring
profile.wanted.listsUpdatedAtstring
profile.wanted.matchstring
profile.wanted.sincestring
profile.wanted.statusstring
profile.wanted.timesListedinteger
profile.wanted.warrantsarray<object>
profile.wanted.warrants[].chargestring
profile.wanted.warrants[].courtstring
profile.wanted.warrants[].issuedAtstring
profile.wanted.warrants[].issuingCountrystring
profile.wanted.warrants[].kindstring
profile.wanted.warrants[].liststring
profile.wanted.warrants[].numberstring

footprint ​

CampoTipoObservação
profile.footprintobject
profile.footprint.devicesobject
profile.footprint.devices.countinteger
profile.footprint.devices.maxSharedDocumentsinteger
profile.footprint.devices.sharedinteger
profile.footprint.firstSeenAtstring
profile.footprint.linkedListedmap<string, integer>
profile.footprint.listedobject
profile.footprint.listed.sincestring
profile.footprint.listed.typestring
profile.footprint.selfieobject
profile.footprint.selfie.sharedDocumentsinteger