Startvex API

Documentacao viva da API. Esta pagina e gerada a partir dos endpoints anotados nos controllers e deve permanecer alinhada ao codigo em producao.

URL base local http://127.0.0.1/API_STARTVEX/
URL base de producao https://api.startvex.com/
Regra de ativacao Codigo de 6 digitos, expira em 15 minutos e e enviado por email.

Endpoints

GET /api/v1/account/capabilities Consultar capacidades da conta Retorna o plano efetivo da conta, limites, consumo atual e permissoes de acao. A API permanece como autoridade final para cada limite suportado. Ver detalhes Ocultar

Retorna o plano efetivo da conta, limites, consumo atual e permissoes de acao. A API permanece como autoridade final para cada limite suportado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Authentication is required.

Campos da resposta

Campo Tipo Descricao
account object Authenticated user current account or workspace.
plan object Effective active subscription plan.
capabilities object Limits, usage and action permissions by resource.
POST /api/v1/auth/forgot-password Solicitar codigo de recuperacao de senha Recebe um email e envia um codigo de recuperacao de 8 caracteres quando a conta ativa existe. O codigo expira em 15 minutos. Ver detalhes Ocultar

Recebe um email e envia um codigo de recuperacao de 8 caracteres quando a conta ativa existe. O codigo expira em 15 minutos.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
email string Sim Email cadastrado do usuario.

Respostas

Status Descricao
200 Solicitacao de recuperacao de senha processada.
422 Falha de validacao no payload enviado.
503 Falha de envio SMTP.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
reset_code_expires_in_minutes integer Validade do codigo de recuperacao de senha em minutos.
POST /api/v1/auth/login Autenticar usuario com email e senha Valida as credenciais de um usuario ativo, atualiza o ultimo acesso, zera a sequencia de tentativas invalidas, gera um novo token e retorna o perfil. Ver detalhes Ocultar

Valida as credenciais de um usuario ativo, atualiza o ultimo acesso, zera a sequencia de tentativas invalidas, gera um novo token e retorna o perfil.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
email string Sim Email cadastrado do usuario.
password string Sim Senha do usuario.

Respostas

Status Descricao
200 Autenticacao concluida e dados do usuario retornados.
401 Email ou senha invalidos.
403 Usuario existe, mas nao esta ativo.
422 Falha de validacao no payload enviado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
access_token string Token da sessao autenticada atual.
access_token_expires_at string Data/hora UTC de expiracao do access token.
user.id integer Identificador do usuario.
user.name string Nome completo do usuario.
user.username string|null Username publico do usuario.
user.email string Email do usuario.
user.profile_image_path string|null Caminho no servidor para a imagem de perfil do usuario.
user.bio string|null Biografia curta do perfil do usuario.
user.skills array Skills do perfil do usuario.
user.website_url string|null URL do site ou link de perfil do usuario.
user.twitter_url string|null URL ou handle do X/Twitter do usuario.
user.github_url string|null URL ou handle do GitHub do usuario.
user.instagram_url string|null URL ou handle do Instagram do usuario.
user.country string|null Pais do usuario.
user.timezone string|null Timezone do usuario.
user.wallet_address string|null Endereco da wallet do usuario.
user.app_language string|null Idioma preferido da aplicacao.
user.date_format_region string|null Regiao preferida para formatacao de datas.
user.theme string|null Tema preferido da aplicacao.
user.notify_mev_protection boolean Indica se notificacoes de protecao MEV estao habilitadas.
user.notify_bug_report boolean Indica se notificacoes de bug report estao habilitadas.
user.notify_milestone_update boolean Indica se notificacoes de atualizacao de milestones estao habilitadas.
user.notify_governance_proposal boolean Indica se notificacoes de novas propostas de governanca estao habilitadas.
user.notify_team_changes boolean Indica se notificacoes de entrada e saida do time estao habilitadas.
user.notify_price_alert boolean Indica se notificacoes de alerta de preco estao habilitadas.
user.notify_vesting_event boolean Indica se notificacoes de eventos de vesting estao habilitadas.
user.notify_investment_round boolean Indica se notificacoes de novas rodadas de investimento estao habilitadas.
user.notify_assigned_task boolean Indica se notificacoes de tarefas atribuidas estao habilitadas.
user.notify_evidence_result boolean Indica se notificacoes de resultado de evidencias estao habilitadas.
user.notify_deal_room_activity boolean Indica se notificacoes de atividade na deal room estao habilitadas.
user.notify_social_activity boolean Indica se notificacoes de atividade social estao habilitadas.
user.notify_weekly_digest boolean Indica se notificacoes de resumo semanal estao habilitadas.
user.notify_two_factor_activation boolean Indica se notificacoes de seguranca de ativacao 2FA estao habilitadas.
user.hide_public_profile boolean Indica se o perfil publico esta oculto.
user.hide_from_searches boolean Indica se o usuario esta oculto em buscas.
user.anonymous_deal_room_mode boolean Indica se o modo anonimo esta habilitado em deal rooms.
user.hide_token_balance boolean Indica se o saldo de tokens esta oculto.
user.hide_smart_company_participation boolean Indica se a participacao em SmartCompany esta oculta.
user.registered_at string Data/hora UTC de cadastro.
user.last_access_at string|null Data/hora UTC do ultimo login valido.
user.password_changed_at string|null Data/hora UTC da ultima alteracao de senha.
user.invalid_access_count_before_last_access integer Tentativas invalidas registradas imediatamente antes do ultimo login valido.
user.activated_at string|null Data/hora UTC de ativacao.
user.status string Status do usuario.
POST /api/v1/auth/logout Invalidar o token autenticado atual Invalida o bearer token e encerra a sessao autenticada. Ver detalhes Ocultar

