Modelo de Dados (Payload)

As seguintes informações são os campos que compõem uma unidade imobiliária e podem ou não ser fornecidas de acordo com as regras de obrigatoriedade de cada UI. Importante: O payload deve ser enviado compactado (sem quebras de linha desnecessárias) e UTF‑8. O campo codigoIbge passou a ser informado através da URL dos serviços da API desde a versão posterior a 1.4 desse manual operacional.

DadosGeraisImovel

Campo	Descrição	Formato	Obrigatoriedade
inscricaoImobiliaria	Código de identificação do imóvel na base municipal	string (até 45 caracteres)	Obrigatório
tipoImovel	Classificação do tipo do imóvel (1 = territorial, 2 = predial, 3 = outro)	inteiro	Obrigatório Ver tabela de domínio
tpArquitetonico	Tipo arquitetônico da edificação (ex.: casa, apartamento, sala)	inteiro	Se tipoImovel = 1 → Não deve ser informado Se tipoImovel = 2 → Obrigatório Se tipoImovel = 3 → Opcional Quando tipoImovel = 1 e tpArquitetonico preenchido não recebe CIB Ver tabela de domínio
destinacaoImovel	Destinação do imóvel (1 = residencial, 2 = comercial, 3 = prestação de serviço)	inteiro	Se tipoImovel = 1 → Opcional Caso contrário → Opcional Ver tabela de domínio
areaTerreno	Área total do terreno (m²)	numérico - 12 inteiros + 4 decimais	Obrigatório
areaConstruida	Área total construída (m²)	numérico - 12 inteiros + 4 decimais	Se tipoImovel = 1 → Não deve ser informado Se tipoImovel = 2 → Obrigatório Se tipoImovel = 3 → Opcional Quando tipoImovel = 1 e areaConstruida preenchida, não recebe CIB
idParcela	Identificador da parcela/lote	string (até 35 caracteres)	Opcional Se tipoImovel = 2 → Obrigatório Se tipoImovel = 1 e informado → Falha
anoConstrutivo	Ano de construção do imóvel	inteiro (4 digitos)	Quando tipoImovel = 1 e anoConstrutivo preenchido, gera uma mensagem de Falha
valorVenal	Valor venal do imóvel	numérico - 18 inteiros + 2 decimais	Opcional
dtUltimoValorVenal	Data da última atualização do valor venal	YYYY‑MM‑DD	Opcional
padraoConstrutivo	Padrão construtivo (ex.: popular, baixo, normal, alto, luxo)	inteiro	Opcional Ver tabela de domínio
qtdGaragem	Quantidade de garagens	inteiro (até 3 digitos)	Opcional
temPiscina	Indica se há piscina	boolean (true/false)	Opcional
valorRefMercado	Valor de referência de mercado	numérico - 18 inteiros + 2 decimais	Opcional
dataUltVlrMercado	Data da última atualização do valor de mercado	YYYY‑MM‑DD	Opcional
bice	Bens imóveis de características especiais	inteiro (até 4 digitos)	Obrigatório se tipoImovel = 3 Campo renomeado em relação ao SINTER 1.0
temBairro	Indica se há divisão política (bairro)	boolean (true/false)	Obrigatório

AreaConstruidaCompl

Não preenchida para tipoImovel=1, sendo opcional para tipoImovel=2 ou 3.

Campo	Descrição	Formato	Obrigatoriedade
areaPrivativa	Área de uso exclusivo	numérico - 12 inteiros + 4 decimais	Opcional
areaComum	Área de uso comum	numérico - 12 inteiros + 4 decimais	Opcional
fraIdeal	Fração ideal do terreno	numérico - 1 inteiro + 4 decimais	Opcional

EnderecoImovel

Campo	Descrição	Formato	Obrigatoriedade
numeroImovel	Número do imóvel	string (até 8 caracteres)	Opcional
complNroImovel	Complemento do número	string (até 30 caracteres)	Opcional
complEndereco	Complemento adicional do endereço	string (até 30 caracteres)	Opcional
tipoLogradouro	Tipo do logradouro (ex.: rua, avenida, travessa)	inteiro	Obrigatório Ver tabela de domínio
nomeLogradouro	Nome oficial do logradouro	string (até 300 caracteres)	Obrigatório
bairro	Bairro / divisão política	string (até 30 caracteres)	Obrigatório se temBairro = true
cep	Código de Endereçamento Postal	string (8 dígitos)	Obrigatório

Titular (lista)

