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-2-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 2.0 · Pessoa

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.


Entidade	Pessoa (CPF, `entity: pf`)
Módulo	`profile`
Versão	`2.0` (mais recente)
Dataset	`person-profile-2.0`
Execução	Sempre 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

Campo	Tipo	Observação
`dataset`	`string`	sempre `person-profile-2.0`
`module`	`string`	sempre `profile`
`profile`	`object`	os dados do módulo (abaixo)
`rules`	`array<object>`	os indicadores avaliados pelo dataset (abaixo)

Dados

`identification`

Campo	Tipo	Observação
`profile.exists`	`boolean`
`profile.name`	`string`
`profile.gender`	`string`
`profile.birthDate`	`string`	date
`profile.nationality`	`string`
`profile.isForeign`	`boolean`
`profile.origin`	`string`
`profile.isDeceased`	`boolean`
`profile.politicallyExposed`	`boolean`
`profile.parents.mother`	`string`
`profile.parents.father`	`string`
`profile.parents.motherConfirmed`	`boolean`
`profile.alternativeIds.socialSecurity`	`string`

`taxStatus`

Campo	Tipo	Observação
`profile.taxId.number`	`string`
`profile.taxId.status`	`string`
`profile.taxId.statusDate`	`string`	date
`profile.taxId.origin`	`string`
`profile.taxId.country`	`string`
`profile.taxId.fiscalRegion`	`string`

`record`

Campo	Tipo	Observação
`profile.record.createdAt`	`string`	date
`profile.record.updatedAt`	`string`	date

`contactPhones`

Campo	Tipo	Observação
`profile.contacts.phones.oldestPassageAt`	`string`	date
`profile.contacts.phones.newestPassageAt`	`string`	date
`profile.contacts.phones.items`	`array<object>`
`profile.contacts.phones.items[].active`	`boolean`
`profile.contacts.phones.items[].areaCode`	`string`
`profile.contacts.phones.items[].carrier`	`string`
`profile.contacts.phones.items[].confirmations`	`integer`
`profile.contacts.phones.items[].countryCode`	`string`
`profile.contacts.phones.items[].doNotCall`	`boolean`
`profile.contacts.phones.items[].lastSeenAt`	`string`	date
`profile.contacts.phones.items[].main`	`boolean`
`profile.contacts.phones.items[].number`	`string`
`profile.contacts.phones.items[].planType`	`string`
`profile.contacts.phones.items[].preferred`	`boolean`
`profile.contacts.phones.items[].type`	`string`

`contactEmails`

Campo	Tipo	Observação
`profile.contacts.emails.oldestPassageAt`	`string`	date
`profile.contacts.emails.newestPassageAt`	`string`	date
`profile.contacts.emails.items`	`array<object>`
`profile.contacts.emails.items[].active`	`boolean`
`profile.contacts.emails.items[].address`	`string`
`profile.contacts.emails.items[].confirmations`	`integer`
`profile.contacts.emails.items[].domain`	`string`
`profile.contacts.emails.items[].lastSeenAt`	`string`	date
`profile.contacts.emails.items[].main`	`boolean`
`profile.contacts.emails.items[].preferred`	`boolean`
`profile.contacts.emails.items[].type`	`string`
`profile.contacts.emails.items[].validationStatus`	`string`

`contactAddresses`

Campo	Tipo	Observação
`profile.contacts.addresses.oldestPassageAt`	`string`	date
`profile.contacts.addresses.newestPassageAt`	`string`	date
`profile.contacts.addresses.items`	`array<object>`
`profile.contacts.addresses.items[].active`	`boolean`
`profile.contacts.addresses.items[].city`	`string`
`profile.contacts.addresses.items[].complement`	`string`
`profile.contacts.addresses.items[].confirmations`	`integer`
`profile.contacts.addresses.items[].country`	`string`
`profile.contacts.addresses.items[].lastSeenAt`	`string`	date
`profile.contacts.addresses.items[].main`	`boolean`
`profile.contacts.addresses.items[].neighborhood`	`string`
`profile.contacts.addresses.items[].number`	`string`
`profile.contacts.addresses.items[].preferred`	`boolean`
`profile.contacts.addresses.items[].state`	`string`
`profile.contacts.addresses.items[].street`	`string`
`profile.contacts.addresses.items[].type`	`string`
`profile.contacts.addresses.items[].zipCode`	`string`

Indicadores (`rules`)

Campo	Tipo	Observação
`rules[].evidence`	`object`	Os dados que sustentam o indicador, quando disparou.
`rules[].fired`	`boolean`	`true` quando o indicador se aplica aos dados.
`rules[].magnitude`	`number`	Intensidade do achado, quando ele tem uma (ex.: uma contagem ou um valor).
`rules[].notApplicable`	`boolean`	`true` 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[].reason`	`string`	Por que o indicador não pôde ser avaliado (com `notApplicable`).
`rules[].rule`	`string`	`PROFILE_PERSON_DECEASED`, `PROFILE_PERSON_IRREGULAR_STATUS` — Nome do indicador.

Indicadores publicados por este dataset:

PROFILE_PERSON_DECEASED
PROFILE_PERSON_IRREGULAR_STATUS