Invalida o bearer token e encerra a sessao autenticada.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
access_token string Sim Token da sessao autenticada atual, enviado somente no header Authorization Bearer.

Respostas

Status Descricao
200 Logout concluido e token invalidado.
422 Falha de validacao no payload enviado.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
POST /api/v1/auth/reset-password Redefinir senha esquecida Valida o codigo de recuperacao de 8 caracteres, atualiza a senha e revoga as sessoes ativas do usuario. Ver detalhes Ocultar

Valida o codigo de recuperacao de 8 caracteres, atualiza a senha e revoga as sessoes ativas do usuario.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
email string Sim Email cadastrado do usuario.
reset_code string Sim Codigo de recuperacao de senha de 8 caracteres recebido por email.
new_password string Sim Nova senha a armazenar com seguranca.

Respostas

Status Descricao
200 Senha atualizada com sucesso e sessoes ativas revogadas.
422 Falha de validacao ou codigo de recuperacao invalido/expirado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
POST /api/v1/auth/validate-token Validar o token autenticado atual Valida o bearer token e o email. Quando ambos pertencem a mesma sessao ativa, a API renova a sessao; se o token pertencer a outro email, a sessao e expirada. Ver detalhes Ocultar

Valida o bearer token e o email. Quando ambos pertencem a mesma sessao ativa, a API renova a sessao; se o token pertencer a outro email, a sessao e expirada.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
email string Sim Email que deve pertencer ao dono do token.
access_token string Sim Token da sessao autenticada atual, enviado somente no header Authorization Bearer.

Respostas

Status Descricao
200 Token e email validos; sessao renovada e dados do usuario retornados.
422 Falha de validacao no payload enviado.
401 Token ausente, invalido, expirado ou email divergente.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
access_token_expires_at string Data/hora UTC de expiracao apos renovacao.
user.id integer Identificador do usuario.
user.name string Nome completo do usuario.
user.username string|null Username publico do usuario.
user.email string Email do usuario.
user.profile_image_path string|null Caminho no servidor para a imagem de perfil do usuario.
user.bio string|null Biografia curta do perfil do usuario.
user.skills array Skills do perfil do usuario.
user.website_url string|null URL do site ou link de perfil do usuario.
user.twitter_url string|null URL ou handle do X/Twitter do usuario.
user.github_url string|null URL ou handle do GitHub do usuario.
user.instagram_url string|null URL ou handle do Instagram do usuario.
user.country string|null Pais do usuario.
user.timezone string|null Timezone do usuario.
user.wallet_address string|null Endereco da wallet do usuario.
user.app_language string|null Idioma preferido da aplicacao.
user.date_format_region string|null Regiao preferida para formatacao de datas.
user.theme string|null Tema preferido da aplicacao.
user.notify_mev_protection boolean Indica se notificacoes de protecao MEV estao habilitadas.
user.notify_bug_report boolean Indica se notificacoes de bug report estao habilitadas.
user.notify_milestone_update boolean Indica se notificacoes de atualizacao de milestones estao habilitadas.
user.notify_governance_proposal boolean Indica se notificacoes de novas propostas de governanca estao habilitadas.
user.notify_team_changes boolean Indica se notificacoes de entrada e saida do time estao habilitadas.
user.notify_price_alert boolean Indica se notificacoes de alerta de preco estao habilitadas.
user.notify_vesting_event boolean Indica se notificacoes de eventos de vesting estao habilitadas.
user.notify_investment_round boolean Indica se notificacoes de novas rodadas de investimento estao habilitadas.
user.notify_assigned_task boolean Indica se notificacoes de tarefas atribuidas estao habilitadas.
user.notify_evidence_result boolean Indica se notificacoes de resultado de evidencias estao habilitadas.
user.notify_deal_room_activity boolean Indica se notificacoes de atividade na deal room estao habilitadas.
user.notify_social_activity boolean Indica se notificacoes de atividade social estao habilitadas.
user.notify_weekly_digest boolean Indica se notificacoes de resumo semanal estao habilitadas.
user.notify_two_factor_activation boolean Indica se notificacoes de seguranca de ativacao 2FA estao habilitadas.
user.hide_public_profile boolean Indica se o perfil publico esta oculto.
user.hide_from_searches boolean Indica se o usuario esta oculto em buscas.
user.anonymous_deal_room_mode boolean Indica se o modo anonimo esta habilitado em deal rooms.
user.hide_token_balance boolean Indica se o saldo de tokens esta oculto.
user.hide_smart_company_participation boolean Indica se a participacao em SmartCompany esta oculta.
user.registered_at string Data/hora UTC de cadastro.
user.last_access_at string|null Data/hora UTC do ultimo login valido.
user.password_changed_at string|null Data/hora UTC da ultima alteracao de senha.
user.invalid_access_count_before_last_access integer Tentativas invalidas registradas imediatamente antes do ultimo login valido.
user.activated_at string|null Data/hora UTC de ativacao.
user.status string Status do usuario.
GET /api/v1/feed Listar posts do feed Retorna posts publicos do feed, opcionalmente filtrados por parametros de consulta. Ver detalhes Ocultar

Retorna posts publicos do feed, opcionalmente filtrados por parametros de consulta.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.

Campos da resposta

Campo Tipo Descricao
posts array Posts do feed.
posts[].id integer Identificador do post.
posts[].title string Titulo do post.
posts[].content string Conteudo do post.
posts[].author object Dados do autor do post.
posts[].created_at string Data/hora de criacao.
POST /api/v1/feed/post Criar post no feed Cria um post no feed para o usuario autenticado. Exige a permissao Publicar no Pulse quando o post aponta para uma SmartCompany. Ver detalhes Ocultar

