Documentacao Startvex API

POST

/api/v1/admin/api-endpoint-categories

Criar categoria de endpoints da API

Cria uma categoria reutilizavel para organizar endpoints gerenciados da API. Exige super_admin.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`name`	string	Sim	Nome unico da categoria com 2 a 80 caracteres.

Respostas

Status	Descricao
201	Criacao concluida com sucesso.
403	Acesso negado.
409	Category already exists.
422	Invalid category name.

Campos da resposta

Campo	Tipo	Descricao
`category.id`	integer	Identificador da categoria criada.
`category.name`	string	Nome da categoria criada.

GET

/api/v1/admin/api-endpoints

List and synchronize managed API endpoints

Returns the endpoint catalog and operational classifications. Requires super_admin.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
403	Acesso negado.

Campos da resposta

Campo	Tipo	Descricao

PATCH

/api/v1/admin/api-endpoints/{id}

Classify a managed API endpoint

Altera a disponibilidade e a categoria do endpoint e registra uma observacao opcional. Exige super_admin.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`status`	string	Sim	One of active, inactive or obsolete.
`category_id`	integer\|null	Nao	Identificador da categoria ou null para remover a categorizacao.
`observation`	string	Nao	Administrative note stored in history.
`replacement_path`	string	Nao	Suggested replacement for an obsolete endpoint.

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
403	Acesso negado.
422	Invalid classification.

Campos da resposta

Campo	Tipo	Descricao

GET

/api/v1/admin/api-endpoints/{id}/history

Retrieve API endpoint classification history

Returns classification changes, observations and responsible users. Requires super_admin.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
403	Acesso negado.
404	Endpoint not found.

Campos da resposta

Campo	Tipo	Descricao

GET

/api/v1/admin/companies

Listar SmartCompanies para admin

Retorna dados de administracao de SmartCompanies para admins.

Ver detalhes Ocultar detalhes

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	Lista administrativa de empresas.

PATCH

/api/v1/admin/companies/{id}

Atualizar SmartCompany como admin

Atualiza status, verificacao ou visibilidade publica da SmartCompany como operacao admin.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`status`	string	Nao	Status da empresa.
`verified`	boolean	Nao	Flag de verificacao.
`is_public`	boolean	Nao	Flag de visibilidade publica.

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`company.id`	integer	Identificador da empresa.

GET

/api/v1/admin/fees

Listar configuracoes de fee para admin

Retorna todas as configuracoes de fee, incluindo inativas, para admins.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.

Campos da resposta

Campo	Tipo	Descricao
`fees`	array	Todas as linhas de fees.

PATCH

/api/v1/admin/fees/{key}

Atualizar configuracao de fee como admin

Atualiza uma configuracao de fee da plataforma como operacao admin.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`value`	number	Nao	Valor da fee.
`enabled`	boolean	Nao	Indica se a fee esta ativa.

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`fee.key`	string	Chave da fee.

GET

/api/v1/admin/pages

Listar configuracao de paginas para admin

Retorna todas as configuracoes de paginas para admins, incluindo ocultas e startvex_team.

Ver detalhes Ocultar detalhes

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
`pages`	array	Todas as configuracoes de paginas.
`pages[].visible`	string	Estado de visibilidade: true, false ou startvex_team.

PATCH

/api/v1/admin/pages/{identifier}

Atualizar configuracao de pagina como admin

Atualiza uma configuracao de pagina por id, chave ou caminho como operacao admin.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`visible`	string	Nao	Estado de visibilidade. Valores aceitos: true, false, startvex_team.
`published`	boolean	Nao	Alias legado de visible.

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`page.id`	integer	Identificador da pagina.

POST

/api/v1/admin/read-models/rebuild

Reconstruir read models

Reconstroi read models para todos os escopos ou para um usuario/empresa especifico.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`scope`	string	Nao	Escopo opcional da reconstrucao.
`user_id`	integer	Nao	Limita reconstrucao a um usuario.
`smart_company_id`	integer	Nao	Limita reconstrucao a uma empresa.

Respostas

Status	Descricao
200	Reconstrucao concluida com sucesso.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

GET

/api/v1/admin/stats

Consultar estatisticas administrativas da plataforma

Retorna estatisticas agregadas da plataforma para usuarios admin.

Ver detalhes Ocultar detalhes

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
`stats`	object	Estatisticas administrativas.

GET

/api/v1/admin/system/menus

Listar menus do sistema para admin

Retorna todos os menus do sistema para usuarios admin da Startvex.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
403	Acesso negado.

Campos da resposta

Campo	Tipo	Descricao

PATCH

/api/v1/admin/system/menus/{id}

Atualizar menu do sistema

Atualiza um campo editavel de menu do sistema.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
403	Acesso negado.

Campos da resposta

Campo	Tipo	Descricao

GET

/api/v1/admin/treasury

Listar lancamentos de tesouraria da plataforma

Retorna lancamentos de tesouraria da plataforma para admins.

