Guia · Cadastrar pessoas

👥
O que este guia faz
Cadastrar e consultar as pessoas do convênio: clientes, proprietários, fiadores e demais contatos.
Escopos: escrita com pessoas:write, leitura com pessoas:read

🪪 Física ou jurídica: deduzido do documento

📘
Você não envia o tipo da pessoa
O tipo é deduzido do document: 11 dígitos = pessoa física (CPF), 14 = pessoa jurídica (CNPJ). Os campos específicos de cada tipo (ex.: birthDate para PF, tradeName para PJ) são ignorados quando não se aplicam.

➕ Incluir uma pessoa

O mínimo é name + document:

curl -X POST https://api.imoviewnext.com.br/pub/v1/people \
  -H "Authorization: Bearer imn_seuconvenio_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ana Souza",
    "document": "12345678901",
    "classification": 5,
    "phones": [{ "number": "31999990000", "type": "Celular" }],
    "emails": [{ "email": "[email protected]" }]
  }'

Campos úteis:

Campo	Observação
`name`	obrigatório
`document`	obrigatório; define PF/PJ
`classification`	1 a 5 (opcional)
`phones`	lista de `{ number, type? }`
`emails`	lista de `{ email, type? }`
`addresses`	lista de `{ street, number?, neighborhood?, city?, zipCode?, type? }`
`relationshipTypes`	lista de nomes (ver abaixo)

🏷️ Tipos por nome, do catálogo

Os tipos de contato (type em phones/emails/addresses) e os relationshipTypes vão por nome, e os nomes válidos vêm de GET /schema/lookups.

🚧
Tipos derivados não podem ser atribuídos na mão
Em relationshipTypes, os tipos que o produto deriva de um vínculo real (Locador, Locatário, Fiador, Comprador, Vendedor, Construtora) aparecem sozinhos quando o vínculo existe: não os envie manualmente. Use apenas os tipos marcados como atribuíveis no GET /schema/lookups.

🔎 Evite duplicar: busque antes

Antes de criar, procure se a pessoa já existe (por documento, nome ou contato):

curl -X POST https://api.imoviewnext.com.br/pub/v1/people/search \
  -H "Authorization: Bearer imn_seuconvenio_..." \
  -H "Content-Type: application/json" \
  -d '{ "document": "12345678901" }'

✏️ Alterar e ler

Alterar: PUT /people/{id} aceita o mesmo formato do POST.
Ler: GET /people/{id} devolve a pessoa no mesmo formato.
Etiquetas: POST e DELETE /people/{id}/tags/{tagId}, com pessoas:write.

🔒
A porta dos dados pessoais
Documento, telefone, e-mail e endereço só saem por GET /people/{id} e POST /people/search, com pessoas:read. Os outros objetos (atendimento, proprietário do imóvel, locador do contrato) trazem só o id da pessoa.