Cria um post no feed para o usuario autenticado. Exige a permissao Publicar no Pulse quando o post aponta para uma SmartCompany.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
title string Sim Titulo do post.
content string Sim Conteudo do post.
smart_company_id integer Nao Identificador da SmartCompany alvo.

Respostas

Status Descricao
201 Criacao concluida com sucesso.
422 Falha de validacao no payload enviado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
post.id integer Identificador do post.
POST /api/v1/feed/{postId}/like Alternar curtida no post do feed Adiciona ou remove curtida de um post do feed para o usuario autenticado. Ver detalhes Ocultar

Adiciona ou remove curtida de um post do feed para o usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Alternancia concluida com sucesso.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
GET /api/v1/health Verificar saude da API Retorna um payload simples de status para monitoramento e verificacoes de conectividade. Ver detalhes Ocultar

Retorna um payload simples de status para monitoramento e verificacoes de conectividade.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 A API esta saudavel.

Campos da resposta

Campo Tipo Descricao
status string Status de saude.
timestamp string Data/hora UTC do health check.
GET /api/v1/pages Listar configuracao publica de paginas Retorna paginas publicas visiveis e paginas privadas vinculadas ao plano ativo do usuario autenticado. Paginas startvex_team ficam restritas ao time Startvex. Ver detalhes Ocultar

Retorna paginas publicas visiveis e paginas privadas vinculadas ao plano ativo do usuario autenticado. Paginas startvex_team ficam restritas ao time Startvex.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.

Campos da resposta

Campo Tipo Descricao
pages array Configuracoes publicas de paginas.
pages[].visible string Estado de visibilidade: true, false ou startvex_team.
pages[].public boolean Whether the page is available without a subscription plan link.
pages[].sort_order integer Database-backed display order.
GET /api/v1/smart-companies Listar SmartCompanies visiveis Retorna resumos de SmartCompanies visiveis ao solicitante sem expor dados privados do core. Ver detalhes Ocultar

Retorna resumos de SmartCompanies visiveis ao solicitante sem expor dados privados do core.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
name string Nao Filtrar por nome da empresa.
search string Nao Busca livre nos campos da empresa.
sector string Nao Filtrar por setor.
stage string Nao Filtrar por estagio.
limit integer Nao Numero maximo de registros a retornar.
offset integer Nao Offset para paginacao.
cursor string Nao Cursor para paginacao.

Respostas

Status Descricao
200 Dados retornados com sucesso.
422 Falha de validacao nos parametros de consulta enviados.

Campos da resposta

Campo Tipo Descricao
smart_companies array Resumos visiveis de SmartCompanies.
next_cursor string|null Cursor para a proxima pagina.
POST /api/v1/smart-companies Criar SmartCompany Cria uma SmartCompany e registra o usuário autenticado como membro fundador após aplicar os limites dos planos smartCompanies e teamMembers. Ver detalhes Ocultar

Cria uma SmartCompany e registra o usuário autenticado como membro fundador após aplicar os limites dos planos smartCompanies e teamMembers.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
name string Sim Nome da empresa.
sector string Nao Setor da empresa.
stage string Nao Estagio da empresa.
description string Nao Descricao da empresa.
website string Nao Site da empresa.

Respostas

Status Descricao
201 Criacao concluida com sucesso.
403 The effective account plan limit was reached.
422 Falha de validacao no payload enviado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
smart_company.id integer Identificador da SmartCompany.
GET /api/v1/smart-companies/{id} Consultar contexto da SmartCompany Leitores autorizados recebem os dados da SmartCompany; founders tambem recebem secoes de gestao. Ver detalhes Ocultar

Leitores autorizados recebem os dados da SmartCompany; founders tambem recebem secoes de gestao.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
404 SmartCompany nao encontrada.

Campos da resposta

Campo Tipo Descricao
smart_company object Dados principais da SmartCompany.
participants array Participantes da empresa quando visiveis.
tasks array Tarefas da empresa quando visiveis.
PATCH /api/v1/smart-companies/{id} Atualizar dados principais da SmartCompany Atualiza os dados principais da SmartCompany. Somente um Fundador ou Cofundador ativo da SmartCompany em questão está autorizado. Ver detalhes Ocultar

Atualiza os dados principais da SmartCompany. Somente um Fundador ou Cofundador ativo da SmartCompany em questão está autorizado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
smart_company_id integer Nao Identificador da SmartCompany ao usar payload legado.
name string Nao Nome da empresa.
sector string Nao Setor da empresa.
stage string Nao Estagio da empresa.
description string Nao Descricao da empresa.
website string Nao Site da empresa.

Respostas

Status Descricao
200 Atualizacao concluida com sucesso.
403 Only an active Founder or Co-Founder of the target SmartCompany may update it.
422 Falha de validacao no payload enviado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
smart_company.id integer Identificador da SmartCompany.
GET /api/v1/smart-companies/{id}/participants Listar participantes da SmartCompany Retorna participantes de uma SmartCompany visivel ao solicitante. Exige autenticacao. Ver detalhes Ocultar

Retorna participantes de uma SmartCompany visivel ao solicitante. Exige autenticacao.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
participants array Participantes da SmartCompany.
next_cursor string|null Cursor para a proxima pagina.
POST /api/v1/smart-companies/{id}/participants Adicionar participante da SmartCompany Adiciona um participante à SmartCompany após aplicar o limite de membros da equipe da conta. Exige a permissão Gerir Equipe na SmartCompany. Ver detalhes Ocultar