Ver detalhes Ocultar detalhes

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
`entries`	array	Lancamentos de tesouraria.

GET

/api/v1/admin/users

Listar usuarios para admin

Retorna dados de administracao de usuarios para admins.

Ver detalhes Ocultar detalhes

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
`users`	array	Lista administrativa de usuarios.

DELETE

/api/v1/admin/users/{userId}

Excluir usuario como admin

Exclui ou desativa um usuario por operacao admin.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Exclusao concluida com sucesso.
404	Usuario nao encontrado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

PATCH

/api/v1/admin/users/{userId}

Atualizar usuario como admin

Atualiza perfil, role, plano ou status de um usuario como operacao admin.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`name`	string	Nao	Nome completo do usuario.
`email`	string	Nao	Email do usuario.
`role`	string	Nao	Role do usuario.
`status`	string	Nao	Status do usuario.
`plan`	string	Nao	Chave do plano de assinatura.

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
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.

GET

/api/v1/admin/vaults

Listar vaults de capital para admin

Retorna dados administrativos de vaults de capital para admins.

Ver detalhes Ocultar detalhes

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
`vaults`	array	Lista administrativa de vaults.

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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.

POST

/api/v1/capital/rounds/{roundId}/investment-intents

Criar intencao de investimento

Cria uma intencao de investimento sandbox. Exige Idempotency-Key e pode expirar.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`amount`	number	Sim	Valor do investimento.
`currency`	string	Nao	Codigo da moeda usado na intencao.
`expires_at`	string	Nao	Data/hora de expiracao opcional em ISO 8601.

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.
`intent.id`	integer	Identificador da intencao de investimento.

POST

/api/v1/evidence/uploads

Enviar arquivo de evidencia

Armazena arquivo de evidencia em storage e retorna identificador para associacao posterior com tarefa.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`file`	file	Sim	Arquivo de evidencia para upload.
`smart_company_id`	integer	Nao	Identificador opcional da SmartCompany associada a evidencia.
`task_id`	integer	Nao	Identificador opcional da tarefa associada a evidencia.
`title`	string	Nao	Titulo opcional da evidencia.
`description`	string	Nao	Descricao opcional da evidencia.

Respostas

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

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`upload_id`	integer	Identificador do upload de evidencia.
`storage_key`	string	Chave do arquivo armazenado.

POST

/api/v1/evidence/{evidenceId}/approve

Aprovar evidencia

Aprova a evidencia de forma atomica, emite PoB e deixa o reward pendente.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`reviewer_note`	string	Nao	Nota opcional do revisor.

Respostas

Status	Descricao
200	Aprovacao concluida com sucesso.
404	Evidencia nao encontrada.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

POST

/api/v1/evidence/{evidenceId}/reject

Rejeitar evidencia

Rejeita evidencia com nota do revisor e registra o evento de status da tarefa.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`reviewer_note`	string	Sim	Motivo da rejeicao da evidencia.
`note`	string	Nao	Alias de reviewer_note.

Respostas

Status	Descricao
200	Rejeicao concluida com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

GET

/api/v1/feed

Listar posts do feed

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

Ver detalhes Ocultar detalhes

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 detalhes

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 detalhes

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/fees

Listar fees da plataforma

Retorna configuracoes de fee ativas visiveis aos clientes.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.

Campos da resposta

Campo	Tipo	Descricao
`fees`	array	Fees ativas da plataforma.

POST

/api/v1/fees/calculate

Calcular fee da plataforma

Calcula fees para uma operacao usando a configuracao atual da plataforma.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`amount`	number	Sim	Valor base para calculo da fee.
`key`	string	Nao	Chave opcional da fee a calcular.

Respostas

Status	Descricao
200	Fee calculada com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`fee`	object	Detalhamento da fee calculada.

GET

/api/v1/fees/{key}

Consultar fee da plataforma

Retorna uma configuracao de fee pela chave.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

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

Campos da resposta

Campo	Tipo	Descricao
`fee`	object	Configuracao de fee da plataforma.

GET

/api/v1/health

Verificar saude da API

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

Ver detalhes Ocultar detalhes

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.

POST

/api/v1/investments/{id}/confirm

Confirmar investimento

Confirma um investimento sandbox, congela o snapshot de fees e emite o recibo. Exige Idempotency-Key.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`fee_snapshot`	object	Nao	Payload opcional do snapshot de fee.
`receipt_reference`	string	Nao	Referencia opcional de recibo externo.

Respostas

Status	Descricao
200	Confirmacao concluida com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`investment.id`	integer	Identificador do investimento.

GET

/api/v1/market/open-tasks

Listar tarefas abertas do mercado

Retorna tarefas abertas e sem responsavel de SmartCompanies publicas, agrupadas por empresa.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.

Campos da resposta

Campo	Tipo	Descricao
`companies`	array	Empresas com tarefas abertas.

GET

/api/v1/market/prices