Campo	Descrição	Formato	Obrigatoriedade
niTitular	CPF (11 dígitos) ou CNPJ (14 dígitos) do titular	numérico	Opcional
nomeTitular	Nome completo do titular	string (até 300 caracteres)	Opcional
percTitular	Percentual de participação	numérico - 1 inteiro + 4 decimais	Se niTitular ou nomeTitular preenchido
dtAquisicaoTitular	Data da aquisição	YYYY‑MM‑DD	Se niTitular ou nomeTitular preenchido
tipoTitularidade	Tipo de titularidade (domínio)	inteiro	Se niTitular ou nomeTitular preenchido
docTitularidade	Documento de titularidade (domínio)	inteiro	Se niTitular ou nomeTitular preenchido

ServicoRegistroImovel

Campo	Descrição	Formato	Obrigatoriedade
nomeServentiaRI	Nome da serventia	string (até 300 caracteres)	Opcional
cnsRI	Código Nacional da Serventia	inteiro (6 digitos)	Opcional (se informado, nomeServentiaRI pode ser omitido)
cnmRI	Código nacional da matrícula	string (16 caracteres)	Opcional (se informado, os demais campos podem ser dispensados). Porém se não informado o cnmRI, para caracterizar a informação de Registro de Imóvel é necessário combinar todos os demais campos. CNM: CCCCCC.L.NNNNNNN-DD, onde: 1) CCCCCC - identifica do CNS (cinco ou seis dígitos); 2) L - identifica o Livro de registro nº 2 e tem valor '2'; 3) NNNNNNN - identifica o nº de ordem da matrícula da matrícula no Lv nº2 (sete dígitos); 4) DD - dígitos verificadores, calculados pelo algorítmo Módulo 97 Base 10, conforme Norma ISO 7064:2003. Adequado para 16 dígitos (Código do CNS corrigido para SEIS dígitos, conforme CNM - Provimento 143 CNJ. 2025/03/19)
numMatriculaRI	Número da matrícula	string (até 15 caracteres)	Opcional
numUltimoAtoRI	Número do último ato	string (7 caracteres)	Opcional
lvCartRI	Livro cartorial	string (até 4 caracteres)	Opcional
flCartRI	Folha do livro	string (até 4 caracteres)	Opcional
dtUltAtualizacao	Data da última atualização	YYYY‑MM‑DD	Opcional

CartorioNotas

Campo	Descrição	Formato	Obrigatoriedade
nomeServentiaNotas	Nome da serventia	string (até 300 caracteres)	Opcional
cnsNotas	Código Nacional da Serventia	inteiro (6 digitos)	Opcional Para caracterizar as informações de Cartório de Notas é necessário informar cnsNotas (preferencialmente) ou nomeServentiaNotas e os dois outros campos: lvCartNotas e flCartNotas.
lvCartNotas	Livro do cartório	string (até 4 caracteres)	Opcional
flCartNotas	Folha do cartório	string (até 4 caracteres)	Opcional

ITBI (Devem ser informados os dados da última transação)

O preenchimento dos dados de ITBI é opcional. No entanto, caso informado valor para algum campo, o preenchimento dos demais passa a ser obrigatório (inclusive deve conter ao menos um Transmitente e um Adquirente).

Campo	Descrição	Formato	Obrigatoriedade
baseCalculITBI	Base de cálculo do ITBI	numérico - 18 inteiros + 2 decimais	Opcional
valorRefITBI	Valor de referência de ITBI	numérico - 18 inteiros + 2 decimais	Opcional
dtTransacaoITBI	Data da transação	YYYY‑MM‑DD	Opcional
tpTransacaoITBI	Tipo da transação	inteiro (2 digitos)	Opcional
percTransacionadoITBI	Percentual transacionado	numérico - 1 inteiro + 6 decimais	Opcional

Transmitentes ITBI (lista)

Campo	Descrição	Formato
nomeTransmitenteITBI	Nome do transmitente	string (até 300 caracteres)
idTransmitenteITBI	CPF (11 dígitos) ou CNPJ (14 dígitos)	numérico

Adquirentes ITBI (lista)

Campo	Descrição	Formato
nomeAdquirenteITBI	Nome do adquirente	string (até 300 caracteres)
idAdquirenteITBI	CPF (11 dígitos) ou CNPJ (14 dígitos)	numérico
percTransacAdquirenteITBI	Percentual do imóvel adquirido	numérico - 1 inteiro + 6 decimais