Adiciona um participante à SmartCompany após aplicar o limite de membros da equipe da conta. Exige a permissão Gerir Equipe na SmartCompany.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
user_id integer Sim Identificador do usuario a adicionar a SmartCompany.
role string Nao Role do participante. Valores aceitos incluem founder, co_founder, core, admin, operator, contributor, advisor, investor e observer.
user_type string Nao Tipo legado de participante.
cargo string Nao Titulo de exibicao ou cargo do participante.
permissions array|string Nao Chaves de permissao explicitas, como array ou string separada por virgulas.
capabilities array|string Nao Alias de permissions.
participation_percentage number Nao Percentual de participacao atribuido ao participante.
equity_percentage number Nao Percentual de equity atribuido ao participante.
governance_weight number Nao Peso de governanca do participante.
state string Nao Estado do participante.

Respostas

Status Descricao
201 Participante adicionado com sucesso.
403 Access denied or the effective account teamMembers limit was reached.
409 Ja existe um participante nao removido para este usuario.
422 Falha de validacao no payload enviado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
participant.id integer Identificador do participante.
participant.role string Role do participante.
participant.state string Estado do participante.
PATCH /api/v1/smart-companies/{id}/participants/{userId} Atualizar papel do participante da SmartCompany Atualiza papel, cargo, alocacao, permissoes ou status de convite do participante. Exige a permissao de gerenciar equipe. Ver detalhes Ocultar

Atualiza papel, cargo, alocacao, permissoes ou status de convite do participante. Exige a permissao de gerenciar equipe.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
role string Nao Role do participante.
member_role string Nao Alias de role usado por alguns clientes.
cargo string Nao Cargo ou titulo do participante.
title string Nao Alias de cargo.
function string Nao Alias de cargo.
function_role string Nao Alias de cargo.
participation_percentage number Nao Percentual de participacao a definir.
allocation_percent number Nao Alias de participation_percentage.
token_allocation number Nao Alias legado do percentual de participacao.
allocation_tokens number Nao Valor de alocacao de tokens.
token_amount number Nao Alias de allocation_tokens.
equity_percentage number Nao Percentual de equity a definir.
permissions array|string Nao Chaves de permissao explicitas.
capabilities array|string Nao Alias de permissions.
state string Nao Estado do participante.

Respostas

Status Descricao
200 Atualizacao concluida com sucesso.
404 Participante nao encontrado.
422 Falha de validacao no payload enviado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
participant.id integer Identificador do participante.
participant.role string Role do participante.
participant.state string Estado do participante.
GET /api/v1/smart-companies/{id}/summary Consultar resumo da SmartCompany Retorna um resumo da SmartCompany seguro para publico. Ver detalhes Ocultar

Retorna um resumo da SmartCompany seguro para publico.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
404 SmartCompany nao encontrada.

Campos da resposta

Campo Tipo Descricao
summary object Resumo seguro para publico.
GET /api/v1/smart-companies/{id}/tokenomics Consultar tokenomics calculada Retorna valores de tokenomics calculados pelo backend. O front-end nao e a fonte de verdade para supply, fees ou alocacoes. Ver detalhes Ocultar

Retorna valores de tokenomics calculados pelo backend. O front-end nao e a fonte de verdade para supply, fees ou alocacoes.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
404 SmartCompany nao encontrada.

Campos da resposta

Campo Tipo Descricao
tokenomics object Projecao calculada de tokenomics.
GET /api/v1/subscriptions/my Consultar assinatura do usuario autenticado Retorna o plano de assinatura atual do usuario autenticado. Ver detalhes Ocultar

Retorna o plano de assinatura atual do usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
subscription object Assinatura do usuario autenticado.
GET /api/v1/system/menus Listar menus visiveis do sistema Retorna menus visiveis ao usuario autenticado. Ver detalhes Ocultar

Retorna menus visiveis ao usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.

Campos da resposta

Campo Tipo Descricao
POST /api/v1/uploads/image Enviar imagem Armazena imagem JPG, PNG ou WEBP e retorna caminho publico para logo, capa ou foto de perfil. Ver detalhes Ocultar

Armazena imagem JPG, PNG ou WEBP e retorna caminho publico para logo, capa ou foto de perfil.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
image/file/logo/logo_image/cover/cover_image/profile/profile_image/avatar file Nao Arquivo binario de imagem.
purpose string Nao Finalidade da imagem, como profile, logo ou cover. Alias: type.
type string Nao Alias de purpose.
data string Nao Dados da imagem em Base64 quando nenhum arquivo e enviado.

Respostas

Status Descricao
201 Upload concluido com sucesso.
422 Falha de validacao ou nenhum dado de imagem foi enviado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
image_path string Caminho publico da imagem.
upload.purpose string Finalidade de imagem resolvida.
upload.field string Nome do campo de origem usado no upload.
POST /api/v1/users/activate Validar e ativar usuario cadastrado Valida o codigo de 6 digitos enviado. Se estiver invalido ou expirado, a API gera e envia novo codigo automaticamente. Ver detalhes Ocultar

Valida o codigo de 6 digitos enviado. Se estiver invalido ou expirado, a API gera e envia novo codigo automaticamente.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
email string Sim Email cadastrado do usuario.
activation_code string Sim Codigo de ativacao de 6 digitos recebido por email.

Respostas

Status Descricao
200 Ativacao concluida com sucesso.
404 Usuario nao encontrado para o email informado.
409 Usuario ja esta ativo.
422 Codigo invalido ou expirado; um novo codigo e enviado automaticamente.
503 Falha de envio SMTP ao reenviar o codigo.

Campos da resposta