Listar precos de tokens do mercado

Retorna resumos de preco de tokens das SmartCompanies.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.

Campos da resposta

Campo	Tipo	Descricao
`prices`	array	Resumos de precos de mercado.
`prices[].symbol`	string	Simbolo do token.
`prices[].price`	number	Preco atual.
`prices[].change_24h`	number\|null	Variacao em 24 horas.
`prices[].market_cap`	number\|null	Estimativa de market cap.

GET

/api/v1/market/prices/{symbol}

Consultar historico de preco do token

Retorna resumo e historico de preco para um simbolo de token.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
404	Simbolo do token nao encontrado.

Campos da resposta

Campo	Tipo	Descricao
`price`	object	Resumo e historico de preco do token.
`price.symbol`	string	Simbolo do token.
`price.current_price`	number	Preco atual.
`price.history`	array	Pontos historicos de preco.

GET

/api/v1/pages

Listar configuracao publica de paginas

Retorna configuracao publica de paginas para o front-end. Paginas marcadas como startvex_team so aparecem para usuarios autenticados do time Startvex.

Ver detalhes Ocultar detalhes

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.

GET

/api/v1/protocol/actions/{id}

Consultar status da acao de protocolo

Retorna status atual e payload de uma acao de protocolo.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
401	Token ausente, invalido ou expirado.
404	Acao de protocolo nao encontrada para o usuario autenticado.

Campos da resposta

Campo	Tipo	Descricao
`action.id`	integer	Identificador da acao de protocolo.
`action.status`	string	Status atual da acao.
`action.action_type`	string	Tipo da acao de protocolo.
`action.provider`	string	Nome do provider externo.
`action.chain_id`	string\|null	Identificador da chain alvo.
`action.request_payload_json`	object\|null	Payload originalmente enviado para a acao.

POST

/api/v1/rewards/{id}/release

Liberar reward

Libera um reward com protecao por Idempotency-Key e escrita append-only no ledger.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`idempotency_key`	string	Nao	Valor opcional do header Idempotency-Key para referencia.

Respostas

Status	Descricao
200	Liberacao concluida com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

GET

/api/v1/smart-companies

Listar SmartCompanies visiveis

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

Ver detalhes Ocultar detalhes

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 usuario autenticado como founder.

Ver detalhes Ocultar detalhes

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.
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 detalhes

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 dados principais da SmartCompany. Exige a permissao Editar Empresa.

Ver detalhes Ocultar detalhes

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.
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}/capital

Consultar resumo de capital da SmartCompany

Retorna resumo de rodadas de capital, investimentos e vaults da SmartCompany.

Ver detalhes Ocultar detalhes

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
`capital`	object	Dados de resumo de capital.

POST

/api/v1/smart-companies/{id}/capital/close-round

Encerrar rodada de capital da SmartCompany

Encerra a rodada de capital atual conforme permissoes da SmartCompany. Exige a permissao de capital.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`reason`	string	Nao	Motivo opcional de encerramento.

Respostas

Status	Descricao
200	Encerramento concluido com sucesso.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

POST

/api/v1/smart-companies/{id}/capital/create-round

Criar rodada de capital da SmartCompany

Cria uma rodada de capital para a SmartCompany. Exige a permissao de capital.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`target_amount`	number	Nao	Valor alvo da rodada.
`currency`	string	Nao	Codigo da moeda.
`starts_at`	string	Nao	Data/hora inicial opcional em ISO 8601.
`ends_at`	string	Nao	Data/hora final opcional em ISO 8601.

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.
`round.id`	integer	Identificador da rodada de capital.

POST

/api/v1/smart-companies/{id}/capital/invest

Investir em rodada de capital da SmartCompany

Registra um investimento e aplica a fee da plataforma e o fluxo de vault.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`amount`	number	Sim	Valor do investimento.
`currency`	string	Nao	Codigo da moeda.
`round_id`	integer	Nao	Identificador da rodada de capital quando a empresa possui varias rodadas.

Respostas

Status	Descricao
200	Registro concluido com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`investment.id`	integer	Identificador do investimento.

GET

/api/v1/smart-companies/{id}/capital/investors

Listar investidores de capital da SmartCompany

Retorna investidores de uma rodada de capital da SmartCompany.

Ver detalhes Ocultar detalhes

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
`investors`	array	Investidores de capital.

GET

/api/v1/smart-companies/{id}/capital/rounds

Listar rodadas de capital sandbox

Retorna rodadas de capital sandbox. Movimentacao financeira de producao permanece desativada por feature flag.

Ver detalhes Ocultar detalhes

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
`rounds`	array	Rodadas de capital.

POST

/api/v1/smart-companies/{id}/capital/rounds

Criar rodada de capital sandbox

Cria uma rodada de capital sandbox e registra auditoria. Exige Idempotency-Key.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`idempotency_key`	string	Nao	Valor opcional do header Idempotency-Key para referencia.

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.
`round.id`	integer	Identificador da rodada de capital.

