Pessoas

Consulta e manutenção do cadastro de pessoas.

👥

Sobre esta seção

Cadastrar e consultar as pessoas do convênio: clientes, proprietários, fiadores e demais contatos. É a base para vincular gente aos imóveis e aos atendimentos.

Escopos: leitura com pessoas:read, escrita com pessoas:write

Regras que valem para toda a seção:

RegraO que significa
🪪 Física ou jurídicaUma pessoa pode ser PF ou PJ, deduzido do document (11 dígitos = CPF, 14 = CNPJ).
🏷️ Tipos por nome, do catálogoTipos de contato (phoneTypes, emailTypes, addressTypes) e de relação (relationshipTypes) vão por nome, de GET /schema/lookups. Os tipos derivados do vínculo real (Locador, Locatário, Fiador, Comprador, Vendedor, Construtora) não podem ser atribuídos na mão: aparecem sozinhos quando o vínculo existe.
🔁 Formato simétricoO que o GET /{id} devolve é o mesmo formato que o PUT aceita.