Campo Tipo Descricao
user_id integer Identificador do usuario.
username string|null Username publico do usuario.
email string Email cadastrado do usuario.
profile_image_path string|null Caminho no servidor para a imagem de perfil do usuario.
country string|null Pais do usuario.
timezone string|null Timezone do usuario.
wallet_address string|null Endereco da wallet do usuario.
status string Status atual do usuario.
activated_at string Data/hora UTC de ativacao.
message string Mensagem de resultado da operacao.
GET /api/v1/users/contributions Consultar contribuicoes do usuario autenticado Retorna historico de contribuicoes e participacao em tarefas do usuario autenticado. Ver detalhes Ocultar

Retorna historico de contribuicoes e participacao em tarefas do usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
GET /api/v1/users/favorites Listar SmartCompanies favoritas Retorna SmartCompanies favoritas do usuario autenticado. Ver detalhes Ocultar

Retorna SmartCompanies favoritas do usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
favorites array SmartCompanies favoritas.
favorites[].id integer Identificador da SmartCompany.
favorites[].name string Nome da SmartCompany.
favorites[].slug string|null Slug da SmartCompany.
favorites[].sector string|null Setor da SmartCompany.
favorites[].stage string|null Estagio da SmartCompany.
favorites[].status string|null Status da SmartCompany.
POST /api/v1/users/favorites/{id}/toggle Alternar favorito da SmartCompany Adiciona ou remove uma SmartCompany dos favoritos do usuario autenticado. Ver detalhes Ocultar

Adiciona ou remove uma SmartCompany dos favoritos do usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Alternancia concluida com sucesso.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
GET /api/v1/users/me Consultar perfil do usuario autenticado Retorna o perfil completo do usuario ativo autenticado. O token deve ser enviado no header Authorization Bearer. Ver detalhes Ocultar

Retorna o perfil completo do usuario ativo autenticado. O token deve ser enviado no header Authorization Bearer.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.
422 Falha de validacao no payload enviado.

Campos da resposta

Campo Tipo Descricao
POST /api/v1/users/me Consultar perfil do usuario autenticado Retorna o perfil completo do usuario ativo autenticado. O token deve ser enviado no header Authorization Bearer. Ver detalhes Ocultar

Retorna o perfil completo do usuario ativo autenticado. O token deve ser enviado no header Authorization Bearer.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.
422 Falha de validacao no payload enviado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
user.id integer Identificador do usuario.
user.name string Nome completo do usuario.
user.username string|null Username publico do usuario.
user.email string Email do usuario.
user.profile_image_path string|null Caminho no servidor para a imagem de perfil do usuario.
user.bio string|null Biografia curta do perfil do usuario.
user.skills array Skills do perfil do usuario.
user.website_url string|null URL do site ou link de perfil do usuario.
user.twitter_url string|null URL ou handle do X/Twitter do usuario.
user.github_url string|null URL ou handle do GitHub do usuario.
user.instagram_url string|null URL ou handle do Instagram do usuario.
user.country string|null Pais do usuario.
user.timezone string|null Timezone do usuario.
user.wallet_address string|null Endereco da wallet do usuario.
user.app_language string|null Idioma preferido da aplicacao.
user.date_format_region string|null Regiao preferida para formatacao de datas.
user.theme string|null Tema preferido da aplicacao.
user.notify_mev_protection boolean Indica se notificacoes de protecao MEV estao habilitadas.
user.notify_bug_report boolean Indica se notificacoes de bug report estao habilitadas.
user.notify_milestone_update boolean Indica se notificacoes de atualizacao de milestones estao habilitadas.
user.notify_governance_proposal boolean Indica se notificacoes de novas propostas de governanca estao habilitadas.
user.notify_team_changes boolean Indica se notificacoes de entrada e saida do time estao habilitadas.
user.notify_price_alert boolean Indica se notificacoes de alerta de preco estao habilitadas.
user.notify_vesting_event boolean Indica se notificacoes de eventos de vesting estao habilitadas.
user.notify_investment_round boolean Indica se notificacoes de novas rodadas de investimento estao habilitadas.
user.notify_assigned_task boolean Indica se notificacoes de tarefas atribuidas estao habilitadas.
user.notify_evidence_result boolean Indica se notificacoes de resultado de evidencias estao habilitadas.
user.notify_deal_room_activity boolean Indica se notificacoes de atividade na deal room estao habilitadas.
user.notify_social_activity boolean Indica se notificacoes de atividade social estao habilitadas.
user.notify_weekly_digest boolean Indica se notificacoes de resumo semanal estao habilitadas.
user.notify_two_factor_activation boolean Indica se notificacoes de seguranca de ativacao 2FA estao habilitadas.
user.hide_public_profile boolean Indica se o perfil publico esta oculto.
user.hide_from_searches boolean Indica se o usuario esta oculto em buscas.
user.anonymous_deal_room_mode boolean Indica se o modo anonimo esta habilitado em deal rooms.
user.hide_token_balance boolean Indica se o saldo de tokens esta oculto.
user.hide_smart_company_participation boolean Indica se a participacao em SmartCompany esta oculta.
user.registered_at string Data/hora UTC de cadastro.
user.last_access_at string|null Data/hora UTC do ultimo login valido.
user.password_changed_at string|null Data/hora UTC da ultima alteracao de senha.
user.invalid_access_count_before_last_access integer Tentativas invalidas registradas imediatamente antes do ultimo login valido.
user.activated_at string|null Data/hora UTC de ativacao.
user.status string Status do usuario.
PATCH /api/v1/users/me/active-company Manter usuário autenticado ativo SmartCompany Armazena a última SmartCompany selecionada pelo usuário autenticado após validar a propriedade ou a participação ativa. Ver detalhes Ocultar