GET

/api/v1/smart-companies/{id}/capital/vaults

Listar vaults de capital da SmartCompany

Retorna vaults criados para investimentos da SmartCompany.

Ver detalhes Ocultar detalhes

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
`vaults`	array	Vaults de capital.

POST

/api/v1/smart-companies/{id}/capital/vaults/{vaultId}/refund

Reembolsar fundos de vault de capital

Reembolsa um vault conforme regras da rodada e permissoes. Exige a permissao de capital.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`reason`	string	Nao	Motivo opcional de reembolso.

Respostas

Status	Descricao
200	Reembolso concluido com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

POST

/api/v1/smart-companies/{id}/capital/vaults/{vaultId}/release

Liberar fundos de vault de capital

Libera um vault conforme regras da rodada e permissoes. Exige a permissao de capital.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`reason`	string	Nao	Motivo opcional de liberacao.

Respostas

Status	Descricao
200	Liberacao concluida com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

GET

/api/v1/smart-companies/{id}/council/members

List SmartCompany council members

Returns council members attached to a SmartCompany.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
403	Acesso negado.

Campos da resposta

Campo	Tipo	Descricao

POST

/api/v1/smart-companies/{id}/council/members

Create SmartCompany council member

Creates a council member record for a SmartCompany.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
201	Criacao concluida com sucesso.
422	Validation failed.

Campos da resposta

Campo	Tipo	Descricao

PATCH

/api/v1/smart-companies/{id}/council/members/{participantId}

Update SmartCompany council member

Updates a council member record.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
404	Council member not found.

Campos da resposta

Campo	Tipo	Descricao

GET

/api/v1/smart-companies/{id}/dashboard

Consultar projecao de dashboard da SmartCompany

Retorna apenas campos de dashboard seguros para o front-end.

Ver detalhes Ocultar detalhes

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
`dashboard`	object	Projecao de dashboard.

GET

/api/v1/smart-companies/{id}/deal-room

Listar itens da deal room da SmartCompany

Retorna documentos, propostas, negociacoes e itens de deal room associados a SmartCompany. Quando nao ha registros, retorna dados vazios.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
401	Token ausente, invalido ou expirado.
403	O usuario autenticado nao pode visualizar esta SmartCompany.
404	SmartCompany nao encontrada.

Campos da resposta

Campo	Tipo	Descricao
`deal_room.documents`	array	Registros de documentos.
`deal_room.proposals`	array	Registros de propostas.
`deal_room.negotiations`	array	Registros de negociacao.
`deal_room.items`	array	Todos os registros da deal room.
`next_cursor`	string\|null	Cursor para a proxima pagina, quando existir.

GET

/api/v1/smart-companies/{id}/investors-negotiators

List SmartCompany investor negotiators

Returns investor negotiators attached to a SmartCompany.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
403	Acesso negado.

Campos da resposta

Campo	Tipo	Descricao

POST

/api/v1/smart-companies/{id}/investors-negotiators

Create SmartCompany investor negotiator

Creates an investor negotiator record for a SmartCompany.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
201	Criacao concluida com sucesso.
422	Validation failed.

Campos da resposta

Campo	Tipo	Descricao

DELETE

/api/v1/smart-companies/{id}/investors-negotiators/{participantId}

Delete SmartCompany investor negotiator

Deletes an investor negotiator record.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Exclusao concluida com sucesso.
404	Investor negotiator not found.

Campos da resposta

Campo	Tipo	Descricao

PATCH

/api/v1/smart-companies/{id}/investors-negotiators/{participantId}

Update SmartCompany investor negotiator

Updates an investor negotiator record.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
404	Investor negotiator not found.

Campos da resposta

Campo	Tipo	Descricao

GET

/api/v1/smart-companies/{id}/member-select-options

List SmartCompany member select options

Returns allowed internal member titles and functions for UI selectors.

Ver detalhes Ocultar detalhes

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

GET

/api/v1/smart-companies/{id}/members

List SmartCompany internal members

Returns official internal members for a SmartCompany.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
403	Acesso negado.

Campos da resposta

Campo	Tipo	Descricao

POST

/api/v1/smart-companies/{id}/members

Add SmartCompany internal member

Adds an official internal member. Only CORE_CONTRIBUTOR with ADMIN or MANAGER function can be added after creation.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
201	Member added successfully.
403	Acesso negado.
422	Validation failed.

Campos da resposta

Campo	Tipo	Descricao

DELETE

/api/v1/smart-companies/{id}/members/{memberId}

Remove SmartCompany internal member

Removes a mutable official internal member. FOUNDER, CO_FOUNDER and MASTER are protected.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Member removed successfully.
403	Protected member or access denied.
404	Member not found.

Campos da resposta

Campo	Tipo	Descricao

PATCH

/api/v1/smart-companies/{id}/members/{memberId}

Update SmartCompany internal member

