API Reference

Verificar Existência de Usuário

Descrição: Este endpoint verifica a existência de um usuário no sistema a partir de seu ID, retornando informações essenciais de identificação e status de serviço caso o usuário seja encontrado.

Descrição dos Campos de Resposta

CampoDescriçãoTipoExemplo
_idIdentificador único do usuário.String"user123abc456def789ghi000000"
usernameNome de usuário.String"usuario.exemplo"
documentsLista de documentos associados ao usuário.Array[ {...} ]
documents[]._idIdentificador único do documento.String"doc123abc456def789ghi000000"
documents[].typeTipo do documento (e.g., CPF, RG).String"CPF"
documents[].numberNúmero do documento.String"12345678900"
emailE-mail do usuário.String"[email protected]"
statusStatus do usuário, incluindo posição atual, último login e informações de serviço.Objeto{...}
status.positionPosição geográfica atual do usuário.Objeto{...}
status.position.latLatitude da posição (Praça da Sé, SP).Float-23.55052
status.position.lngLongitude da posição (Praça da Sé, SP).Float-46.633308
status.position.dateData e hora da última atualização de posição.String (ISO)"2024-10-31T12:44:06.482Z"
status.position.deviceInformações sobre o dispositivo usado pelo usuário.Objeto{...}
status.position.device.batteryEstado da bateria do dispositivo.Objeto{...}
status.position.device.battery.levelNível da bateria em porcentagem.Integer45
status.position.device.battery.pluggedIndica se o dispositivo está conectado à energia.Booleanfalse
status.position.device._idIdentificador único do dispositivo.String"device123abc456def789ghi000000"
status.position.device.uuidUUID do dispositivo.String"uuid123abc456def789ghi000000"
status.position.device.connection_typeTipo de conexão de rede do dispositivo (e.g., wifi, mobile).String"wifi"
status.position.device.app_versionVersão do aplicativo instalada no dispositivo.String"2.29.15"
status.last_loginDados do último login do usuário.Objeto{...}
status.last_login.dateData e hora do último login.String (ISO)"2024-10-30T17:50:22.236Z"
status.last_login.deviceInformações sobre o dispositivo usado no último login.Objeto{...}
status.last_login.device._idIdentificador único do dispositivo de login.String"device987654321000abc123456"
status.last_login.device.ip_addressEndereço IP do dispositivo durante o login.String"192.168.1.1"
status.last_login.device.user_agentInformações do navegador ou sistema operacional do dispositivo.String"Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
status.on_dutyIndica se o usuário está em serviço (on duty).Objeto{...}
status.on_duty.valueStatus de serviço do usuário (true = em serviço).Booleantrue
status.on_duty.updated_atData e hora da última atualização do status de serviço.String (ISO)"2024-03-06T14:20:27.745Z"
firstNamePrimeiro nome do usuário.String"João"
lastNameSobrenome do usuário.String"Silva"
Language
Click Try It! to start a request and see the response here!