Armazena a última SmartCompany selecionada pelo usuário autenticado após validar a propriedade ou a participação ativa.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
smart_company_id integer Sim SmartCompany selected by the authenticated user.

Respostas

Status Descricao
200 Active SmartCompany persisted successfully.
401 Token ausente, invalido ou expirado.
403 SmartCompany is not owned by or actively associated with the user.
422 Invalid SmartCompany identifier.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
active_company_id integer Persisted SmartCompany identifier.
GET /api/v1/users/me/assigned-tasks Listar tarefas atribuidas ao usuario autenticado Retorna tarefas de SmartCompanies atribuidas ao usuario autenticado. Ver detalhes Ocultar

Retorna tarefas de SmartCompanies atribuidas ao usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
GET /api/v1/users/me/companies Listar SmartCompanies do usuario autenticado Retorna SmartCompanies criadas pelo usuario ou associadas a ele. Ver detalhes Ocultar

Retorna SmartCompanies criadas pelo usuario ou associadas a ele.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
companies array SmartCompanies owned by or actively associated with the authenticated user.
active_company_id integer|null Last accessible SmartCompany selected by the user, or the first available company as fallback.
next_cursor string|null Cursor para a proxima pagina, quando existir.
GET /api/v1/users/me/investments Listar investimentos do usuario autenticado Retorna investimentos sandbox do usuario autenticado. Ver detalhes Ocultar

Retorna investimentos sandbox do usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
investments array Investimentos do usuario autenticado.
GET /api/v1/users/me/ledger Listar ledger do usuario autenticado Retorna entradas append-only de ledger derivadas das tabelas reais de wallet, token, reward, investimento e ledger do usuario. Ver detalhes Ocultar

Retorna entradas append-only de ledger derivadas das tabelas reais de wallet, token, reward, investimento e ledger do usuario.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
ledger array Lancamentos normalizados do ledger do usuario.
summary.balance_usd number Saldo liquido em USD representado pelos lancamentos de ledger.
summary.tokens_by_company array Saldos de tokens agrupados por SmartCompany.
next_cursor string|null Cursor para a proxima pagina, quando existir.
GET /api/v1/users/me/rewards Listar rewards do usuario autenticado Retorna o ledger append-only de rewards do usuario autenticado. Ver detalhes Ocultar

Retorna o ledger append-only de rewards do usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
rewards array Lancamentos do ledger de rewards.
GET /api/v1/users/me/transactions Listar transacoes do usuario autenticado Retorna historico de transacoes derivado de tokens, rewards, investimentos, eventos de wallet e ledger do usuario. Ver detalhes Ocultar

Retorna historico de transacoes derivado de tokens, rewards, investimentos, eventos de wallet e ledger do usuario.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
transactions array Transacoes normalizadas do usuario.
next_cursor string|null Cursor para a proxima pagina, quando existir.
GET /api/v1/users/me/wallet Consultar status da wallet do usuario Retorna o status atual da wallet e enfileira provisioning quando ainda nao existe wallet ou job. Ver detalhes Ocultar

Retorna o status atual da wallet e enfileira provisioning quando ainda nao existe wallet ou job.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.
422 Falha de validacao no payload enviado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
wallet_status.status string Status da wallet.
wallet_status.wallet_address string|null Endereco da wallet, se disponivel.
wallet_status.wallet_provider string Nome do provider da wallet.
wallet_status.provider_wallet_id string|null Identificador da wallet no provider.
wallet_status.chain_type string|null Tipo de chain da wallet.
wallet_status.job_id integer|null Identificador do job de provisioning atual.
POST /api/v1/users/me/wallet/provision Enfileirar provisioning de wallet do usuario Cria ou reutiliza um job de provisioning sem duplicar a wallet. O usuario permanece ativo se o provider falhar. Ver detalhes Ocultar

Cria ou reutiliza um job de provisioning sem duplicar a wallet. O usuario permanece ativo se o provider falhar.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
action string Estado da acao enfileirada ou concluida.
job_status string Status do job de provisioning.
job_id integer Identificador do job de provisioning.
wallet_status.status string Status da wallet.
GET /api/v1/users/me/wallet/yields Listar rendimentos da wallet do usuario Retorna rendimentos persistidos da wallet do usuario autenticado. Quando nao ha registros, retorna dados vazios. Ver detalhes Ocultar

Retorna rendimentos persistidos da wallet do usuario autenticado. Quando nao ha registros, retorna dados vazios.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
yields array Lancamentos de rendimento da wallet.
summary.total_usd number Rendimento total em USD representado pelos registros retornados.
summary.total_tokens number Rendimento total em tokens representado pelos registros retornados.
next_cursor string|null Cursor para a proxima pagina, quando existir.
GET /api/v1/users/notifications Listar notificacoes do usuario autenticado Retorna notificacoes do usuario autenticado. Ver detalhes Ocultar

Retorna notificacoes do usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
POST /api/v1/users/notifications/read Marcar notificacoes do usuario como lidas Marca todas as notificacoes do usuario autenticado como lidas. Ver detalhes Ocultar

Marca todas as notificacoes do usuario autenticado como lidas.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Notificacoes marcadas como lidas.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
POST /api/v1/users/notifications/{notificationId}/read Marcar notificacao como lida Marca uma notificacao como lida para o usuario autenticado. Ver detalhes Ocultar

Marca uma notificacao como lida para o usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Notificacao marcada como lida.
404 Notificacao nao encontrada.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
GET /api/v1/users/portfolio Consultar portfolio do usuario autenticado Retorna dados de tokens, investimentos e SmartCompanies do usuario autenticado. Ver detalhes Ocultar