Updates mutable fields of an official internal member.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
403	Acesso negado.
404	Member not found.

Campos da resposta

Campo	Tipo	Descricao

POST

/api/v1/smart-companies/{id}/members/{memberId}/revoke

Revoke SmartCompany internal member nomination

Revokes a pending internal member nomination within its validation window.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Nomination revoked successfully.
403	Access denied or validation window expired.
422	Nomination cannot be revoked.

Campos da resposta

Campo	Tipo	Descricao

GET

/api/v1/smart-companies/{id}/metrics

Consultar metricas da SmartCompany

Retorna metricas de execucao, evidencias, validacao, capital, impacto e coordenacao.

Ver detalhes Ocultar detalhes

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
`metrics`	object	Metricas da SmartCompany.

GET

/api/v1/smart-companies/{id}/milestones

Listar milestones da SmartCompany

Retorna milestones do roadmap de uma SmartCompany.

Ver detalhes Ocultar detalhes

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
`milestones`	array	Milestones da SmartCompany.

POST

/api/v1/smart-companies/{id}/milestones/create

Criar milestone da SmartCompany

Cria uma milestone do roadmap. Exige a permissao de tarefas.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`title`	string	Sim	Titulo da milestone.
`description`	string	Nao	Descricao da milestone.

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.
`milestone.id`	integer	Identificador da milestone.

POST

/api/v1/smart-companies/{id}/milestones/{milestoneId}/complete

Concluir milestone da SmartCompany

Marca uma milestone como concluida. Exige a permissao de tarefas.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Milestone concluida com sucesso.
404	Milestone nao encontrada.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

GET

/api/v1/smart-companies/{id}/open-contributors

List SmartCompany open contributors

Returns external open contributors attached to a SmartCompany.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
403	Acesso negado.

Campos da resposta

Campo	Tipo	Descricao

POST

/api/v1/smart-companies/{id}/open-contributors

Create SmartCompany open contributor

Creates an external open contributor record for a SmartCompany.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
201	Criacao concluida com sucesso.
422	Validation failed.

Campos da resposta

Campo	Tipo	Descricao

PATCH

/api/v1/smart-companies/{id}/open-contributors/{participantId}

Update SmartCompany open contributor

Updates an external open contributor record.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
404	Open contributor not found.

Campos da resposta

Campo	Tipo	Descricao

GET

/api/v1/smart-companies/{id}/participants

Listar participantes da SmartCompany

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

Ver detalhes Ocultar detalhes

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 participante da SmartCompany. Exige a permissao Gerir Equipe.

Ver detalhes Ocultar detalhes

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.
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.

POST

/api/v1/smart-companies/{id}/participants/accept

Aceitar convite da SmartCompany

Aceita o convite do usuario autenticado para a SmartCompany.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Aceite concluido com sucesso.
404	Nenhum convite pendente foi encontrado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

POST

/api/v1/smart-companies/{id}/participants/invite

Convidar participante para a SmartCompany

Cria ou atualiza convite de participante da SmartCompany. Exige a permissao de gerenciar equipe.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`email`	string	Sim	Email do usuario a adicionar ao time da SmartCompany.
`role`	string	Nao	Role do participante. Valores aceitos incluem founder, co_founder, core, admin, operator, contributor, advisor, investor e observer.
`member_role`	string	Nao	Alias de role usado por alguns clientes.
`cargo`	string	Nao	Titulo de exibicao ou cargo 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 do participante.
`allocation_percent`	number	Nao	Alias de participation_percentage.
`token_allocation`	number	Nao	Alias do percentual de participacao em payloads legados.
`allocation_tokens`	number	Nao	Valor de alocacao de tokens.
`token_amount`	number	Nao	Alias de allocation_tokens.
`equity_percentage`	number	Nao	Percentual de equity do participante.
`permissions`	array\|string	Nao	Chaves de permissao explicitas, como array ou string separada por virgulas.
`capabilities`	array\|string	Nao	Alias de permissions.
`state`	string	Nao	Estado do participante. Padrao: active.

Respostas

Status	Descricao
201	Participante adicionado com sucesso.
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.

POST

/api/v1/smart-companies/{id}/participants/remove

Remover participante da SmartCompany

Remove um participante da SmartCompany. Exige a permissao de gerenciar equipe.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`participant_id`	integer	Nao	Chave primaria do registro de participante a remover.
`user_id`	integer	Nao	Identificador do usuario a remover quando participant_id nao for enviado.

Respostas

Status	Descricao
200	Participante removido 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.

DELETE

/api/v1/smart-companies/{id}/participants/{participantId}

Remover participante da SmartCompany

Remove participante da SmartCompany. Exige a permissao Gerir Equipe. O ultimo founder nao pode ser removido.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Participante removido com sucesso.
400	O owner ou ultimo founder nao pode ser removido.
404	Participante nao encontrado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

PATCH

/api/v1/smart-companies/{id}/participants/{participantId}

Atualizar participante da SmartCompany

