Parâmetros
São dois valores possíveis: “email” ou “cpf”, que o sistema utilizará para buscar o usuário.
Email ou CPF do usuário desejado, de acordo com o valor definido em “by”.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
by obrigatório: Tipo de busca, podendo ser ‘email’ ou ‘cpf’.
value obrigatório: Valor a ser buscado, dependendo do tipo de busca escolhido.
Descrição da Resposta
Abaixo está um exemplo da resposta retornada por este endpoint.
Detalhes do perfil do usuário. Identificador único do usuário.
Identificador Universal Único (UUID) do usuário.
Nome completo do usuário.
Endereço de e-mail do usuário.
CPF (Cadastro de Pessoa Física) do usuário.
Data e hora de criação do usuário.
Data e hora da última atualização do perfil.
Data e hora da última atividade do usuário.
Informações da escola. Identificador único da escola.
Detalhes do endereço do usuário. Identificador único do endereço.
ID de referência do endereço.
Número da residência ou apartamento.
Complemento do endereço (ex: apartamento, andar).
Lista de perguntas e respostas personalizadas. Identificador único da pergunta.
Resposta do usuário à pergunta.
Lista de instituições associadas ao usuário. Identificador único da instituição.
Subdomínio da instituição.
Segurança
Para acessar este endpoint, é necessário enviar um token de acesso válido por meio do cabeçalho de autorização (Authorization) da requisição.
Além disso, a API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.