Retorna dados de tokens, investimentos e SmartCompanies do usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
POST /api/v1/users/register Criar nova conta de usuario Registra uma conta inativa, salva a senha com seguranca e envia codigo de ativacao de 6 digitos por email. Ver detalhes Ocultar

Registra uma conta inativa, salva a senha com seguranca e envia codigo de ativacao de 6 digitos por email.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
name string Sim Nome completo do usuario.
username string Nao Username publico do usuario.
email string Sim Email unico do usuario.
profile_image_path string Nao Caminho no servidor para a imagem de perfil do usuario.
bio string Nao Biografia curta do perfil do usuario.
skills array|string Nao Skills do perfil do usuario como array, array JSON ou string separada por virgulas.
website_url string Nao URL do site ou link de perfil do usuario. Alias: website.
twitter_url string Nao URL ou handle do X/Twitter do usuario. Alias: twitter.
github_url string Nao URL ou handle do GitHub do usuario. Alias: github.
instagram_url string Nao URL ou handle do Instagram do usuario. Alias: instagram.
country string Nao Pais do usuario.
timezone string Nao Timezone do usuario.
wallet_address string Nao Endereco da wallet do usuario.
password string Sim Senha em texto puro; a API armazena apenas hash seguro.

Respostas

Status Descricao
201 Usuario criado com sucesso e codigo de ativacao enviado.
200 Usuario inativo atualizado e novo codigo de ativacao enviado.
409 Ja existe um usuario ativo para o email informado.
409 Username ja esta em uso por outro usuario.
422 Falha de validacao no payload enviado.
503 Falha de envio SMTP.

Campos da resposta

Campo Tipo Descricao
user_id integer Identificador do usuario.
username string|null Username publico do usuario.
email string Email cadastrado do usuario.
profile_image_path string|null Caminho no servidor para a imagem de perfil do usuario.
bio string|null Biografia curta do perfil do usuario.
skills array Skills do perfil do usuario.
website_url string|null URL do site ou link de perfil do usuario.
twitter_url string|null URL ou handle do X/Twitter do usuario.
github_url string|null URL ou handle do GitHub do usuario.
instagram_url string|null URL ou handle do Instagram do usuario.
country string|null Pais do usuario.
timezone string|null Timezone do usuario.
wallet_address string|null Endereco da wallet do usuario.
status string Status atual do usuario.
activation_expires_at string Data/hora UTC de expiracao do codigo de ativacao atual.
message string Mensagem de resultado da operacao.
GET /api/v1/users/reputation Consultar reputacao do usuario autenticado Retorna informacoes de reputacao e build score do usuario autenticado. Ver detalhes Ocultar

Retorna informacoes de reputacao e build score do usuario autenticado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
GET /api/v1/users/search Buscar usuarios Busca usuarios visiveis por nome ou email usando o parametro de consulta q. O email e usado apenas como criterio de busca e nunca e retornado. Ver detalhes Ocultar

Busca usuarios visiveis por nome ou email usando o parametro de consulta q. O email e usado apenas como criterio de busca e nunca e retornado.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
q string Nao Termo de busca; menos de 2 caracteres retornam um array users vazio.

Respostas

Status Descricao
200 Dados retornados com sucesso.
401 Token ausente, invalido ou expirado.

Campos da resposta

Campo Tipo Descricao
users array Usuarios encontrados.
users[].id integer Identificador do usuario.
users[].name string|null Nome de exibicao do usuario.
users[].avatar_url string|null Alias do caminho publico da imagem de perfil.
users[].profile_image_path string|null Public profile image path.
users[].reputation_score integer Pontuacao de reputacao do usuario.
POST /api/v1/users/update Atualizar perfil do usuario autenticado Atualiza campos editaveis do perfil do usuario ativo autenticado. O token deve ser enviado no header Authorization Bearer. Ver detalhes Ocultar

Atualiza campos editaveis do perfil do usuario ativo autenticado. O token deve ser enviado no header Authorization Bearer.

Campos da requisicao

Campo Tipo Obrigatorio Descricao
name string Nao Nome completo do usuario.
username string Nao Username publico do usuario. Envie string vazia para limpar.
profile_image_path string Nao Caminho no servidor para a imagem de perfil do usuario. Envie string vazia para limpar.
bio string Nao Biografia curta do perfil do usuario. Envie string vazia para limpar.
skills array|string Nao Skills do perfil do usuario como array, array JSON ou string separada por virgulas. Envie array vazio ou string vazia para limpar.
website_url string Nao URL do site ou link de perfil do usuario. Alias: website. Envie string vazia para limpar.
twitter_url string Nao URL ou handle do X/Twitter do usuario. Alias: twitter. Envie string vazia para limpar.
github_url string Nao URL ou handle do GitHub do usuario. Alias: github. Envie string vazia para limpar.
instagram_url string Nao URL ou handle do Instagram do usuario. Alias: instagram. Envie string vazia para limpar.
country string Nao Pais do usuario. Envie string vazia para limpar.
timezone string Nao Timezone do usuario. Envie string vazia para limpar.
wallet_address string Nao Endereco da wallet do usuario. Envie string vazia para limpar.
app_language string Nao Idioma preferido da aplicacao. Envie string vazia para limpar.
date_format_region string Nao Regiao preferida para formatacao de datas. Envie string vazia para limpar.
theme string Nao Tema preferido da aplicacao. Envie string vazia para limpar.
notify_mev_protection boolean Nao Ativa ou desativa notificacoes de protecao MEV.
notify_bug_report boolean Nao Ativa ou desativa notificacoes de bug report.
notify_milestone_update boolean Nao Ativa ou desativa notificacoes de atualizacao de milestones.
notify_governance_proposal boolean Nao Ativa ou desativa notificacoes de novas propostas de governanca.
notify_team_changes boolean Nao Ativa ou desativa notificacoes de entrada e saida do time.
notify_price_alert boolean Nao Ativa ou desativa notificacoes de alerta de preco.
notify_vesting_event boolean Nao Ativa ou desativa notificacoes de eventos de vesting.
notify_investment_round boolean Nao Ativa ou desativa notificacoes de novas rodadas de investimento.
notify_assigned_task boolean Nao Ativa ou desativa notificacoes de tarefas atribuidas.
notify_evidence_result boolean Nao Ativa ou desativa notificacoes de resultado de evidencias.
notify_deal_room_activity boolean Nao Ativa ou desativa notificacoes de atividade na deal room.
notify_social_activity boolean Nao Ativa ou desativa notificacoes de atividade social.
notify_weekly_digest boolean Nao Ativa ou desativa notificacoes de resumo semanal.
notify_two_factor_activation boolean Nao Ativa ou desativa notificacoes de seguranca de ativacao 2FA.
hide_public_profile boolean Nao Oculta ou exibe o perfil publico.
hide_from_searches boolean Nao Oculta ou exibe o usuario em buscas.
anonymous_deal_room_mode boolean Nao Ativa ou desativa modo anonimo em deal rooms.
hide_token_balance boolean Nao Oculta ou exibe saldo de tokens.
hide_smart_company_participation boolean Nao Oculta ou exibe participacao em SmartCompany.