Atualiza participante da SmartCompany. Exige a permissao Gerir Equipe.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`role`	string	Nao	Role do participante.
`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.
`capabilities`	array\|string	Nao	Alias de permissions.
`participation_percentage`	number	Nao	Percentual de participacao.
`equity_percentage`	number	Nao	Percentual de equity.
`governance_weight`	number	Nao	Peso de governanca.
`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.

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 detalhes

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}/partners

List SmartCompany partners

Returns partners attached to a SmartCompany.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
403	Acesso negado.

Campos da resposta

Campo	Tipo	Descricao

POST

/api/v1/smart-companies/{id}/partners

Create SmartCompany partner

Creates a partner record for a SmartCompany.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
201	Criacao concluida com sucesso.
422	Validation failed.

Campos da resposta

Campo	Tipo	Descricao

DELETE

/api/v1/smart-companies/{id}/partners/{participantId}

Delete SmartCompany partner

Deletes a partner record.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Exclusao concluida com sucesso.
404	Partner not found.

Campos da resposta

Campo	Tipo	Descricao

PATCH

/api/v1/smart-companies/{id}/partners/{participantId}

Update SmartCompany partner

Updates a partner record.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
404	Partner not found.

Campos da resposta

Campo	Tipo	Descricao

GET

/api/v1/smart-companies/{id}/partnerships

Listar parcerias da SmartCompany

Retorna parcerias e convites persistidos associados a SmartCompany. Quando nao ha registros, retorna dados vazios.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
401	Token ausente, invalido ou expirado.
403	O usuario autenticado nao pode visualizar esta SmartCompany.
404	SmartCompany nao encontrada.

Campos da resposta

Campo	Tipo	Descricao
`partnerships`	array	Registros de parcerias e convites.
`summary.by_status`	object	Contagem de parcerias agrupada por status.
`next_cursor`	string\|null	Cursor para a proxima pagina, quando existir.

POST

/api/v1/smart-companies/{id}/protocol/sc-id

Mintar ou enfileirar SC-ID da SmartCompany

Cria uma acao de protocolo idempotente para mint de SC-ID na Polygon Amoy. Se a wallet do solicitante nao existir, retorna o fluxo de provisioning.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`chain`	string	Nao	Nome ou identificador da chain alvo.

Respostas

Status	Descricao
202	Mint de SC-ID enfileirado ou provisioning de wallet retornado.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`protocol_action.id`	integer	Identificador da acao de protocolo.

GET

/api/v1/smart-companies/{id}/rewards

Listar rewards da SmartCompany

Retorna rewards associados a uma SmartCompany.

Ver detalhes Ocultar detalhes

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 de rewards da SmartCompany.

GET

/api/v1/smart-companies/{id}/summary

Consultar resumo da SmartCompany

Retorna um resumo da SmartCompany seguro para publico.

Ver detalhes Ocultar detalhes

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}/tasks

Listar tarefas da SmartCompany

Retorna tarefas da SmartCompany, opcionalmente filtradas pelo parametro status.

Ver detalhes Ocultar detalhes

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
`tasks`	array	Tarefas da SmartCompany.

POST

/api/v1/smart-companies/{id}/tasks/create

Criar tarefa da SmartCompany

Cria uma tarefa com configuracoes de reward e atribuicao. Exige a permissao de tarefas.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`title`	string	Sim	Titulo da tarefa.
`description`	string	Nao	Descricao da tarefa.

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.
`task.id`	integer	Identificador da tarefa.

GET

/api/v1/smart-companies/{id}/tasks/{taskId}

Consultar tarefa da SmartCompany

Retorna uma tarefa e seu historico de evidencias.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

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

Campos da resposta

Campo	Tipo	Descricao
`task`	object	Dados da tarefa da SmartCompany.

POST

/api/v1/smart-companies/{id}/tasks/{taskId}/accept

Aceitar tarefa da SmartCompany

Permite que o usuario autenticado aceite uma tarefa atribuida disponivel.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Aceite concluido com sucesso.
404	Tarefa nao encontrada ou nao atribuida ao usuario.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

POST

/api/v1/smart-companies/{id}/tasks/{taskId}/approve

Aprovar evidencia da tarefa

Aprova a evidencia submetida e completa o fluxo de reward da tarefa. Exige a permissao de tarefas.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Aprovacao concluida com sucesso.
404	Evidencia da tarefa nao encontrada.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

POST

/api/v1/smart-companies/{id}/tasks/{taskId}/assign

Atribuir tarefa da SmartCompany

Atribui uma tarefa a um participante ou contribuidor. Exige a permissao de tarefas.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`user_id`	integer	Sim	Identificador do usuario ao qual atribuir a tarefa.

Respostas

Status	Descricao
200	Atribuicao concluida com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

POST

/api/v1/smart-companies/{id}/tasks/{taskId}/reject

Rejeitar evidencia da tarefa

