BASE — https://api.livoapp.com.br/v2/
Produção
REST API · Produção

Livo Integration API

API RESTful para integração com o sistema de gestão de condomínios Livo. Autenticação via Bearer token em todas as rotas.

REST · JSON Bearer Token HTTPS only 7 endpoints
🔐

Autenticação

Como autenticar

Envie o hash token no header Authorization de todas as requisições. Sem token → 401 UNAUTHORIZED.

Header obrigatório

Authorization: Bearer {hash_token}
Content-Type: application/json
GET /enderecos
Listar Endereços

Retorna todos os endereços (unidades) vinculados ao condomínio autenticado. Use o KEY_ENDERECO retornado para consultar usuários ou atualizar adimplência.

Headers

NomeTipoReq.Descrição
AuthorizationstringSimBearer {hash_token}
Requisição
GET /v2/enderecos HTTP/1.1 Authorization: Bearer {hash_token} Host: api.livoapp.com.br
200 OK
200
{ "RESULT": true, "DADOS": [ { "KEY_ENDERECO": "df414da934be43253f...", "ENDERECO": "RUA, SANTOS, 200", "NUMERO": "200", "LOGRADOURO": "SANTOS", "KEY_LOGRADOURO":"44b4735416d69a296...", "TORRE": "RUA", "KEY_TORRE": "617e5792e3353a349...", "LIMITE_INTEGRANTE": null, "INTEGRADOR": null, "QUANTIDADE_INTEGRANTES": "0", "DESATIVAR": true } ] }
GET /enderecos/{key}/usuarios
Usuários do Endereço

Retorna moradores e membros vinculados a uma unidade. O {key} é o KEY_ENDERECO retornado em /enderecos. Use o PRIVATE_KEY_USUARIO ao criar visitas.

Path Parameters

NomeTipoReq.Descrição
keystringSimKEY_ENDERECO da unidade
Requisição
GET /v2/enderecos/df414da.../usuarios HTTP/1.1 Authorization: Bearer {hash_token} Host: api.livoapp.com.br
200 OK
200
{ "RESULT": true, "DADOS": [ { "PRIVATE_KEY_USUARIO": "4f92bd17b7366b0c3e...", "NOME_USUARIO": "Fulano de Tal", "URL_USUARIO": "https://url.jpg", "EMAIL_USUARIO": "email@email.com", "TELEFONE_USUARIO": "11900000000", "BLOQUEIO": false, "NIVEL": "TITULAR", "HASH_NIVEL": "ca14c53608cc44abc...", "TIPO": "PROPRIETARIO", "HASH_TIPO": "a41b1537b0a1dd63c...", "INTEGRADOR": null, "ENVIAR_WPP": true } ] }
GET /tipos-pessoas
Categorias de Pessoas

Retorna categorias disponíveis para visitas temporárias (Visitante, Prestador de Serviço, Funcionário). Use o HASH_TIPO no campo tipo_pessoa ao criar uma visita temporária.

Requisição
GET /v2/tipos-pessoas HTTP/1.1 Authorization: Bearer {hash_token} Host: api.livoapp.com.br
200 OK
200
[ { "HASH_TIPO": "263b9814d438c6981...", "TIPO": "Visitante" }, { "HASH_TIPO": "f1c831978181bd42f...", "TIPO": "Prestador de Serviço" }, { "HASH_TIPO": "1c81022dae5345805...", "TIPO": "Funcionário" } ]
POST /visita-temporaria
Criar Visita Temporária

Cria ou atualiza uma visita temporária autorizada no período determinado. Use cpf para nacionais ou passaporte + estrangeiro: "1" para estrangeiros.

Body · application/json

CampoTipoReq.Descrição
nomestringSimNome completo
enderecostringSimKEY_ENDERECO da unidade
usuariostringSimPRIVATE_KEY_USUARIO do morador
data_inistringSimInício: YYYY-MM-DD HH:MM
data_fimstringSimFim: YYYY-MM-DD HH:MM
tipo_pessoastringSimHASH_TIPO de /tipos-pessoas
cpfstringCond.CPF (estrangeiro = "0")
passaportestringCond.Passaporte (estrangeiro = "1")
estrangeirostringNão"0" nacional / "1" estrangeiro
emailstringNãoE-mail
telefonestringNãoTelefone
placastringNãoPlaca do veículo
rgstringNãoRG
imagemstringNãoFoto base64 (data:image/jpeg;base64,...)
Requisição
POST /v2/visita-temporaria HTTP/1.1 Content-Type: application/json Authorization: Bearer {hash_token} Host: api.livoapp.com.br { "nome": "Jose da Silva", "email": "jose@email.com", "telefone": "11900000000", "cpf": "00000000000", "placa": "AAA9A99", "estrangeiro": "0", "endereco": "fed4e544f7a28c8b2b26...", "usuario": "a85eca6e1b5d39a5921b...", "data_ini": "2025-01-01 11:00", "data_fim": "2025-01-31 16:00", "tipo_pessoa": "263b9814d438c6981...", "imagem": "data:image/jpeg;base64,/9j.." }
201 Created 400 / 500
201
{ "RESULT": true, "INFO": "Temporario Atualizado", "CONVITE": "Você recebeu o link de cadastro...", "KEY_TEMPORARIO": "dedf198d2e3306d9ad198397..." }
POST /acesso-visita
Registrar Visita + Acesso

Registra uma visita e informa o acesso: acesso: "E" para entrada, acesso: "S" para saída. A imagem (foto) é obrigatória.

Body · application/json

CampoTipoReq.Descrição
nomestringSimNome completo
imagemstringSimFoto base64 (data:image/jpeg;base64,...)
enderecostringSimKEY_ENDERECO da unidade
usuariostringSimPRIVATE_KEY_USUARIO do morador
datastringSimYYYY-MM-DD HH:MM
acessostringSim"E" = entrada · "S" = saída
cpfstringCond.CPF (estrangeiro = "0")
passaportestringCond.Passaporte (estrangeiro = "1")
estrangeirostringNão"0" ou "1". Padrão "0"
emailstringNãoE-mail
telefonestringNãoTelefone
placastringNãoPlaca do veículo
rgstringNãoRG
Requisição
POST /v2/acesso-visita HTTP/1.1 Content-Type: application/json Authorization: Bearer {hash_token} Host: api.livoapp.com.br { "nome": "Jose da Silva", "email": "jose@email.com", "telefone": "11900000000", "cpf": "00000000000", "placa": "AAA9A99", "acesso": "E", "estrangeiro": "0", "endereco": "fed4e544f7a28c8b2b26...", "usuario": "a85eca6e1b5d39a5921b...", "data": "2025-01-01 08:30", "imagem": "data:image/jpeg;base64,/9j.." }
201 Created 400 / 500
201
{ "RESULT": true, "NOME": "Jose da Silva", "INFO": "Visitante ENTROU/SAIU" }
PATCH /enderecos/{key}
Atualizar Adimplência

Define o status de adimplência de um endereço. Envie "adimplente" para regularizar ou "inadimplente" para bloquear a unidade.

Path Parameters

CampoTipoReq.Descrição
keystringSimKEY_ENDERECO da unidade

Body · application/json

CampoTipoReq.Valores aceitos
compliancestringSim"adimplente" ou "inadimplente"
Adimplente Inadimplente
PATCH /v2/enderecos/0c6cb9b7c23c24... HTTP/1.1 Content-Type: application/json Authorization: Bearer {hash_token} Host: api.livoapp.com.br { "compliance": "adimplente" }
200 OK 400 / 500
200
{ "RESULT": true, "INFO": "Status adimplencia atualizado" }