Respostas

Status Descricao
200 Atualizacao concluida com sucesso.
409 Username ja esta em uso por outro usuario.
401 Token ausente, invalido ou expirado.
422 Falha de validacao ou nenhum campo atualizavel foi enviado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
user.id integer Identificador do usuario.
user.name string Nome completo do usuario.
user.username string|null Username publico do usuario.
user.email string Email do usuario.
user.profile_image_path string|null Caminho no servidor para a imagem de perfil do usuario.
user.bio string|null Biografia curta do perfil do usuario.
user.skills array Skills do perfil do usuario.
user.website_url string|null URL do site ou link de perfil do usuario.
user.twitter_url string|null URL ou handle do X/Twitter do usuario.
user.github_url string|null URL ou handle do GitHub do usuario.
user.instagram_url string|null URL ou handle do Instagram do usuario.
user.country string|null Pais do usuario.
user.timezone string|null Timezone do usuario.
user.wallet_address string|null Endereco da wallet do usuario.
user.app_language string|null Idioma preferido da aplicacao.
user.date_format_region string|null Regiao preferida para formatacao de datas.
user.theme string|null Tema preferido da aplicacao.
user.notify_mev_protection boolean Indica se notificacoes de protecao MEV estao habilitadas.
user.notify_bug_report boolean Indica se notificacoes de bug report estao habilitadas.
user.notify_milestone_update boolean Indica se notificacoes de atualizacao de milestones estao habilitadas.
user.notify_governance_proposal boolean Indica se notificacoes de novas propostas de governanca estao habilitadas.
user.notify_team_changes boolean Indica se notificacoes de entrada e saida do time estao habilitadas.
user.notify_price_alert boolean Indica se notificacoes de alerta de preco estao habilitadas.
user.notify_vesting_event boolean Indica se notificacoes de eventos de vesting estao habilitadas.
user.notify_investment_round boolean Indica se notificacoes de novas rodadas de investimento estao habilitadas.
user.notify_assigned_task boolean Indica se notificacoes de tarefas atribuidas estao habilitadas.
user.notify_evidence_result boolean Indica se notificacoes de resultado de evidencias estao habilitadas.
user.notify_deal_room_activity boolean Indica se notificacoes de atividade na deal room estao habilitadas.
user.notify_social_activity boolean Indica se notificacoes de atividade social estao habilitadas.
user.notify_weekly_digest boolean Indica se notificacoes de resumo semanal estao habilitadas.
user.notify_two_factor_activation boolean Indica se notificacoes de seguranca de ativacao 2FA estao habilitadas.
user.hide_public_profile boolean Indica se o perfil publico esta oculto.
user.hide_from_searches boolean Indica se o usuario esta oculto em buscas.
user.anonymous_deal_room_mode boolean Indica se o modo anonimo esta habilitado em deal rooms.
user.hide_token_balance boolean Indica se o saldo de tokens esta oculto.
user.hide_smart_company_participation boolean Indica se a participacao em SmartCompany esta oculta.
user.registered_at string Data/hora UTC de cadastro.
user.last_access_at string|null Data/hora UTC do ultimo login valido.
user.password_changed_at string|null Data/hora UTC da ultima alteracao de senha.
user.invalid_access_count_before_last_access integer Tentativas invalidas registradas imediatamente antes do ultimo login valido.
user.activated_at string|null Data/hora UTC de ativacao.
user.status string Status do usuario.
GET /api/v1/users/{id} Consultar perfil publico de usuario Retorna perfil publico e informacoes de contribuicao de um usuario. Ver detalhes Ocultar

Retorna perfil publico e informacoes de contribuicao de um usuario.

Campos da requisicao

Campo Tipo Obrigatorio Descricao

Respostas

Status Descricao
200 Dados retornados com sucesso.
404 Usuario nao encontrado.

Campos da resposta

Campo Tipo Descricao
message string Mensagem de resultado da operacao.
user.id integer Identificador do usuario.
user.name string Nome completo do usuario.
user.username string|null Username publico do usuario.

A documentacao atual e gerada ao ler atributos PHP nos controllers da API.