Rejeita a evidencia submetida e salva a nota do revisor. Exige a permissao de tarefas.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`reviewer_note`	string	Sim	Motivo da rejeicao da evidencia.
`note`	string	Nao	Alias de reviewer_note.

Respostas

Status	Descricao
200	Rejeicao concluida com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

PATCH

/api/v1/smart-companies/{id}/tasks/{taskId}/status

Atualizar status da tarefa

Atualiza o status de uma tarefa conforme permissoes de negocio. Exige a permissao de tarefas.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`status`	string	Sim	Novo status da tarefa.

Respostas

Status	Descricao
200	Atualizacao concluida com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

POST

/api/v1/smart-companies/{id}/tasks/{taskId}/submit

Submeter evidencia da tarefa

Submete evidencia para uma tarefa aguardando revisao.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`title`	string	Sim	Titulo da evidencia.
`description`	string	Nao	Descricao da evidencia.
`proof_url`	string	Nao	Link para a prova ou artefato.
`attachments`	array\|string	Nao	Referencias de anexos opcionais.

Respostas

Status	Descricao
200	Envio concluido com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`evidence.id`	integer	Identificador da evidencia.

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 detalhes

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/smart-companies/{id}/tokenomics/events

Listar eventos de tokenomics

Retorna o stream de eventos de tokenomics da SmartCompany.

Ver detalhes Ocultar detalhes

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
`events`	array	Stream de eventos de tokenomics.

POST

/api/v1/smart-companies/{id}/tokenomics/lock

Bloquear tokenomics da SmartCompany

Bloqueia supply e dados publicados do ticker, salvo desbloqueio futuro por processo admin ou de protocolo. Exige tokenomics:manage.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`reason`	string	Nao	Motivo opcional de lock.

Respostas

Status	Descricao
200	Bloqueio concluido com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`tokenomics.locked`	boolean	Indica se a tokenomics esta bloqueada.

GET

/api/v1/smart-companies/{id}/treasury

Listar movimentos de tesouraria da SmartCompany

Retorna movimentos e saldos de tesouraria de uma SmartCompany.

Ver detalhes Ocultar detalhes

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
`treasury`	array	Movimentos e saldos de tesouraria.

POST

/api/v1/smart-companies/{id}/treasury

Criar movimento de tesouraria da SmartCompany

Cria um movimento de tesouraria para a SmartCompany. Exige a permissao de Tesouro e Financas.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`amount`	number	Sim	Valor do movimento.
`type`	string	Sim	Tipo de movimento.
`reason`	string	Sim	Motivo do movimento de tesouraria.

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.
`movement.id`	integer	Identificador do movimento de tesouraria.

DELETE

/api/v1/smart-companies/{id}/treasury/{movementId}

Excluir movimento de tesouraria da SmartCompany

Exclui um movimento de tesouraria da SmartCompany. Exige a permissao de Tesouro e Financas.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Exclusao concluida com sucesso.
404	Movimento de tesouraria nao encontrado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.

GET

/api/v1/smart-companies/{id}/vault/yields

Listar rendimentos de vaults da SmartCompany

Retorna rendimentos de vault persistidos da SmartCompany. Quando nao ha registros, retorna dados vazios.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
401	Token ausente, invalido ou expirado.
403	O usuario autenticado nao pode visualizar esta SmartCompany.
404	SmartCompany nao encontrada.

Campos da resposta

Campo	Tipo	Descricao
`yields`	array	Lancamentos de rendimento do vault.
`summary.total_usd`	number	Rendimento total em USD representado pelos registros retornados.
`summary.by_status`	object	Totais de rendimento agrupados por status.
`next_cursor`	string\|null	Cursor para a proxima pagina, quando existir.

GET

/api/v1/smart-companies/{id}/vaults

Listar vaults da empresa

Retorna dados append-only de vault de uma SmartCompany.

Ver detalhes Ocultar detalhes

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
`vaults`	array	Lancamentos de ledger dos vaults da empresa.

GET

/api/v1/store/products

Listar produtos da loja

Retorna produtos ativos persistidos no catalogo da loja. Quando nao ha produtos configurados, retorna dados vazios.

Ver detalhes Ocultar detalhes

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
`products`	array	Produtos disponiveis da Store.
`next_cursor`	string\|null	Cursor para a proxima pagina, quando existir.

GET

/api/v1/subscriptions/my

Consultar assinatura do usuario autenticado

Retorna o plano de assinatura atual do usuario autenticado.

Ver detalhes Ocultar detalhes

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/subscriptions/plans

Listar planos de assinatura

Retorna planos de assinatura disponiveis.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.

Campos da resposta

Campo	Tipo	Descricao
`plans`	array	Planos disponiveis.

POST

/api/v1/subscriptions/upgrade

Atualizar assinatura do usuario autenticado

Altera o plano de assinatura do usuario autenticado conforme o payload enviado.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`plan_key`	string	Sim	Chave do plano de assinatura alvo.
`billing_cycle`	string	Nao	Ciclo de cobranca, quando aplicavel.

Respostas

Status	Descricao
200	Assinatura atualizada com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`subscription.id`	integer	Identificador da assinatura.

GET

/api/v1/system/menus

Listar menus visiveis do sistema

Retorna menus visiveis ao usuario autenticado.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.

Campos da resposta

Campo	Tipo	Descricao

GET

/api/v1/tasks/{id}/reward

Consultar reward da tarefa

Retorna o estado do reward de uma tarefa e o link do proof of build quando existir.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

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

Campos da resposta

Campo	Tipo	Descricao
`reward`	object	Dados de reward da tarefa.

GET

/api/v1/tasks/{taskId}/evidence

Listar evidencias da tarefa

Retorna as evidencias de uma tarefa.

Ver detalhes Ocultar detalhes

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
`evidence`	array	Evidencias da tarefa.

POST

/api/v1/tasks/{taskId}/evidence

Submeter evidencia

Submete evidencia de forma atomica e inicia o fluxo de revisao sem liberar rewards.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`title`	string	Sim	Titulo da evidencia.
`description`	string	Nao	Descricao da evidencia.
`proof_url`	string	Nao	Link para a prova ou artefato.
`attachments`	array\|string	Nao	Referencias de anexos opcionais.

Respostas

Status	Descricao
201	Envio concluido com sucesso.
422	Falha de validacao no payload enviado.

Campos da resposta

Campo	Tipo	Descricao
`message`	string	Mensagem de resultado da operacao.
`evidence.id`	integer	Identificador da evidencia.

GET

/api/v1/tasks/{taskId}/proof-of-build

Consultar proof of build

Retorna o proof of build de uma evidencia aprovada.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao

Respostas

Status	Descricao
200	Dados retornados com sucesso.
404	Proof of build nao encontrado.

Campos da resposta

Campo	Tipo	Descricao
`proof_of_build`	object	Dados de proof of build.

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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.

GET

/api/v1/users/me/assigned-tasks

Listar tarefas atribuidas ao usuario autenticado

Retorna tarefas de SmartCompanies atribuidas ao usuario autenticado.

Ver detalhes Ocultar detalhes

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 detalhes

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/investments

Listar investimentos do usuario autenticado

Retorna investimentos sandbox do usuario autenticado.

Ver detalhes Ocultar detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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 detalhes

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.

GET

/api/v1/vaults/{id}/movements

Listar movimentos do vault

Retorna o ledger append-only de movimentos de um vault.

Ver detalhes Ocultar detalhes

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
`movements`	array	Lancamentos de movimento do vault.

POST

/api/v1/vaults/{id}/movements

Criar movimento de vault

Registra um movimento append-only de vault. Exige Idempotency-Key e motivo.

Ver detalhes Ocultar detalhes

Campos da requisicao

Campo	Tipo	Obrigatorio	Descricao
`amount`	number	Sim	Valor do movimento.
`type`	string	Sim	Tipo de movimento.
`reason`	string	Sim	Motivo do movimento.

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.
`movement.id`	integer	Identificador do movimento.

Startvex API

Endpoints

Criar categoria de endpoints da API

Campos da requisicao

Respostas

Campos da resposta

List and synchronize managed API endpoints

Campos da requisicao

Respostas

Campos da resposta

Classify a managed API endpoint

Campos da requisicao

Respostas

Campos da resposta

Retrieve API endpoint classification history

Campos da requisicao

Respostas

Campos da resposta

Listar SmartCompanies para admin

Campos da requisicao

Respostas

Campos da resposta

Atualizar SmartCompany como admin

Campos da requisicao

Respostas

Campos da resposta

Listar configuracoes de fee para admin

Campos da requisicao

Respostas

Campos da resposta

Atualizar configuracao de fee como admin

Campos da requisicao

Respostas

Campos da resposta

Listar configuracao de paginas para admin

Campos da requisicao

Respostas

Campos da resposta

Atualizar configuracao de pagina como admin

Campos da requisicao

Respostas

Campos da resposta

Reconstruir read models

Campos da requisicao

Respostas

Campos da resposta

Consultar estatisticas administrativas da plataforma

Campos da requisicao

Respostas

Campos da resposta

Listar menus do sistema para admin

Campos da requisicao

Respostas

Campos da resposta

Atualizar menu do sistema

Campos da requisicao

Respostas

Campos da resposta

Listar lancamentos de tesouraria da plataforma

Campos da requisicao

Respostas

Campos da resposta

Listar usuarios para admin

Campos da requisicao

Respostas

Campos da resposta

Excluir usuario como admin

Campos da requisicao

Respostas

Campos da resposta

Atualizar usuario como admin

Campos da requisicao

Respostas

Campos da resposta

Listar vaults de capital para admin

Campos da requisicao

Respostas

Campos da resposta

Solicitar codigo de recuperacao de senha

Campos da requisicao