Documentacao viva da API. Esta pagina e gerada a partir dos endpoints anotados nos controllers e deve permanecer alinhada ao codigo em producao.
/api/v1/account/capabilities
Consultar capacidades da conta
Retorna o plano efetivo da conta, limites, consumo atual e permissoes de acao. A API permanece como autoridade final para cada limite suportado.
Retorna o plano efetivo da conta, limites, consumo atual e permissoes de acao. A API permanece como autoridade final para cada limite suportado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Authentication is required. |
| Campo | Tipo | Descricao |
|---|---|---|
account |
object | Authenticated user current account or workspace. |
plan |
object | Effective active subscription plan. |
capabilities |
object | Limits, usage and action permissions by resource. |
/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.
Cria uma categoria reutilizavel para organizar endpoints gerenciados da API. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name |
string | Sim | Nome unico da categoria com 2 a 80 caracteres. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 403 | Acesso negado. |
| 409 | Category already exists. |
| 422 | Invalid category name. |
| Campo | Tipo | Descricao |
|---|---|---|
category.id |
integer | Identificador da categoria criada. |
category.name |
string | Nome da categoria criada. |
/api/v1/admin/api-endpoint-categories/{id}
Excluir uma categoria vazia de endpoints da API
Exclui uma categoria de endpoints da API somente quando nenhum endpoint gerenciado estiver associado a ela. Exige super_admin.
Exclui uma categoria de endpoints da API somente quando nenhum endpoint gerenciado estiver associado a ela. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Exclusao concluida com sucesso. |
| 403 | Acesso negado. |
| 404 | Category not found. |
| 409 | Category still has endpoints. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/api-endpoint-workflow
Listar workflow dos endpoints da API
Lista dúvidas e pedidos de ajuste de endpoints com responsáveis, respostas, datas e estados. Exige super_admin.
Lista dúvidas e pedidos de ajuste de endpoints com responsáveis, respostas, datas e estados. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
status |
string | Nao | Filtra por pending, responded ou finalized. |
type |
string | Nao | Filtra por question ou adjustment. |
q |
string | Nao | Busca no endpoint, solicitação ou resposta. |
| Status | Descricao |
|---|---|
| 200 | Workflow retornado com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/api-endpoint-workflow/{id}
Responder ou finalizar item do workflow
Registra resposta, reabre ou finaliza uma dúvida ou ajuste, preservando responsáveis, datas e evento de histórico. Exige super_admin.
Registra resposta, reabre ou finaliza uma dúvida ou ajuste, preservando responsáveis, datas e evento de histórico. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
response |
string | Nao | Resposta com até 20000 caracteres. Obrigatória para responder ou finalizar. |
status |
string | Nao | pending, responded ou finalized. |
| Status | Descricao |
|---|---|
| 200 | Item atualizado com sucesso. |
| 403 | Acesso negado. |
| 404 | Item não encontrado. |
| 422 | Resposta ou estado inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/api-endpoint-workflow/{id}/ai-response
Responder item pendente do workflow com o ChatGPT
Envia o contexto administrativo do endpoint à OpenAI, registra a resposta gerada e move exclusivamente o item de pending para responded. Exige super_admin.
Envia o contexto administrativo do endpoint à OpenAI, registra a resposta gerada e move exclusivamente o item de pending para responded. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Resposta do ChatGPT registrada com sucesso. |
| 403 | Acesso negado. |
| 404 | Item não encontrado. |
| 409 | O item não está mais pendente. |
| 429 | Limite de uso da OpenAI atingido. |
| 502 | Falha ou resposta inválida da OpenAI. |
| 503 | Integração com a OpenAI não configurada. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/api-endpoints
Listar e sincronizar endpoints gerenciados da API
Returns the endpoint catalog, operational classifications and totalizers, including active endpoints visible in the public documentation. Requires super_admin.
Returns the endpoint catalog, operational classifications and totalizers, including active endpoints visible in the public documentation. Requires super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
status |
string | Nao | Filtra por active, inactive ou obsolete. |
category |
string | Nao | Identificador da categoria ou none para sem categoria. |
visibility |
string | Nao | Filtra por visible ou hidden. |
validation |
string | Nao | Filtra por validated ou not_validated. |
transaction |
string | Nao | Filtra por with ou without. |
q |
string | Nao | Busca por método, caminho, função, detalhamento ou categoria. |
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/api-endpoints/bulk-category
Mover endpoints para uma categoria em lote
Move os endpoints selecionados para uma categoria ou remove a categoria de todos eles. A operação é atômica e registra histórico e auditoria para cada endpoint efetivamente alterado. Exige super_admin.
Move os endpoints selecionados para uma categoria ou remove a categoria de todos eles. A operação é atômica e registra histórico e auditoria para cada endpoint efetivamente alterado. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
endpoint_ids |
array<integer> | Sim | Identificadores únicos dos endpoints a mover, com ao menos um item. |
category_id |
integer|null | Sim | Identificador da categoria de destino ou null para remover a categoria. |
| Status | Descricao |
|---|---|
| 200 | Categorias atualizadas com sucesso. |
| 403 | Acesso negado. |
| 404 | Um ou mais endpoints não foram encontrados. |
| 422 | Lista de endpoints ou categoria inválida. |
| Campo | Tipo | Descricao |
|---|---|---|
updated_count |
integer | Quantidade de endpoints cuja categoria foi efetivamente alterada. |
/api/v1/admin/api-endpoints/{id}
Atualizar um endpoint gerenciado da API
Atualiza Função, Detalhamento, documentação das validações, validação da regra de negócios, disponibilidade, visibilidade ou categoria. Exige super_admin.
Atualiza Função, Detalhamento, documentação das validações, validação da regra de negócios, disponibilidade, visibilidade ou categoria. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
summary |
string | Nao | Texto público da Função, entre 1 e 255 caracteres. |
description |
string|null | Nao | Texto público do Detalhamento, com até 5000 caracteres. |
validation_documentation |
string|null | Nao | Documentação detalhada das validações, com até 30000 caracteres. |
is_business_rule_validated |
boolean | Nao | Indica se a regra de negócios do endpoint foi validada manualmente. |
status |
string | Nao | Um dos valores active, inactive ou obsolete. |
is_documentation_visible |
boolean | Nao | Indica se o endpoint aparece na documentação pública da API. |
category_id |
integer|null | Nao | Identificador da categoria ou null para remover a categorização. |
observation |
string | Nao | Observação administrativa armazenada no histórico. |
replacement_path |
string | Nao | Endpoint substituto sugerido para um endpoint obsoleto. |
| Status | Descricao |
|---|---|
| 200 | Endpoint atualizado com sucesso. |
| 403 | Acesso negado. |
| 422 | Classificação ou documentação inválida. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/api-endpoints/{id}/history
Consultar histórico de classificação do endpoint da API
Retorna alterações de classificação, observações e usuários responsáveis. Exige super_admin.
Retorna alterações de classificação, observações e usuários responsáveis. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Acesso negado. |
| 404 | Endpoint not found. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/api-endpoints/{id}/transactions
Listar transações recentes de um endpoint gerenciado da API
Retorna até 50 resumos de transações recentes associadas ao endpoint. Exige super_admin.
Retorna até 50 resumos de transações recentes associadas ao endpoint. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Acesso negado. |
| 404 | Endpoint not found. |
| Campo | Tipo | Descricao |
|---|---|---|
endpoint.id |
integer | Managed endpoint identifier. |
transactions[] |
array | Recent transaction summaries, newest first. |
/api/v1/admin/api-endpoints/{id}/transactions/{transactionId}
Consultar uma transação de endpoint gerenciado da API
Retorna os conteúdos da requisição e da resposta de um log de transação associado ao endpoint. Exige super_admin.
Retorna os conteúdos da requisição e da resposta de um log de transação associado ao endpoint. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Acesso negado. |
| 404 | Endpoint or transaction not found. |
| Campo | Tipo | Descricao |
|---|---|---|
endpoint.id |
integer | Managed endpoint identifier. |
transaction.request |
object | Stored request metadata, headers and body. |
transaction.response |
object | Stored response status, headers and body. |
/api/v1/admin/api-endpoints/{id}/workflow
Registrar dúvida ou ajuste de um endpoint
Cria um item pendente no Workflow vinculado ao endpoint e registra o solicitante e a data. Exige super_admin.
Cria um item pendente no Workflow vinculado ao endpoint e registra o solicitante e a data. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
type |
string | Sim | question para dúvida ou adjustment para ajuste. |
description |
string | Sim | Descrição da dúvida ou do ajuste, entre 3 e 10000 caracteres. |
| Status | Descricao |
|---|---|
| 201 | Item registrado no Workflow. |
| 403 | Acesso negado. |
| 422 | Tipo ou descrição inválida. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/api-transaction-logs
Listar log administrativo de transações
Lista as 200 transações mais recentes e permite buscar em metadados e nos conteúdos armazenados da requisição ou resposta. Exige super_admin.
Lista as 200 transações mais recentes e permite buscar em metadados e nos conteúdos armazenados da requisição ou resposta. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
q |
string | Nao | Termo buscado nos metadados e conteúdos armazenados da requisição ou resposta. |
| Status | Descricao |
|---|---|
| 200 | Log retornado com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|---|---|
transactions[] |
array | Até 200 resumos de transações, da mais recente para a mais antiga. |
/api/v1/admin/api-transaction-logs/excess
Limpar transações excedentes dos endpoints
Remove apenas transações catalogadas que ultrapassam as 50 mais recentes de cada endpoint. Preserva logs sem endpoint correspondente e exige super_admin.
Remove apenas transações catalogadas que ultrapassam as 50 mais recentes de cada endpoint. Preserva logs sem endpoint correspondente e exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Limpeza concluída com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|---|---|
deleted_transactions |
integer | Quantidade de transações removidas. |
retained_transactions |
integer | Quantidade de transações preservadas entre as mais recentes. |
/api/v1/admin/api-transaction-logs/{transactionId}
Consultar transação do log administrativo
Exibe metadados e conteúdos armazenados da requisição e resposta de uma transação. Exige super_admin.
Exibe metadados e conteúdos armazenados da requisição e resposta de uma transação. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Transação retornada com sucesso. |
| 403 | Acesso negado. |
| 404 | Transação não encontrada. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/companies
Listar SmartCompanies para admin
Retorna dados de administracao de SmartCompanies para admins.
Retorna dados de administracao de SmartCompanies para admins.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
companies |
array | Lista administrativa de empresas. |
/api/v1/admin/companies/{id}
Atualizar SmartCompany como admin
Updates SmartCompany status as an admin operation.
Updates SmartCompany status as an admin operation.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
status |
string | Nao | Status da empresa. |
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
company.id |
integer | Identificador da empresa. |
/api/v1/admin/fees
Listar configuracoes de fee para admin
Retorna todas as configuracoes de fee, incluindo inativas, para admins.
Retorna todas as configuracoes de fee, incluindo inativas, para admins.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| Campo | Tipo | Descricao |
|---|---|---|
fees |
array | Todas as linhas de fees. |
/api/v1/admin/fees/{key}
Atualizar configuracao de fee como admin
Atualiza uma configuracao de fee da plataforma como operacao admin.
Atualiza uma configuracao de fee da plataforma como operacao admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
value |
number | Nao | Valor da fee. |
enabled |
boolean | Nao | Indica se a fee esta ativa. |
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
fee.key |
string | Chave da fee. |
/api/v1/admin/homologation-refresh
Consultar atualização da base de homologação
Informa se a rotina administrativa de cópia da produção para a homologação está habilitada. Exige super_admin.
Informa se a rotina administrativa de cópia da produção para a homologação está habilitada. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Status retornado com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|---|---|
enabled |
boolean | Indica se a rotina pode ser iniciada no ambiente atual. |
source_group |
string | Grupo fixo de origem, sempre default. |
target_group |
string | Grupo fixo de destino, sempre homologation. |
/api/v1/admin/homologation-refresh/history
Listar histórico de atualizações da homologação
Lista as últimas atualizações da homologação com responsável, data, status e totais disponíveis. Exige super_admin.
Lista as últimas atualizações da homologação com responsável, data, status e totais disponíveis. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Histórico retornado com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|---|---|
items[].user_name |
string|null | Nome do responsável quando ainda disponível. |
items[].performed_at |
string | Data e hora do evento de auditoria. |
items[].status |
string | Status: started, success ou failure. |
items[].tables |
integer|null | Quantidade de tabelas para eventos de sucesso. |
items[].rows |
integer|null | Quantidade de registros para eventos de sucesso. |
/api/v1/admin/homologation-refresh/run
Atualizar a base de homologação a partir da produção
Apaga e recria as tabelas da homologação com estrutura e dados da produção. Exige super_admin, flag operacional, ambiente production, confirmação explícita e lock MySQL.
Apaga e recria as tabelas da homologação com estrutura e dados da produção. Exige super_admin, flag operacional, ambiente production, confirmação explícita e lock MySQL.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
confirmation |
string | Sim | Deve ser ATUALIZAR_HOMOLOGACAO. |
source_group |
string | Sim | Deve ser default. |
target_group |
string | Sim | Deve ser homologation. |
| Status | Descricao |
|---|---|
| 200 | Homologação atualizada com sucesso. |
| 403 | Acesso negado. |
| 409 | Já existe uma atualização em andamento. |
| 422 | Confirmação inválida. |
| 503 | Rotina desabilitada ou ambiente/conexão incompatível. |
| Campo | Tipo | Descricao |
|---|---|---|
tables |
integer | Quantidade de tabelas recriadas. |
rows |
integer | Quantidade de registros copiados. |
/api/v1/admin/migrations
Listar migrations do banco de dados
Lista as migrations executadas e pendentes da aplicação no ambiente atual. Exige super_admin.
Lista as migrations executadas e pendentes da aplicação no ambiente atual. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|---|---|
environment |
string | Current application environment. |
database_group |
string | Selected database connection group. |
migrations[] |
array | Executed and pending migrations with execution metadata. |
/api/v1/admin/migrations/run
Executar migrations pendentes do banco de dados
Executa migrations pendentes somente quando a flag operacional estiver habilitada, o ambiente e o grupo de banco forem confirmados e o lock administrativo for adquirido. Exige super_admin.
Executa migrations pendentes somente quando a flag operacional estiver habilitada, o ambiente e o grupo de banco forem confirmados e o lock administrativo for adquirido. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
confirmation |
string | Sim | Must be EXECUTAR_MIGRATIONS. |
environment |
string | Sim | Must match the current environment returned by the migration list. |
database_group |
string | Sim | Must match the database group returned by the migration list. |
| Status | Descricao |
|---|---|
| 200 | Pending migrations executed or no migrations pending. |
| 403 | Acesso negado. |
| 409 | Migration execution is already in progress. |
| 422 | Environment or database group confirmation is invalid. |
| 503 | Migration execution is disabled or the runtime lock is unavailable. |
| Campo | Tipo | Descricao |
|---|---|---|
applied[] |
array | Migration filenames applied by this execution. |
totals.pending |
integer | Remaining pending migration count. |
/api/v1/admin/pages
Listar configuracao de paginas para admin
Retorna todas as configuracoes de paginas para admins, incluindo ocultas e startvex_team.
Retorna todas as configuracoes de paginas para admins, incluindo ocultas e startvex_team.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
pages |
array | Todas as configuracoes de paginas. |
pages[].visible |
string | Estado de visibilidade: true, false ou startvex_team. |
/api/v1/admin/pages
Criar configuracao de pagina
Cria uma pagina persistida no banco e vinculos opcionais com planos. Exige super_admin.
Cria uma pagina persistida no banco e vinculos opcionais com planos. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
page_key |
string | Sim | Unique page key. |
label |
string | Sim | Page label. |
path |
string | Sim | Frontend route path. |
section |
string | Nao | Page section. |
visible |
string | Nao | Estado de visibilidade: true, false ou startvex_team. |
public |
boolean | Nao | Whether the page is available without a plan link. |
sort_order |
integer | Nao | Display order within the section. |
plan_ids |
array | Nao | Subscription plan IDs allowed to access a non-public page. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 403 | Requires super_admin. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
page.id |
integer | Created page identifier. |
/api/v1/admin/pages/{identifier}
Excluir configuracao de pagina
Exclui uma pagina e todos os seus vinculos com planos. Exige super_admin.
Exclui uma pagina e todos os seus vinculos com planos. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Exclusao concluida com sucesso. |
| 403 | Requires super_admin. |
| 404 | Page not found. |
| Campo | Tipo | Descricao |
|---|---|---|
id |
integer | Deleted page identifier. |
/api/v1/admin/pages/{identifier}
Atualizar configuracao de pagina como admin
Atualiza uma pagina persistida e seus vinculos opcionais por id, chave ou caminho. Exige super_admin.
Atualiza uma pagina persistida e seus vinculos opcionais por id, chave ou caminho. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
page_key |
string | Nao | Unique page key. |
label |
string | Nao | Page label. |
path |
string | Nao | Frontend route path. |
section |
string | Nao | Page section. |
visible |
string | Nao | Estado de visibilidade. Valores aceitos: true, false, startvex_team. |
published |
boolean | Nao | Alias legado de visible. |
public |
boolean | Nao | Whether the page is available without a plan link. |
sort_order |
integer | Nao | Display order within the section. |
plan_ids |
array | Nao | Subscription plan IDs allowed to access a non-public page. |
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 403 | Requires super_admin. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
page.id |
integer | Identificador da pagina. |
/api/v1/admin/read-models/rebuild
Reconstruir read models
Reconstroi read models para todos os escopos ou para um usuario/empresa especifico.
Reconstroi read models para todos os escopos ou para um usuario/empresa especifico.
| 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. |
| Status | Descricao |
|---|---|
| 200 | Reconstrucao concluida com sucesso. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/admin/stats
Consultar estatisticas administrativas da plataforma
Retorna estatisticas agregadas da plataforma para usuarios admin.
Retorna estatisticas agregadas da plataforma para usuarios admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
stats |
object | Estatisticas administrativas. |
/api/v1/admin/subscription-plans
Listar planos para administracao
Retorna todos os planos, inclusive inativos, e os IDs de paginas vinculadas. Exige super_admin.
Retorna todos os planos, inclusive inativos, e os IDs de paginas vinculadas. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Requires super_admin. |
| Campo | Tipo | Descricao |
|---|---|---|
plans |
array | Subscription plan records. |
plans[].features |
object | JSON characteristics configured by APP_ADMIN. |
plans[].page_ids |
array | Linked private page IDs. |
/api/v1/admin/subscription-plans
Criar plano de assinatura
Cria um plano com caracteristicas JSON e vinculos opcionais com paginas. Exige super_admin.
Cria um plano com caracteristicas JSON e vinculos opcionais com paginas. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
duration_days |
integer | Nao | Duração entre 1 e 3650 dias; padrão 30. |
plan_key |
string | Sim | Unique compatibility key used by subscriptions. |
name |
string | Sim | Plan name. |
description |
string | Nao | Plan description. |
price |
number | Sim | Plan price. |
features |
object | Nao | JSON characteristics supplied by APP_ADMIN. |
active |
boolean | Nao | Whether the plan can be purchased. |
page_ids |
array | Nao | Private page IDs available to this plan. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 403 | Requires super_admin. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
plan.id |
integer | Created plan identifier. |
/api/v1/admin/subscription-plans/{id}
Atualizar plano de assinatura
Atualiza os dados do plano e opcionalmente substitui todos os vinculos com paginas. Exige super_admin.
Atualiza os dados do plano e opcionalmente substitui todos os vinculos com paginas. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
duration_days |
integer | Nao | Duração entre 1 e 3650 dias; padrão 30. |
plan_key |
string | Nao | Unique compatibility key used by subscriptions. |
name |
string | Nao | Plan name. |
description |
string | Nao | Plan description. |
price |
number | Nao | Plan price. |
features |
object | Nao | JSON characteristics supplied by APP_ADMIN. |
active |
boolean | Nao | Whether the plan can be purchased. |
page_ids |
array | Nao | Replacement list of private page IDs. |
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 403 | Requires super_admin. |
| 404 | Plan not found. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
plan.id |
integer | Updated plan identifier. |
/api/v1/admin/system/menus
Listar menus do sistema para admin
Retorna todos os menus do sistema para usuarios admin da Startvex.
Retorna todos os menus do sistema para usuarios admin da Startvex.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/system/menus
Criar menu do sistema
Cria um menu personalizado do sistema. Exige super_admin.
Cria um menu personalizado do sistema. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Criacao concluida com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/system/menus/{id}
Excluir menu do sistema
Exclui um menu do sistema. Exige super_admin.
Exclui um menu do sistema. Exige super_admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Exclusao concluida com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/system/menus/{id}
Atualizar menu do sistema
Atualiza um campo editavel de menu do sistema.
Atualiza um campo editavel de menu do sistema.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/admin/treasury
Listar lancamentos de tesouraria da plataforma
Retorna lancamentos de tesouraria da plataforma para admins.
Retorna lancamentos de tesouraria da plataforma para admins.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
entries |
array | Lancamentos de tesouraria. |
/api/v1/admin/users
Listar usuarios para admin
Retorna dados de administracao de usuarios para admins.
Retorna dados de administracao de usuarios para admins.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
users |
array | Lista administrativa de usuarios. |
/api/v1/admin/users/{userId}
Excluir usuario como admin
Exclui ou desativa um usuario por operacao admin.
Exclui ou desativa um usuario por operacao admin.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Exclusao concluida com sucesso. |
| 404 | Usuario nao encontrado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/admin/users/{userId}
Atualizar usuario como admin
Atualiza perfil, role, plano ou status de um usuario como operacao admin.
Atualiza perfil, role, plano ou status de um usuario como operacao admin.
| 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. |
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
user.id |
integer | Identificador do usuario. |
/api/v1/admin/vaults
Listar vaults de capital para admin
Retorna dados administrativos de vaults de capital para admins.
Retorna dados administrativos de vaults de capital para admins.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
vaults |
array | Lista administrativa de vaults. |
/api/v1/ai/chat
Enviar mensagem ao chat de IA
Exige Bearer e Idempotency-Key. Resolve usuário, empresa, papel, função e permissões no servidor. Sem empresa usa default. Accept text/event-stream seleciona SSE; padrão JSON. Persiste mensagens, uso e auditoria.
Exige Bearer e Idempotency-Key. Resolve usuário, empresa, papel, função e permissões no servidor. Sem empresa usa default. Accept text/event-stream seleciona SSE; padrão JSON. Persiste mensagens, uso e auditoria.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
idempotency_key |
string | Sim | Valor enviado no header Idempotency-Key; não faz parte do corpo JSON. |
conversationId |
string|null | Nao | UUID da conversa autorizada ou null para criar. |
message |
string | Sim | Mensagem não vazia dentro dos limites configurados. |
context |
object | Nao | Somente currentPage e selectedEntity (type/id); dados não confiáveis. |
| Status | Descricao |
|---|---|
| 200 | Resposta JSON ou fluxo SSE start/delta/done/error. |
| 401 | Autenticação inválida. |
| 403 | Uso não autorizado. |
| 404 | Conversa não encontrada no contexto atual. |
| 409 | Conflito de execução ou idempotência. |
| 422 | Payload inválido. |
| 429 | Limite de uso atingido. |
| 503 | Serviço indisponível. |
| 504 | Tempo limite excedido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/ai/chat/conversations
Listar conversas de IA
Lista somente conversas do usuário e empresa atuais; default isola conversas sem empresa. Paginação limit de 1 a 100 e offset até 100000.
Lista somente conversas do usuário e empresa atuais; default isola conversas sem empresa. Paginação limit de 1 a 100 e offset até 100000.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/ai/chat/conversations
Criar conversa de IA
Cria conversa no contexto autenticado. Aceita título opcional e agente cadastrado no servidor.
Cria conversa no contexto autenticado. Aceita título opcional e agente cadastrado no servidor.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
title |
string | Nao | Título ou null, até 160 caracteres. |
agent |
string | Nao | Agente permitido; padrão startvex-assistant. |
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/ai/chat/conversations/{conversationId}
Excluir conversa de IA
Aplica exclusão lógica à conversa autorizada. Preserva mensagens, uso e auditoria; rejeita conversa em processamento.
Aplica exclusão lógica à conversa autorizada. Preserva mensagens, uso e auditoria; rejeita conversa em processamento.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/ai/chat/conversations/{conversationId}
Consultar conversa de IA
Valida UUID, usuário e empresa; retorna conversa e mensagens ordenadas com estado da execução. Paginação limit e offset nas mensagens.
Valida UUID, usuário e empresa; retorna conversa e mensagens ordenadas com estado da execução. Paginação limit e offset nas mensagens.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/ai/chat/conversations/{conversationId}
Atualizar título da conversa
Altera somente title em conversa autorizada e sem execução ativa.
Altera somente title em conversa autorizada e sem execução ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
title |
string | Sim | Título ou null, até 160 caracteres. |
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/ai/tools/company/context
Consultar contexto autorizado da empresa
Uso exclusivo do AI Hub com Bearer privado e HMAC. Requer execução ativa vinculada à conversa e recarrega usuário, associação e permissões do banco. Exige edit_company; default é negado. Retorna somente id, name e sector.
Uso exclusivo do AI Hub com Bearer privado e HMAC. Requer execução ativa vinculada à conversa e recarrega usuário, associação e permissões do banco. Exige edit_company; default é negado. Retorna somente id, name e sector.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
chatRequestId |
string | Sim | UUID de execução ativa emitido pela API. |
conversationId |
string | Sim | UUID da conversa vinculada. |
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/ai/tools/smart-company/create
Criar SmartCompany por ferramenta de IA
Uso exclusivo do AI Hub com Bearer privado, HMAC e Idempotency-Key. A execução resolve o usuário no servidor; o Hub informa execution_id, name, symbol e, opcionalmente, tool_call_id apenas para auditoria. A autorização atual e os limites do plano são revalidados antes da criação.
Uso exclusivo do AI Hub com Bearer privado, HMAC e Idempotency-Key. A execução resolve o usuário no servidor; o Hub informa execution_id, name, symbol e, opcionalmente, tool_call_id apenas para auditoria. A autorização atual e os limites do plano são revalidados antes da criação.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
execution_id |
string | Sim | UUID da execução de chat ativa emitido pela API. |
tool_call_id |
string | Nao | Identificador da chamada no Hub, usado somente para auditoria. |
name |
string | Sim | Nome da SmartCompany, de 2 a 100 caracteres. |
symbol |
string | Sim | Símbolo da SmartCompany, de 1 a 20 caracteres. |
Idempotency-Key |
header | Sim | Chave única da chamada da ferramenta; retries retornam a resposta original. |
| Status | Descricao |
|---|---|
| 201 | SmartCompany criada. |
| 401 | Autenticação interna inválida. |
| 403 | Execução ou permissão indisponível. |
| 409 | Chave idempotente reutilizada com pedido diferente ou chamada em andamento. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/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.
Recebe um email e envia um codigo de recuperacao de 8 caracteres quando a conta ativa existe. O codigo expira em 15 minutos.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
email |
string | Sim | Email cadastrado do usuario. |
| Status | Descricao |
|---|---|
| 200 | Solicitacao de recuperacao de senha processada. |
| 422 | Falha de validacao no payload enviado. |
| 503 | Falha de envio SMTP. |
| 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. |
/api/v1/auth/google
Autenticar com uma conta Google
Valida no servidor o ID token emitido pelo Google. Para usuário existente, cria uma sessão autenticada; para novo usuário, retorna os dados Google para conclusão do perfil.
Valida no servidor o ID token emitido pelo Google. Para usuário existente, cria uma sessão autenticada; para novo usuário, retorna os dados Google para conclusão do perfil.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
credential |
string | Sim | ID token retornado pelo Google Identity Services. |
| Status | Descricao |
|---|---|
| 200 | Sessão criada ou dados para cadastro retornados. |
| 401 | Token Google inválido. |
| 422 | Payload inválido. |
| 502 | Falha ao validar token no Google. |
| 503 | Login Google não configurado. |
| Campo | Tipo | Descricao |
|---|---|---|
registration_required |
boolean | Indica que o perfil precisa ser concluído. |
google_profile |
object | Nome, email e foto recebidos do Google para pré-preenchimento. |
access_token |
string | Token da sessão quando o usuário já existe. |
/api/v1/auth/google/config
Obter configuração pública do login Google
Retorna o client ID OAuth público configurado para inicializar o Google Identity Services no navegador.
Retorna o client ID OAuth público configurado para inicializar o Google Identity Services no navegador.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Login Google configurado. |
| 503 | Login Google indisponível. |
| Campo | Tipo | Descricao |
|---|---|---|
client_id |
string | Client ID OAuth público do aplicativo web. |
/api/v1/auth/google/register
Concluir cadastro iniciado com Google
Valida novamente o ID token Google, salva os dados complementares e cria uma conta ativa sem enviar código de ativação.
Valida novamente o ID token Google, salva os dados complementares e cria uma conta ativa sem enviar código de ativação.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
credential |
string | Sim | ID token retornado pelo Google Identity Services. |
name |
string | Sim | Nome confirmado ou editado pelo usuário. |
username |
string | Sim | Identificador público do usuário. |
terms_accepted |
boolean | Sim | Confirmação dos termos de uso e privacidade. |
| Status | Descricao |
|---|---|
| 200 | Cadastro concluído e sessão criada. |
| 401 | Token Google inválido. |
| 409 | Username já está em uso. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|---|---|
access_token |
string | Nova sessão autenticada. |
user |
object | Perfil ativo do usuário. |
/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.
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.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
email |
string | Sim | Email cadastrado do usuario. |
password |
string | Sim | Senha do usuario. |
| 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. |
| 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. |
/api/v1/auth/logout
Invalidar o token autenticado atual
Invalida o bearer token e encerra a sessao autenticada.
Invalida o bearer token e encerra a sessao autenticada.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
access_token |
string | Sim | Token da sessao autenticada atual, enviado somente no header Authorization Bearer. |
| Status | Descricao |
|---|---|
| 200 | Logout concluido e token invalidado. |
| 422 | Falha de validacao no payload enviado. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/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.
Valida o codigo de recuperacao de 8 caracteres, atualiza a senha e revoga as sessoes ativas do usuario.
| 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. |
| Status | Descricao |
|---|---|
| 200 | Senha atualizada com sucesso e sessoes ativas revogadas. |
| 422 | Falha de validacao ou codigo de recuperacao invalido/expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/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.
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.
| 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. |
| 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. |
| 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. |
/api/v1/blueprints
Listar blueprints
Lista apenas blueprints privados do autor.
Lista apenas blueprints privados do autor.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/blueprints
Criar blueprint
Cria template estrutural privado.
Cria template estrutural privado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/blueprints/{blueprintId}
Excluir blueprint
Exclusão lógica privada.
Exclusão lógica privada.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/blueprints/{blueprintId}
Consultar blueprint
Consulta privada do autor.
Consulta privada do autor.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/blueprints/{blueprintId}
Atualizar blueprint
Atualiza template privado do autor.
Atualiza template privado do autor.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/blueprints/{blueprintId}/instantiate
Instanciar blueprint
Exige manage_tasks e Idempotency-Key.
Exige manage_tasks e Idempotency-Key.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/capital/rounds/{roundId}/investment-intents
Criar intencao de investimento
Cria uma intencao de investimento sandbox. Exige Idempotency-Key e pode expirar.
Cria uma intencao de investimento sandbox. Exige Idempotency-Key e pode expirar.
| 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. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
intent.id |
integer | Identificador da intencao de investimento. |
/api/v1/evidence/uploads
Enviar arquivo de evidencia
Armazena arquivo de evidencia em storage e retorna identificador para associacao posterior com tarefa.
Armazena arquivo de evidencia em storage e retorna identificador para associacao posterior com tarefa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
file |
file | Sim | Arquivo de evidencia para upload. |
checksum |
string | Sim | Hexadecimal checksum with 32 to 128 characters. |
smart_company_id |
integer | Nao | Optional SmartCompany identifier. The authenticated user must be its creator or active internal participant. |
task_id |
integer | Nao | Optional task identifier. Its SmartCompany is derived and must be accessible to the authenticated user. |
| Status | Descricao |
|---|---|
| 201 | Upload concluido com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 403 | Authenticated user cannot access the associated SmartCompany. |
| 422 | Falha de validacao ou nenhum arquivo de evidencia foi enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
upload_id |
integer | Identificador do upload de evidencia. |
signed_url |
string | Temporary signed URL for the uploaded file. |
upload.id |
integer | Identificador do upload de evidencia. |
upload.user_id |
integer | Authenticated user identifier. |
upload.smart_company_id |
integer|null | Authorized SmartCompany association. |
upload.task_id |
integer|null | Authorized task association. |
upload.storage_key |
string | Chave do arquivo armazenado. |
upload.mime_type |
string | Detected MIME type. |
upload.size_bytes |
integer | Stored file size in bytes. |
upload.checksum |
string | Submitted hexadecimal checksum. |
upload.scan_status |
string | Initial malware scan status. |
upload.status |
string | Upload lifecycle status. |
/api/v1/evidence/{evidenceId}/approve
Aprovar evidencia
Aprova a evidencia de forma atomica, emite PoB e deixa o reward pendente.
Aprova a evidencia de forma atomica, emite PoB e deixa o reward pendente.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
reviewer_note |
string | Nao | Nota opcional do revisor. |
| Status | Descricao |
|---|---|
| 200 | Aprovacao concluida com sucesso. |
| 404 | Evidencia nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/evidence/{evidenceId}/reject
Rejeitar evidencia
Rejeita evidencia com nota do revisor e registra o evento de status da tarefa.
Rejeita evidencia com nota do revisor e registra o evento de status da tarefa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
reviewer_note |
string | Sim | Motivo da rejeicao da evidencia. |
note |
string | Nao | Alias de reviewer_note. |
| Status | Descricao |
|---|---|
| 200 | Rejeicao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/feed
Listar posts do feed
Retorna posts publicos do feed, opcionalmente filtrados por parametros de consulta.
Retorna posts publicos do feed, opcionalmente filtrados por parametros de consulta.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 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. |
/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.
Cria um post no feed para o usuario autenticado. Exige a permissao Publicar no Pulse quando o post aponta para uma SmartCompany.
| 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. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
post.id |
integer | Identificador do post. |
/api/v1/feed/{postId}/comments
Listar comentários do post
Retorna comentários públicos paginados com autor resumido.
Retorna comentários públicos paginados com autor resumido.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Comentários retornados com sucesso. |
| 404 | Post não encontrado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/feed/{postId}/comments
Criar comentário em post
Cria comentário autenticado de forma idempotente pelo header Idempotency-Key.
Cria comentário autenticado de forma idempotente pelo header Idempotency-Key.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
Idempotency-Key |
string | Sim | Header obrigatório de idempotência. |
content |
string | Sim | Conteúdo não vazio de até 2000 caracteres. |
| Status | Descricao |
|---|---|
| 201 | Comentário criado com sucesso. |
| 409 | Chave reutilizada com payload diferente. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/feed/{postId}/like
Curtir post do feed
Cria de forma idempotente o like do usuário autenticado. Repetições não incrementam o contador e não removem o like.
Cria de forma idempotente o like do usuário autenticado. Repetições não incrementam o contador e não removem o like.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Like registered or already existed. |
| 401 | Token ausente, invalido ou expirado. |
| 404 | Post not found. |
| 500 | Like persistence failed. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
liked |
boolean | Always true for this idempotent like operation. |
created |
boolean | Whether this request created the user/post like relation. |
likes_count |
integer | Current persisted like count for the post. |
/api/v1/fees
Listar fees da plataforma
Retorna configuracoes de fee ativas visiveis aos clientes.
Retorna configuracoes de fee ativas visiveis aos clientes.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| Campo | Tipo | Descricao |
|---|---|---|
fees |
array | Fees ativas da plataforma. |
/api/v1/fees/calculate
Calcular fee da plataforma
Calcula uma fee usando a configuração atual, sem criar lançamento financeiro.
Calcula uma fee usando a configuração atual, sem criar lançamento financeiro.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
amount |
number | Sim | Valor base para calculo da fee. |
key |
string | Nao | Chave opcional da fee a calcular. |
| Status | Descricao |
|---|---|
| 200 | Fee calculada com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
fee |
object | Detalhamento da fee calculada. |
/api/v1/fees/{key}
Consultar fee da plataforma
Retorna uma configuracao de fee pela chave.
Retorna uma configuracao de fee pela chave.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 404 | Fee nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
fee |
object | Configuracao de fee da plataforma. |
/api/v1/health
Verificar saude da API
Retorna um payload simples de status para monitoramento e verificacoes de conectividade.
Retorna um payload simples de status para monitoramento e verificacoes de conectividade.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | A API esta saudavel. |
| Campo | Tipo | Descricao |
|---|---|---|
status |
string | Status de saude. |
timestamp |
string | Data/hora UTC do health check. |
/api/v1/investments/{id}/confirm
Confirmar investimento
Confirma um investimento sandbox, congela o snapshot de fees e emite o recibo. Exige Idempotency-Key.
Confirma um investimento sandbox, congela o snapshot de fees e emite o recibo. Exige Idempotency-Key.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
fee_snapshot |
object | Nao | Payload opcional do snapshot de fee. |
receipt_reference |
string | Nao | Referencia opcional de recibo externo. |
| Status | Descricao |
|---|---|
| 200 | Confirmacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
investment.id |
integer | Identificador do investimento. |
/api/v1/market/open-tasks
Listar tarefas abertas do mercado
Returns open, unassigned public or pool tasks grouped by company, including when the SmartCompany itself is private.
Returns open, unassigned public or pool tasks grouped by company, including when the SmartCompany itself is private.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| Campo | Tipo | Descricao |
|---|---|---|
companies |
array | Empresas com tarefas abertas. |
/api/v1/market/prices
Listar precos de tokens do mercado
Retorna o preço ICO configurado e market cap estimado, sem variação histórica.
Retorna o preço ICO configurado e market cap estimado, sem variação histórica.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| Campo | Tipo | Descricao |
|---|---|---|
prices |
array | Resumos de precos de mercado. |
prices[].symbol |
string | Simbolo do token. |
prices[].price_usd |
number | Preço ICO configurado. |
prices[].price_source |
string | Origem do preço: configured_ico_price. |
prices[].market_cap |
number|null | Estimativa de market cap. |
/api/v1/market/prices/{symbol}
Retrieve configured token price
Retorna o preço ICO configurado para um token, sem série histórica.
Retorna o preço ICO configurado para um token, sem série histórica.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 404 | Simbolo do token nao encontrado. |
| Campo | Tipo | Descricao |
|---|---|---|
symbol |
string | Símbolo do token. |
current_price |
number | Preço ICO configurado. |
price_source |
string | Origem do preço: configured_ico_price. |
market_cap |
number | Market cap estimado a partir da configuração. |
/api/v1/notifications
Listar notificacoes
Retorna notificacoes do usuario autenticado.
Retorna notificacoes do usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
notifications |
array | Notificacoes do usuario. |
notifications[].id |
integer | Identificador da notificacao. |
notifications[].type |
string | Tipo da notificacao. |
notifications[].title |
string | Titulo da notificacao. |
notifications[].message |
string | Mensagem da notificacao. |
notifications[].read_at |
string|null | Data/hora de leitura. |
notifications[].created_at |
string | Data/hora de criacao. |
/api/v1/notifications/read-all
Marcar todas as notificacoes como lidas
Marca todas as notificacoes do usuario autenticado como lidas.
Marca todas as notificacoes do usuario autenticado como lidas.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Notificacoes marcadas como lidas. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
read_count |
integer | Quantidade de notificacoes atualizadas. |
/api/v1/pages
Listar configuracao publica de paginas
Retorna paginas publicas visiveis e paginas privadas vinculadas ao plano ativo do usuario autenticado. Paginas startvex_team ficam restritas ao time Startvex.
Retorna paginas publicas visiveis e paginas privadas vinculadas ao plano ativo do usuario autenticado. Paginas startvex_team ficam restritas ao time Startvex.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| Campo | Tipo | Descricao |
|---|---|---|
pages |
array | Configuracoes publicas de paginas. |
pages[].visible |
string | Estado de visibilidade: true, false ou startvex_team. |
pages[].public |
boolean | Whether the page is available without a subscription plan link. |
pages[].sort_order |
integer | Database-backed display order. |
/api/v1/payments/credit-account
Solicitar crédito via Stripe
Cria Checkout para crédito em USD. O saldo só é registrado após confirmação assinada do Stripe; requer Bearer e Idempotency-Key.
Cria Checkout para crédito em USD. O saldo só é registrado após confirmação assinada do Stripe; requer Bearer e Idempotency-Key.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
amount |
string | Nao | Valor USD do crédito, entre 0.50 e 999999.99. |
plan_id |
integer | Nao | Plano ativo para plan_purchase. |
action_type |
string | Nao | credit_account ou plan_purchase; obrigatório no checkout. |
| Status | Descricao |
|---|---|
| 200 | Operação processada. |
| 422 | Dados inválidos. |
| 503 | Stripe não configurado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/payments/history
Consultar histórico Stripe
Lista pagamentos Stripe do usuário autenticado, incluindo pendentes, falhos, cancelados e confirmados. Paginação por limit (1 a 100) e offset.
Lista pagamentos Stripe do usuário autenticado, incluindo pendentes, falhos, cancelados e confirmados. Paginação por limit (1 a 100) e offset.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Operação processada. |
| 422 | Dados inválidos. |
| 503 | Stripe não configurado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/payments/stripe/checkout
Criar checkout Stripe
Cria uma sessão de pagamento único para credit_account ou plan_purchase. Requer Bearer e Idempotency-Key. Valores e duração do plano são definidos no servidor.
Cria uma sessão de pagamento único para credit_account ou plan_purchase. Requer Bearer e Idempotency-Key. Valores e duração do plano são definidos no servidor.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
amount |
string | Nao | Valor USD do crédito, entre 0.50 e 999999.99. |
plan_id |
integer | Nao | Plano ativo para plan_purchase. |
action_type |
string | Nao | credit_account ou plan_purchase; obrigatório no checkout. |
| Status | Descricao |
|---|---|
| 200 | Operação processada. |
| 422 | Dados inválidos. |
| 503 | Stripe não configurado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/payments/stripe/webhook
Receber confirmação Stripe
Valida Stripe-Signature sobre o corpo original e aplica o pagamento uma única vez. Dispensa Bearer. Eventos não suportados são reconhecidos sem efeito financeiro.
Valida Stripe-Signature sobre o corpo original e aplica o pagamento uma única vez. Dispensa Bearer. Eventos não suportados são reconhecidos sem efeito financeiro.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Operação processada. |
| 422 | Dados inválidos. |
| 503 | Stripe não configurado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/protocol/actions/{id}
Consultar status da acao de protocolo
Retorna status atual e payload de uma acao de protocolo.
Retorna status atual e payload de uma acao de protocolo.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 404 | Acao de protocolo nao encontrada para o usuario autenticado. |
| 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. |
/api/v1/rewards/{id}/release
Liberar reward
Libera reward somente para gestor financeiro autorizado da SmartCompany, impedindo auto-liberação e preservando o ledger append-only.
Libera reward somente para gestor financeiro autorizado da SmartCompany, impedindo auto-liberação e preservando o ledger append-only.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
Idempotency-Key |
string | Sim | Header obrigatório de idempotência. |
amount_tokens |
number|string | Nao | Quantidade a liberar; quando ausente, usa o valor do reward pendente. |
reason |
string | Nao | Motivo opcional da liberação. |
| Status | Descricao |
|---|---|
| 200 | Liberacao concluida com sucesso. |
| 401 | Bearer ausente, inválido ou expirado. |
| 403 | Actor is not authorized for the SmartCompany or is the reward beneficiary. |
| 404 | Reward or related task not found. |
| 409 | Idempotency-Key was already used with a different request. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
reward_id |
integer | Identificador do reward liberado. |
idempotency_key |
string | Chave de idempotência da liberação. |
/api/v1/smart-companies
Listar SmartCompanies visiveis
Retorna resumos de SmartCompanies visiveis ao solicitante sem expor dados privados do core.
Retorna resumos de SmartCompanies visiveis ao solicitante sem expor dados privados do core.
| 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. |
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 422 | Falha de validacao nos parametros de consulta enviados. |
| Campo | Tipo | Descricao |
|---|---|---|
smart_companies |
array | Resumos visiveis de SmartCompanies. |
next_cursor |
string|null | Cursor para a proxima pagina. |
/api/v1/smart-companies
Criar uma SmartCompany
Cria uma SmartCompany em lifecycle SQUAD. Somente name e symbol são obrigatórios, imutáveis e únicos ignorando caixa e espaços.
Cria uma SmartCompany em lifecycle SQUAD. Somente name e symbol são obrigatórios, imutáveis e únicos ignorando caixa e espaços.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name |
string | Sim | Nome da empresa. |
symbol |
string | Sim | Símbolo imutável da SmartCompany. |
sector |
string | Nao | Setor da empresa. |
stage |
string | Nao | Estagio da empresa. |
description |
string | Nao | Descricao da empresa. |
website |
string | Nao | Site da empresa. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 403 | The effective account plan limit was reached. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
smart_company.id |
integer | Identificador da SmartCompany. |
/api/v1/smart-companies/create
Criar SmartCompany pelo payload legado
Wrapper legado para POST /api/v1/smart-companies, incluindo a aplicação dos limites do plano da conta.
Wrapper legado para POST /api/v1/smart-companies, incluindo a aplicação dos limites do plano da conta.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 403 | The effective account plan limit was reached. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/get
Consultar SmartCompany por payload legado
Retorna dados da SmartCompany usando a interface legada via POST.
Retorna dados da SmartCompany usando a interface legada via POST.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
smart_company_id |
integer | Sim | Identificador da SmartCompany. |
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
smart_company |
object | Dados principais da SmartCompany. |
/api/v1/smart-companies/list
Listar SmartCompanies por payload legado
Retorna resumos de SmartCompanies usando a interface legada via POST.
Retorna resumos de SmartCompanies usando a interface legada via POST.
| 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. |
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 422 | Falha de validacao nos parametros de consulta enviados. |
| Campo | Tipo | Descricao |
|---|---|---|
smart_companies |
array | Resumos visiveis de SmartCompanies. |
next_cursor |
string|null | Cursor para a proxima pagina. |
/api/v1/smart-companies/participants/remove
Remover participante por payload legado
Remove participante usando a interface legada via POST.
Remove participante usando a interface legada via POST.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
smart_company_id |
integer | Sim | Identificador da SmartCompany. |
user_id |
integer | Sim | Identificador do usuario a remover. |
| Status | Descricao |
|---|---|
| 200 | Participante removido com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/smart-companies/participants/upsert
Criar ou atualizar participante por payload legado
Cria ou atualiza participante usando a interface legada via POST.
Cria ou atualiza participante usando a interface legada via POST.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
smart_company_id |
integer | Sim | Identificador da SmartCompany. |
user_id |
integer | Sim | Identificador do usuario. |
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. |
| Status | Descricao |
|---|---|
| 200 | Criacao ou atualizacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
participant.id |
integer | Identificador do participante. |
/api/v1/smart-companies/update
Atualizar SmartCompany por payload legado
Atualiza os dados principais da SmartCompany usando um payload legado que pode incluir smart_company_id, sc_id ou id. Somente um Founder ou Co-Founder ativo da SmartCompany de destino está autorizado.
Atualiza os dados principais da SmartCompany usando um payload legado que pode incluir smart_company_id, sc_id ou id. Somente um Founder ou Co-Founder ativo da SmartCompany de destino está autorizado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
smart_company_id |
integer | Nao | Identificador da SmartCompany. |
sc_id |
integer | Nao | Alias legado de smart_company_id. |
id |
integer | Nao | Alias legado de smart_company_id. |
name |
string | Nao | Nome da empresa. |
sector |
string | Nao | Setor da empresa. |
status |
string | Nao | Status da empresa. |
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 403 | Only an active Founder or Co-Founder of the target SmartCompany may update it. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
smart_company.id |
integer | Identificador da SmartCompany. |
/api/v1/smart-companies/{id}
Consultar contexto da SmartCompany
Leitores autorizados recebem os dados da SmartCompany; founders tambem recebem secoes de gestao.
Leitores autorizados recebem os dados da SmartCompany; founders tambem recebem secoes de gestao.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 404 | SmartCompany nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
smart_company |
object | Dados principais da SmartCompany. |
participants |
array | Participantes da empresa quando visiveis. |
tasks |
array | Tarefas da empresa quando visiveis. |
/api/v1/smart-companies/{id}
Atualizar dados centrais da SmartCompany
Atualiza somente campos mutáveis. name, symbol, lifecycle e published_at são rejeitados; status active e visibility public somente podem ser definidos pela publicação.
Atualiza somente campos mutáveis. name, symbol, lifecycle e published_at são rejeitados; status active e visibility public somente podem ser definidos pela publicação.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
smart_company_id |
integer | Nao | Identificador da SmartCompany ao usar payload legado. |
sector |
string | Nao | Setor da empresa. |
stage |
string | Nao | Estagio da empresa. |
description |
string | Nao | Descricao da empresa. |
website |
string | Nao | Site da empresa. |
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 403 | Only an active Founder or Co-Founder of the target SmartCompany may update it. |
| 409 | Tentativa de alterar name ou symbol imutável. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
smart_company.id |
integer | Identificador da SmartCompany. |
/api/v1/smart-companies/{id}/ai-agents
Listar agentes de IA
Configurações não concedem permissões reais.
Configurações não concedem permissões reais.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/ai-agents
Criar agente de IA
Exige manage_tasks.
Exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/ai-agents/{agentId}
Excluir agente de IA
Exige manage_tasks.
Exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/ai-agents/{agentId}
Atualizar agente de IA
Exige manage_tasks.
Exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/capital
Consultar resumo de capital da SmartCompany
Retorna resumo de rodadas de capital, investimentos e vaults da SmartCompany.
Retorna resumo de rodadas de capital, investimentos e vaults da SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
capital |
object | Dados de resumo de capital. |
/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.
Encerra a rodada de capital atual conforme permissoes da SmartCompany. Exige a permissao de capital.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
reason |
string | Nao | Motivo opcional de encerramento. |
| Status | Descricao |
|---|---|
| 200 | Encerramento concluido com sucesso. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/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.
Cria uma rodada de capital para a SmartCompany. Exige a permissao de capital.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name |
string | Sim | Nome não vazio da rodada. |
target_amount_usd |
number | Sim | Valor alvo em USD, maior que zero. |
token_price_usd |
number | Nao | Preço do token em USD; padrão ico_token_price da empresa ou 0.10. |
min_investment_usd |
number | Nao | Investimento mínimo em USD; padrão 100. |
closes_at |
string|null | Nao | Data/hora de fechamento aceitas pelo parser do servidor. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
round.id |
integer | Identificador da rodada de capital. |
/api/v1/smart-companies/{id}/capital/invest
Investir em rodada de capital da SmartCompany
Registra investimento idempotente e aplica o fluxo de fee, vault, tesouraria e tokens.
Registra investimento idempotente e aplica o fluxo de fee, vault, tesouraria e tokens.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
Idempotency-Key |
string | Sim | Header obrigatório de idempotência. |
round_id |
integer | Sim | Identificador da rodada, pertencente à SmartCompany do path. |
amount_usd |
number | Sim | Valor do investimento em USD, maior que zero e respeitando o mínimo da rodada. |
| Status | Descricao |
|---|---|
| 200 | Registro concluido com sucesso. |
| 409 | Idempotency-Key was already used with a different request. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
investment_id |
integer | Identificador do investimento. |
vault_id |
integer | Vault identifier. |
idempotency_key |
string | Chave de idempotência processada. |
/api/v1/smart-companies/{id}/capital/investors
Listar investidores de capital da SmartCompany
Retorna investidores de uma rodada de capital da SmartCompany.
Retorna investidores de uma rodada de capital da SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
investors |
array | Investidores de capital. |
/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.
Retorna rodadas de capital sandbox. Movimentacao financeira de producao permanece desativada por feature flag.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
rounds |
array | Rodadas de capital. |
/api/v1/smart-companies/{id}/capital/rounds
Criar rodada de capital sandbox
Cria uma rodada de capital sandbox e registra auditoria. Exige Idempotency-Key.
Cria uma rodada de capital sandbox e registra auditoria. Exige Idempotency-Key.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
idempotency_key |
string | Nao | Valor opcional do header Idempotency-Key para referencia. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
round.id |
integer | Identificador da rodada de capital. |
/api/v1/smart-companies/{id}/capital/vaults
Listar vaults de capital da SmartCompany
Retorna vaults de investimentos com IDs, valores em USD, estado, rodada, investidor resumido e timestamps.
Retorna vaults de investimentos com IDs, valores em USD, estado, rodada, investidor resumido e timestamps.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
vaults |
array | Vaults de capital. |
/api/v1/smart-companies/{id}/capital/vaults/{vaultId}/refund
Reembolsar fundos de vault de capital
Reembolsa vault ativo de forma idempotente. Exige capital societário e bloqueia auto-refund do investidor.
Reembolsa vault ativo de forma idempotente. Exige capital societário e bloqueia auto-refund do investidor.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
Idempotency-Key |
string | Sim | Header obrigatório de idempotência. |
reason |
string | Nao | Motivo opcional do refund. |
| Status | Descricao |
|---|---|
| 200 | Reembolso concluido com sucesso. |
| 403 | Actor lacks capital authority or is the vault investor. |
| 409 | Vault is no longer active or Idempotency-Key conflicts. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
refund_id |
integer | Identificador do evento de refund. |
idempotency_key |
string | Chave de idempotência processada. |
/api/v1/smart-companies/{id}/capital/vaults/{vaultId}/release
Liberar fundos de vault de capital
Libera saldo de vault de forma idempotente, com proteção atômica contra exceder o saldo locked. Exige a permissão Capital.
Libera saldo de vault de forma idempotente, com proteção atômica contra exceder o saldo locked. Exige a permissão Capital.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
Idempotency-Key |
string | Sim | Header obrigatório de idempotência. |
amount_usd |
number | Sim | Valor em USD maior que zero, limitado ao saldo locked disponível. |
milestone_id |
integer | Nao | Milestone opcional associada à liberação. |
notes |
string | Nao | Observações opcionais. |
| Status | Descricao |
|---|---|
| 200 | Liberacao concluida com sucesso. |
| 409 | Idempotency-Key was already used with a different request. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
idempotency_key |
string | Chave de idempotência processada. |
/api/v1/smart-companies/{id}/council/members
Listar membros do conselho da SmartCompany
Retorna os membros do conselho vinculados a uma SmartCompany.
Retorna os membros do conselho vinculados a uma SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/council/members
Criar membro do conselho da SmartCompany
Cria um registro de membro do conselho para uma SmartCompany.
Cria um registro de membro do conselho para uma SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Validation failed. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/council/members/{participantId}
Atualizar membro do conselho da SmartCompany
Atualiza um registro de membro do conselho.
Atualiza um registro de membro do conselho.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 404 | Council member not found. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/dashboard
Consultar projecao de dashboard da SmartCompany
Retorna apenas campos de dashboard seguros para o front-end.
Retorna apenas campos de dashboard seguros para o front-end.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 404 | SmartCompany nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
dashboard |
object | Projecao de dashboard. |
/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.
Retorna documentos, propostas, negociacoes e itens de deal room associados a SmartCompany. Quando nao ha registros, retorna dados vazios.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| 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. |
| 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. |
/api/v1/smart-companies/{id}/document-folders
Listar pastas de documentos
Lista pastas documentais ativas da SmartCompany; exige membership ativa.
Lista pastas documentais ativas da SmartCompany; exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Pastas retornadas. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/document-folders
Criar pasta de documentos
Cria pasta documental opcionalmente aninhada; exige manage_tasks.
Cria pasta documental opcionalmente aninhada; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 201 | Pasta criada. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/document-folders/{folderId}
Excluir pasta de documentos
Exclui logicamente pasta vazia; bloqueia quando há documentos ou subpastas ativas. Exige manage_tasks.
Exclui logicamente pasta vazia; bloqueia quando há documentos ou subpastas ativas. Exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Pasta removida. |
| 409 | Pasta possui conteúdo ativo. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/document-folders/{folderId}
Atualizar pasta de documentos
Atualiza nome e/ou pasta pai sem permitir ciclos; exige manage_tasks.
Atualiza nome e/ou pasta pai sem permitir ciclos; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Pasta atualizada. |
| 422 | Payload inválido ou ciclo. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/documents
Listar documentos da SmartCompany
Lista documentos não excluídos; exige membership ativa.
Lista documentos não excluídos; exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Documentos retornados. |
| 403 | Membership ausente ou inativa. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/documents
Criar documento da SmartCompany
Cria documento e sua versão inicial; exige manage_tasks.
Cria documento e sua versão inicial; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name |
string | Sim | Nome de 1 a 180 caracteres. |
content |
string | Sim | Conteúdo de até 100000 caracteres. |
folder_id |
integer|null | Nao | Pasta da mesma SmartCompany. |
format |
string | Nao | markdown ou plain_text; padrão markdown. |
tags |
array | Nao | Etiquetas do documento. |
| Status | Descricao |
|---|---|
| 201 | Documento criado. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/documents/{documentId}
Excluir documento
Exclui logicamente um documento e preserva todas as versões; exige manage_tasks.
Exclui logicamente um documento e preserva todas as versões; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Documento removido. |
| 404 | Documento não encontrado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/documents/{documentId}
Consultar documento da SmartCompany
Retorna documento não excluído; exige membership ativa.
Retorna documento não excluído; exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Documento retornado. |
| 404 | Documento não encontrado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/documents/{documentId}
Atualizar metadados de documento
Atualiza somente name, folder_id, tags e format sem alterar conteúdo; exige manage_tasks.
Atualiza somente name, folder_id, tags e format sem alterar conteúdo; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Documento atualizado. |
| 404 | Documento não encontrado. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/documents/{documentId}/versions
Listar versões de documento
Lista versões do documento da mesma SmartCompany; exige membership ativa.
Lista versões do documento da mesma SmartCompany; exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Versões retornadas. |
| 404 | Documento não encontrado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/documents/{documentId}/versions
Criar versão de documento
Acrescenta versão e atualiza o documento; exige manage_tasks.
Acrescenta versão e atualiza o documento; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
content |
string | Sim | Conteúdo de até 100000 caracteres. |
format |
string | Nao | Formato da nova versão. |
| Status | Descricao |
|---|---|
| 201 | Versão criada. |
| 404 | Documento não encontrado. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/experiments
Listar experimentos
Lista experimentos da SmartCompany; exige membership ativa.
Lista experimentos da SmartCompany; exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Experimentos retornados. |
| 403 | Membership ausente ou inativa. |
| Campo | Tipo | Descricao |
|---|---|---|
experiments |
array | Experimentos explícitos. |
/api/v1/smart-companies/{id}/experiments
Criar experimento
Cria experimento e opcionalmente o vincula a hipótese da mesma SmartCompany; exige manage_tasks.
Cria experimento e opcionalmente o vincula a hipótese da mesma SmartCompany; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name |
string | Sim | Nome de 1 a 180 caracteres. |
hypothesis_id |
integer|null | Nao | Hipótese da mesma SmartCompany. |
objective |
string|null | Nao | Objetivo de até 10000 caracteres. |
method |
string|null | Nao | Método de até 10000 caracteres. |
result |
string|null | Nao | Resultado de até 10000 caracteres. |
status |
string | Nao | planned, running, completed ou cancelled. |
| Status | Descricao |
|---|---|
| 201 | Experimento criado. |
| 403 | Capability manage_tasks ausente. |
| 422 | Payload inválido ou hipótese externa. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/experiments/{experimentId}
Atualizar experimento
Atualiza campos permitidos e vínculo com hipótese da mesma SmartCompany; exige manage_tasks.
Atualiza campos permitidos e vínculo com hipótese da mesma SmartCompany; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Experimento atualizado. |
| 404 | Experimento não encontrado na SmartCompany. |
| 422 | Payload inválido ou hipótese externa. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/hypotheses
Listar hipóteses
Lista hipóteses não excluídas; exige membership ativa.
Lista hipóteses não excluídas; exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Hipóteses retornadas. |
| 403 | Membership ausente ou inativa. |
| Campo | Tipo | Descricao |
|---|---|---|
hypotheses |
array | Hipóteses explícitas. |
/api/v1/smart-companies/{id}/hypotheses
Criar hipótese
Cria hipótese com status formal; exige manage_tasks.
Cria hipótese com status formal; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
title |
string | Sim | Título de 1 a 180 caracteres. |
statement |
string|null | Nao | Enunciado de até 10000 caracteres. |
status |
string | Nao | draft, testing, validated, invalidated ou archived. |
| Status | Descricao |
|---|---|
| 201 | Hipótese criada. |
| 403 | Capability manage_tasks ausente. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/hypotheses/{hypothesisId}
Excluir hipótese
Exclui logicamente a hipótese e desvincula experimentos; exige manage_tasks.
Exclui logicamente a hipótese e desvincula experimentos; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Hipótese removida. |
| 404 | Hipótese não encontrada na SmartCompany. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/hypotheses/{hypothesisId}
Atualizar hipótese
Atualiza título, enunciado ou status; exige manage_tasks.
Atualiza título, enunciado ou status; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Hipótese atualizada. |
| 404 | Hipótese não encontrada na SmartCompany. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/integrity-ledger
Listar ledger de integridade da SmartCompany
Retorna os eventos encadeados de cadastro, alteração e publicação da SmartCompany. Exige vínculo oficial ativo como Founder ou Co-Founder; o endpoint não aceita nome de tabela arbitrário.
Retorna os eventos encadeados de cadastro, alteração e publicação da SmartCompany. Exige vínculo oficial ativo como Founder ou Co-Founder; o endpoint não aceita nome de tabela arbitrário.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
limit |
integer | Nao | Quantidade de eventos, entre 1 e 200; padrão 100. |
offset |
integer | Nao | Deslocamento da paginação; padrão 0. |
| Status | Descricao |
|---|---|
| 200 | Ledger de integridade retornado com sucesso. |
| 401 | Token de acesso ausente ou inválido. |
| 403 | Somente Founder ou Co-Founder ativo pode consultar o ledger. |
| 404 | SmartCompany não encontrada. |
| 422 | Parâmetros de paginação inválidos. |
| Campo | Tipo | Descricao |
|---|---|---|
entity_type |
string | Tipo fixo smart_company. |
entity_id |
integer | Identificador da SmartCompany. |
entries |
array | Eventos em ordem de sequência, com snapshot, diff e hashes. |
verification.valid |
boolean | Indica se a cadeia completa foi verificada com sucesso. |
/api/v1/smart-companies/{id}/investors-negotiators
Listar negociadores de investidores da SmartCompany
Retorna os negociadores de investidores vinculados a uma SmartCompany.
Retorna os negociadores de investidores vinculados a uma SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/investors-negotiators
Criar negociador de investidores da SmartCompany
Cria um registro de negociador de investidores para uma SmartCompany.
Cria um registro de negociador de investidores para uma SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Validation failed. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/investors-negotiators/{participantId}
Excluir negociador de investidores da SmartCompany
Exclui um registro de negociador de investidores.
Exclui um registro de negociador de investidores.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Exclusao concluida com sucesso. |
| 404 | Investor negotiator not found. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/investors-negotiators/{participantId}
Atualizar negociador de investidores da SmartCompany
Atualiza um registro de negociador de investidores.
Atualiza um registro de negociador de investidores.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 404 | Investor negotiator not found. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/lean-canvas
Consultar Lean Canvas
Retorna as nove seções explícitas do Lean Canvas. Exige membership ativa.
Retorna as nove seções explícitas do Lean Canvas. Exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Canvas retornado. |
| 403 | Membership ausente ou inativa. |
| Campo | Tipo | Descricao |
|---|---|---|
lean_canvas |
object|null | Canvas explícito ou null. |
/api/v1/smart-companies/{id}/lean-canvas
Atualizar Lean Canvas
Substitui seções explícitas do Lean Canvas; exige manage_tasks.
Substitui seções explícitas do Lean Canvas; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
problem |
string|null | Nao | Problema, até 10000 caracteres. |
solution |
string|null | Nao | Solução, até 10000 caracteres. |
unique_value_proposition |
string|null | Nao | Proposta de valor, até 10000 caracteres. |
unfair_advantage |
string|null | Nao | Vantagem diferencial, até 10000 caracteres. |
customer_segments |
string|null | Nao | Segmentos de clientes, até 10000 caracteres. |
channels |
string|null | Nao | Canais, até 10000 caracteres. |
key_metrics |
string|null | Nao | Métricas-chave, até 10000 caracteres. |
cost_structure |
string|null | Nao | Estrutura de custos, até 10000 caracteres. |
revenue_streams |
string|null | Nao | Fontes de receita, até 10000 caracteres. |
| Status | Descricao |
|---|---|
| 200 | Canvas atualizado. |
| 403 | Capability manage_tasks ausente. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/member-select-options
Listar opções e permissões dos membros
Retorna cargos, funções e o catálogo explícito de permissões que pode ser salvo em permissionScope ao incluir ou alterar um membro.
Retorna cargos, funções e o catálogo explícito de permissões que pode ser salvo em permissionScope ao incluir ou alterar um membro.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Opções retornadas com sucesso. |
| 404 | SmartCompany não encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
permissions |
array | Permissões disponíveis com chave, nome e descrição. |
/api/v1/smart-companies/{id}/members
Listar membros internos da SmartCompany
Retorna membros internos oficiais com usuário resumido, função, escopo efetivo, alocações e estado, somente no contexto autorizado.
Retorna membros internos oficiais com usuário resumido, função, escopo efetivo, alocações e estado, somente no contexto autorizado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Membros retornados com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|---|---|
members[].user |
object | Usuário resumido com id, nome, username e avatar permitido. |
/api/v1/smart-companies/{id}/members
Adicionar membro interno à SmartCompany
Adiciona um membro interno oficial após aplicar o limite de membros da equipe da conta. Após a criação, somente CORE_CONTRIBUTOR com função ADMIN ou MANAGER pode ser adicionado.
Adiciona um membro interno oficial após aplicar o limite de membros da equipe da conta. Após a criação, somente CORE_CONTRIBUTOR com função ADMIN ou MANAGER pode ser adicionado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 201 | Member added successfully. |
| 403 | Access denied or the effective account teamMembers limit was reached. |
| 422 | Validation failed. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/members/{memberId}
Remover membro interno da SmartCompany
Remove um membro interno oficial que pode ser alterado. FOUNDER, CO_FOUNDER e MASTER são protegidos.
Remove um membro interno oficial que pode ser alterado. FOUNDER, CO_FOUNDER e MASTER são protegidos.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Member removed successfully. |
| 403 | Protected member or access denied. |
| 404 | Member not found. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/members/{memberId}
Atualizar membro interno da SmartCompany
Atualiza os campos editáveis de um membro interno oficial.
Atualiza os campos editáveis de um membro interno oficial.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 403 | Acesso negado. |
| 404 | Member not found. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/members/{memberId}/revoke
Revogar indicação de membro interno da SmartCompany
Revoga uma indicação pendente de membro interno dentro do prazo de validação.
Revoga uma indicação pendente de membro interno dentro do prazo de validação.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Nomination revoked successfully. |
| 403 | Access denied or validation window expired. |
| 422 | Nomination cannot be revoked. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/metrics
Consultar metricas da SmartCompany
Retorna metricas de execucao, evidencias, validacao, capital, impacto e coordenacao.
Retorna metricas de execucao, evidencias, validacao, capital, impacto e coordenacao.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 404 | SmartCompany nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
metrics |
object | Metricas da SmartCompany. |
/api/v1/smart-companies/{id}/milestones
Listar milestones da SmartCompany
Retorna milestones da SmartCompany somente para membros ativos.
Retorna milestones da SmartCompany somente para membros ativos.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 403 | Usuário não é membro da SmartCompany. |
| Campo | Tipo | Descricao |
|---|---|---|
milestones |
array | Milestones da SmartCompany. |
/api/v1/smart-companies/{id}/milestones/create
Criar milestone da SmartCompany
Cria um marco no roadmap da SmartCompany. Exige a permissão manage_tasks.
Cria um marco no roadmap da SmartCompany. Exige a permissão manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
title |
string | Sim | Titulo da milestone. |
description |
string | Nao | Descricao da milestone. |
project_id |
integer|null | Nao | Projeto não excluído da mesma SmartCompany. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
milestone.id |
integer | Identificador da milestone. |
/api/v1/smart-companies/{id}/milestones/{milestoneId}
Atualizar milestone da SmartCompany
Atualiza metadados, ordem ou status permitido de milestone; exige manage_tasks.
Atualiza metadados, ordem ou status permitido de milestone; exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Milestone atualizada. |
| 404 | Milestone não encontrada. |
| 409 | Transição bloqueada por tarefas/rewards concluídos. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/milestones/{milestoneId}/complete
Concluir milestone da SmartCompany
Marca uma milestone como concluida. Exige a permissao de tarefas.
Marca uma milestone como concluida. Exige a permissao de tarefas.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Milestone concluida com sucesso. |
| 404 | Milestone nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/smart-companies/{id}/open-contributors
Listar contribuidores abertos da SmartCompany
Retorna os contribuidores externos abertos vinculados a uma SmartCompany.
Retorna os contribuidores externos abertos vinculados a uma SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/open-contributors
Criar contribuidor aberto da SmartCompany
Cria um registro de contribuidor externo aberto para uma SmartCompany.
Cria um registro de contribuidor externo aberto para uma SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Validation failed. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/open-contributors/{participantId}
Atualizar contribuidor aberto da SmartCompany
Atualiza um registro de contribuidor externo aberto.
Atualiza um registro de contribuidor externo aberto.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 404 | Open contributor not found. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/participants
Listar participantes da SmartCompany
Retorna participantes de uma SmartCompany visivel ao solicitante. Exige autenticacao.
Retorna participantes de uma SmartCompany visivel ao solicitante. Exige autenticacao.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
participants |
array | Participantes da SmartCompany. |
next_cursor |
string|null | Cursor para a proxima pagina. |
/api/v1/smart-companies/{id}/participants
Adicionar participante da SmartCompany
Adiciona participante interno. Para role=co_founder, inclui ou promove co-founder somente quando o solicitante é o Founder ativo; demais roles seguem o fluxo de CORE_CONTRIBUTOR.
Adiciona participante interno. Para role=co_founder, inclui ou promove co-founder somente quando o solicitante é o Founder ativo; demais roles seguem o fluxo de CORE_CONTRIBUTOR.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
user_id |
integer | Sim | Identificador do usuario a adicionar a SmartCompany. |
role |
string | Nao | Para co_founder, exige Founder ativo e promove/inclui co-founder com função ADMIN ou MANAGER; os demais aliases definem CORE_CONTRIBUTOR. |
user_type |
string | Nao | Tipo legado de participante. |
function |
string | Nao | Função operacional canônica: ADMIN ou MANAGER para participante interno. |
operationalFunction |
string | Nao | Alias de function. |
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. |
permissionScope |
array|string | Nao | Alias de permissions; toda chave deve existir no catálogo de permissões. |
permission_scope |
array|string | Nao | Alias snake_case de permissionScope. |
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. |
| Status | Descricao |
|---|---|
| 201 | Participante adicionado com sucesso. |
| 403 | Access denied or the effective account teamMembers limit was reached. |
| 409 | Ja existe um participante nao removido para este usuario. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
member.id |
integer | Identificador canônico do participante interno. |
member.permissionScope |
array | Permissões efetivas persistidas. |
member.status |
string | Status canônico do participante. |
/api/v1/smart-companies/{id}/participants/accept
Aceitar convite da SmartCompany
Aceita o convite do usuario autenticado para a SmartCompany.
Aceita o convite do usuario autenticado para a SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Aceite concluido com sucesso. |
| 404 | Nenhum convite pendente foi encontrado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/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.
Cria ou atualiza convite de participante da SmartCompany. Exige a permissao de gerenciar equipe.
| 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. |
| Status | Descricao |
|---|---|
| 201 | Participante adicionado com sucesso. |
| 409 | Ja existe um participante nao removido para este usuario. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/smart-companies/{id}/participants/remove
Remover participante da SmartCompany
Remove um participante da SmartCompany. Exige a permissao de gerenciar equipe.
Remove um participante da SmartCompany. Exige a permissao de gerenciar equipe.
| 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. |
| Status | Descricao |
|---|---|
| 200 | Participante removido com sucesso. |
| 404 | Participante nao encontrado. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/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.
Remove participante da SmartCompany. Exige a permissao Gerir Equipe. O ultimo founder nao pode ser removido.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Participante removido com sucesso. |
| 400 | O owner ou ultimo founder nao pode ser removido. |
| 404 | Participante nao encontrado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/smart-companies/{id}/participants/{participantId}
Atualizar participante da SmartCompany
Atualiza participante da SmartCompany. Exige a permissao Gerir Equipe.
Atualiza participante da SmartCompany. Exige a permissao Gerir Equipe.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
role |
string | Nao | Alias legado para definir a função de CORE_CONTRIBUTOR. |
user_type |
string | Nao | Tipo legado de participante. |
function |
string | Nao | Função operacional canônica: ADMIN ou MANAGER. |
operationalFunction |
string | Nao | Alias de function. |
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. |
permissionScope |
array|string | Nao | Alias de permissions; toda chave deve existir no catálogo de permissões. |
permission_scope |
array|string | Nao | Alias snake_case de permissionScope. |
participation_percentage |
number | Nao | Percentual de participacao. |
equity_percentage |
number | Nao | Percentual de equity. |
governance_weight |
number | Nao | Peso de governanca. |
status |
string | Nao | Status canônico: PENDING, ACTIVE, REVOKED ou REMOVED. |
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 404 | Participante nao encontrado. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
member.id |
integer | Identificador canônico do participante interno. |
member.permissionScope |
array | Permissões efetivas persistidas. |
member.status |
string | Status canônico do participante. |
/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.
Atualiza papel, cargo, alocacao, permissoes ou status de convite do participante. Exige a permissao de gerenciar equipe.
| 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. |
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 404 | Participante nao encontrado. |
| 422 | Falha de validacao no payload enviado. |
| 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. |
/api/v1/smart-companies/{id}/partners
Listar parceiros da SmartCompany
Retorna os parceiros vinculados a uma SmartCompany.
Retorna os parceiros vinculados a uma SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Acesso negado. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/partners
Criar parceiro da SmartCompany
Cria um registro de parceiro para uma SmartCompany.
Cria um registro de parceiro para uma SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Validation failed. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/partners/{participantId}
Excluir parceiro da SmartCompany
Exclui um registro de parceiro.
Exclui um registro de parceiro.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Exclusao concluida com sucesso. |
| 404 | Partner not found. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/partners/{participantId}
Atualizar parceiro da SmartCompany
Atualiza um registro de parceiro.
Atualiza um registro de parceiro.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 404 | Partner not found. |
| Campo | Tipo | Descricao |
|---|
/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.
Retorna parcerias e convites persistidos associados a SmartCompany. Quando nao ha registros, retorna dados vazios.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| 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. |
| 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. |
/api/v1/smart-companies/{id}/projects
Listar projetos da SmartCompany
Lista paginada de projetos não excluídos. Exige membership ativa.
Lista paginada de projetos não excluídos. Exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Projetos retornados. |
| 403 | Usuário não é membro da SmartCompany. |
| Campo | Tipo | Descricao |
|---|---|---|
projects |
array | Projetos com contagens de tarefas e milestones. |
pagination |
object | Paginação por limit e offset. |
/api/v1/smart-companies/{id}/projects
Criar projeto na SmartCompany
Cria projeto com status formal e respeita o limite de projetos do plano. Exige manage_tasks.
Cria projeto com status formal e respeita o limite de projetos do plano. Exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name |
string | Sim | Nome entre 1 e 180 caracteres. |
description |
string|null | Nao | Descrição de até 10000 caracteres. |
status |
string | Nao | planned, active, on_hold, completed ou archived. |
goal |
string|null | Nao | Objetivo de até 10000 caracteres. |
starts_at |
date|null | Nao | Data YYYY-MM-DD. |
due_at |
date|null | Nao | Data YYYY-MM-DD igual ou posterior a starts_at. |
sort_order |
integer | Nao | Ordem não negativa. |
| Status | Descricao |
|---|---|
| 201 | Projeto criado. |
| 403 | Capability insuficiente ou limite do plano. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/projects/{projectId}
Excluir projeto da SmartCompany
Faz soft delete do projeto. Exige manage_tasks e bloqueia projetos com tarefas ou milestones ativas.
Faz soft delete do projeto. Exige manage_tasks e bloqueia projetos com tarefas ou milestones ativas.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Projeto removido. |
| 409 | Projeto possui vínculos ativos. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/projects/{projectId}
Consultar projeto da SmartCompany
Retorna um projeto não excluído. Exige membership ativa.
Retorna um projeto não excluído. Exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Projeto retornado. |
| 404 | Projeto não encontrado na SmartCompany. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/projects/{projectId}
Atualizar projeto da SmartCompany
Atualiza os metadados editáveis de um projeto. Exige manage_tasks.
Atualiza os metadados editáveis de um projeto. Exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Projeto atualizado. |
| 403 | Capability insuficiente. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/protocol/sc-id
Mintar ou enfileirar SC-ID da SmartCompany
Cria uma ação de protocolo idempotente para emissão do SC-ID na Polygon Amoy após aplicar o limite de registros da conta. Se a wallet do solicitante não existir, retorna o fluxo de provisionamento da wallet.
Cria uma ação de protocolo idempotente para emissão do SC-ID na Polygon Amoy após aplicar o limite de registros da conta. Se a wallet do solicitante não existir, retorna o fluxo de provisionamento da wallet.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
chain |
string | Nao | Nome ou identificador da chain alvo. |
| Status | Descricao |
|---|---|
| 202 | Mint de SC-ID enfileirado ou provisioning de wallet retornado. |
| 403 | Access denied or the effective account registrations limit was reached. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
protocol_action.id |
integer | Identificador da acao de protocolo. |
/api/v1/smart-companies/{id}/publish
Publicar uma SmartCompany
Publica atomicamente, definindo status active, visibility public, lifecycle GROW e a data da primeira publicação. Repetições preservam published_at e não duplicam efeitos.
Publica atomicamente, definindo status active, visibility public, lifecycle GROW e a data da primeira publicação. Repetições preservam published_at e não duplicam efeitos.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | SmartCompany publicada ou publicação anterior confirmada. |
| 403 | Solicitante não autorizado. |
| 404 | SmartCompany não encontrada. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/rewards
Listar rewards da SmartCompany
Retorna rewards da SmartCompany somente para membros ativos.
Retorna rewards da SmartCompany somente para membros ativos.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 403 | Usuário não é membro da SmartCompany. |
| Campo | Tipo | Descricao |
|---|---|---|
rewards |
array | Lancamentos de rewards da SmartCompany. |
/api/v1/smart-companies/{id}/roadmap
Consultar roadmap da SmartCompany
Projeção ordenada de projetos, milestones e tarefas resumidas. Exige membership ativa.
Projeção ordenada de projetos, milestones e tarefas resumidas. Exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Roadmap retornado. |
| 403 | Usuário não é membro da SmartCompany. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/squads
Listar squads
Exige membership ativa.
Exige membership ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/squads
Criar squad
Exige manage_tasks.
Exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/squads/{squadId}
Excluir squad
Exige manage_tasks.
Exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/squads/{squadId}
Atualizar squad
Exige manage_tasks.
Exige manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/summary
Consultar resumo da SmartCompany
Retorna um resumo da SmartCompany seguro para publico.
Retorna um resumo da SmartCompany seguro para publico.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 404 | SmartCompany nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
summary |
object | Resumo seguro para publico. |
/api/v1/smart-companies/{id}/tasks
Listar tarefas da SmartCompany
Retorna tarefas da SmartCompany, opcionalmente filtradas pelo parametro status.
Retorna tarefas da SmartCompany, opcionalmente filtradas pelo parametro status.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
tasks |
array | Tarefas da SmartCompany. |
/api/v1/smart-companies/{id}/tasks/create
Criar tarefa da SmartCompany
Cria uma tarefa com recompensa e configurações de atribuição. Exige a permissão manage_tasks na associação.
Cria uma tarefa com recompensa e configurações de atribuição. Exige a permissão manage_tasks na associação.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
title |
string | Sim | Titulo da tarefa. |
description |
string | Nao | Descricao da tarefa. |
project_id |
integer|null | Nao | Projeto não excluído da mesma SmartCompany. |
visibility |
string | Nao | private, company, pool ou public. |
required_capabilities |
array | Nao | Lista declarativa de capabilities. |
application_deadline |
datetime|null | Nao | Prazo opcional de candidatura. |
estimated_reward |
number|null | Nao | Estimativa não negativa, sem substituir rewards oficiais. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
task.id |
integer | Identificador da tarefa. |
/api/v1/smart-companies/{id}/tasks/{taskId}
Consultar tarefa da SmartCompany
Retorna uma tarefa e seu historico de evidencias.
Retorna uma tarefa e seu historico de evidencias.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 404 | Tarefa nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
task |
object | Dados da tarefa da SmartCompany. |
/api/v1/smart-companies/{id}/tasks/{taskId}
Atualizar metadados editáveis da tarefa
Atualiza somente título, descrição, categoria, prazo, milestone, projeto e valores de recompensa. Exige manage_tasks; responsável e status usam fluxos próprios.
Atualiza somente título, descrição, categoria, prazo, milestone, projeto e valores de recompensa. Exige manage_tasks; responsável e status usam fluxos próprios.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
title |
string | Nao | Título não vazio, até 180 caracteres. |
description |
string|null | Nao | Descrição com até 10000 caracteres. |
category |
string | Nao | Categoria com até 60 caracteres. |
due_date |
date|null | Nao | Prazo no formato YYYY-MM-DD. |
milestone_id |
integer|null | Nao | Milestone da mesma SmartCompany. |
project_id |
integer|null | Nao | Projeto não excluído da mesma SmartCompany. |
reward_tokens |
number | Nao | Recompensa em tokens, não negativa. |
reward_usd |
number | Nao | Recompensa em USD, não negativa. |
| Status | Descricao |
|---|---|
| 200 | Tarefa atualizada com sucesso. |
| 403 | Capability insuficiente. |
| 422 | Payload inválido ou tarefa finalizada. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/tasks/{taskId}/accept
Aceitar tarefa da SmartCompany
Permite ao participante com a permissão tasks assumir uma tarefa interna sem responsável, ou a qualquer usuário autenticado assumir uma task public ou pool aberta e sem responsável.
Permite ao participante com a permissão tasks assumir uma tarefa interna sem responsável, ou a qualquer usuário autenticado assumir uma task public ou pool aberta e sem responsável.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Aceite concluido com sucesso. |
| 404 | Tarefa nao encontrada ou nao atribuida ao usuario. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/smart-companies/{id}/tasks/{taskId}/applications
Listar candidaturas da tarefa
Exige manage_tasks; candidatos não são expostos publicamente.
Exige manage_tasks; candidatos não são expostos publicamente.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Candidaturas retornadas. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/tasks/{taskId}/applications
Candidatar-se a tarefa
Disponível somente para tarefa pool ou public aberta; uma candidatura por usuário.
Disponível somente para tarefa pool ou public aberta; uma candidatura por usuário.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
message |
string|null | Nao | Mensagem opcional. |
| Status | Descricao |
|---|---|
| 201 | Candidatura criada. |
| 409 | Tarefa fechada, prazo encerrado ou candidatura duplicada. |
| Campo | Tipo | Descricao |
|---|
/api/v1/smart-companies/{id}/tasks/{taskId}/approve
Aprovar evidencia da tarefa
Aprova a evidência enviada e conclui o fluxo de recompensa. Exige a permissão manage_tasks.
Aprova a evidência enviada e conclui o fluxo de recompensa. Exige a permissão manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Aprovacao concluida com sucesso. |
| 404 | Evidencia da tarefa nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/smart-companies/{id}/tasks/{taskId}/assign
Atribuir tarefa da SmartCompany
Vincula um participante ou contribuidor à tarefa. Exige a permissão manage_tasks na associação.
Vincula um participante ou contribuidor à tarefa. Exige a permissão manage_tasks na associação.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
user_id |
integer | Sim | Identificador do usuario ao qual atribuir a tarefa. |
| Status | Descricao |
|---|---|
| 200 | Atribuicao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/smart-companies/{id}/tasks/{taskId}/reject
Rejeitar evidencia da tarefa
Rejeita a evidência enviada e registra a justificativa. Exige a permissão manage_tasks.
Rejeita a evidência enviada e registra a justificativa. Exige a permissão manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
reviewer_note |
string | Sim | Motivo da rejeicao da evidencia. |
note |
string | Nao | Alias de reviewer_note. |
| Status | Descricao |
|---|---|
| 200 | Rejeicao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/smart-companies/{id}/tasks/{taskId}/status
Atualizar status da tarefa
Atualiza o status da tarefa conforme as transições permitidas. Exige a permissão manage_tasks.
Atualiza o status da tarefa conforme as transições permitidas. Exige a permissão manage_tasks.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
status |
string | Sim | Novo status da tarefa. |
| Status | Descricao |
|---|---|
| 200 | Atualizacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/smart-companies/{id}/tasks/{taskId}/submit
Submeter evidencia da tarefa
Permite ao responsável vinculado e com a permissão tasks incluir evidências na tarefa.
Permite ao responsável vinculado e com a permissão tasks incluir evidências na tarefa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
description |
string | Nao | Descrição da evidência; ela ou content_url deve ser informada. |
content_url |
string | Nao | URL da evidência; ela ou description deve ser informada. |
upload_id |
integer | Nao | Identificador positivo de upload do próprio usuário, sem vínculo conflitante de tarefa ou SmartCompany. |
| Status | Descricao |
|---|---|
| 200 | Envio concluido com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
evidence_id |
integer | Identificador da evidencia. |
/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.
Retorna valores de tokenomics calculados pelo backend. O front-end nao e a fonte de verdade para supply, fees ou alocacoes.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 404 | SmartCompany nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
tokenomics |
object | Projecao calculada de tokenomics. |
/api/v1/smart-companies/{id}/tokenomics/events
Listar eventos de tokenomics
Retorna o stream de eventos de tokenomics da SmartCompany.
Retorna o stream de eventos de tokenomics da SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 404 | SmartCompany nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
events |
array | Stream de eventos de tokenomics. |
/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.
Bloqueia supply e dados publicados do ticker, salvo desbloqueio futuro por processo admin ou de protocolo. Exige tokenomics:manage.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
reason |
string | Nao | Motivo opcional de lock. |
| Status | Descricao |
|---|---|
| 200 | Bloqueio concluido com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
tokenomics.locked |
boolean | Indica se a tokenomics esta bloqueada. |
/api/v1/smart-companies/{id}/treasury
Listar movimentos de tesouraria da SmartCompany
Retorna movimentos e saldos de tesouraria de uma SmartCompany.
Retorna movimentos e saldos de tesouraria de uma SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
treasury |
array | Movimentos e saldos de tesouraria. |
/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.
Cria um movimento de tesouraria para a SmartCompany. Exige a permissao de Tesouro e Financas.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
amount |
number | Sim | Valor do movimento. |
type |
string | Sim | Tipo de movimento. |
reason |
string | Sim | Motivo do movimento de tesouraria. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
movement.id |
integer | Identificador do movimento de tesouraria. |
/api/v1/smart-companies/{id}/treasury/{movementId}
Estornar movimento de tesouraria da SmartCompany
Cria um estorno append-only para o movimento de tesouraria. Exige Tesouro e Finanças e motivo.
Cria um estorno append-only para o movimento de tesouraria. Exige Tesouro e Finanças e motivo.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
reason |
string | Sim | Motivo do estorno, com no máximo 255 caracteres. |
| Status | Descricao |
|---|---|
| 200 | Treasury movement reversed successfully. |
| 404 | Movimento de tesouraria nao encontrado. |
| 422 | Reason is missing or invalid. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Resultado da operação. |
reversal_id |
integer | Identificador do lançamento de estorno. |
original_movement_id |
integer | Identificador do lançamento original. |
/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.
Retorna rendimentos de vault persistidos da SmartCompany. Quando nao ha registros, retorna dados vazios.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| 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. |
| 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. |
/api/v1/smart-companies/{id}/vaults
Listar vaults da empresa
Retorna dados append-only de vault de uma SmartCompany.
Retorna dados append-only de vault de uma SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
vaults |
array | Lancamentos de ledger dos vaults da empresa. |
/api/v1/store/products
Listar produtos da loja
Retorna produtos ativos persistidos no catalogo da loja. Quando nao ha produtos configurados, retorna dados vazios.
Retorna produtos ativos persistidos no catalogo da loja. Quando nao ha produtos configurados, retorna dados vazios.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
products |
array | Produtos disponiveis da Store. |
next_cursor |
string|null | Cursor para a proxima pagina, quando existir. |
/api/v1/subscriptions/my
Consultar assinatura do usuario autenticado
Retorna o plano de assinatura atual do usuario autenticado.
Retorna o plano de assinatura atual do usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
subscription |
object | Assinatura do usuario autenticado. |
/api/v1/subscriptions/plans
Listar planos de assinatura
Retorna planos de assinatura disponiveis.
Retorna planos de assinatura disponiveis.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| Campo | Tipo | Descricao |
|---|---|---|
plans |
array | Planos disponiveis. |
/api/v1/subscriptions/upgrade
Atualizar assinatura do usuario autenticado
Planos pagos exigem payment_id Stripe já confirmado pelo webhook. O caminho legado é restrito a planos gratuitos.
Planos pagos exigem payment_id Stripe já confirmado pelo webhook. O caminho legado é restrito a planos gratuitos.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
source_provider |
string | Nao | stripe para consultar pagamento confirmado. |
payment_id |
integer | Nao | Pagamento Stripe do usuário, obrigatório com source_provider=stripe. |
plan_key |
string | Nao | Plano gratuito de destino no fluxo legado; dispensado ao consultar payment_id Stripe. |
billing_cycle |
string | Nao | Ciclo de cobranca, quando aplicavel. |
| Status | Descricao |
|---|---|
| 200 | Assinatura atualizada com sucesso. |
| 409 | Plano pago exige confirmação Stripe. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
subscription.id |
integer | Identificador da assinatura. |
/api/v1/system/menus
Listar menus visiveis do sistema
Retorna menus visiveis ao usuario autenticado.
Retorna menus visiveis ao usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| Campo | Tipo | Descricao |
|---|
/api/v1/task-applications/{applicationId}
Decidir ou retirar candidatura
Aceite e rejeição exigem manage_tasks; retirada pertence ao candidato pendente.
Aceite e rejeição exigem manage_tasks; retirada pertence ao candidato pendente.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
status |
string | Sim | accepted, rejected ou withdrawn. |
| Status | Descricao |
|---|---|
| 200 | Candidatura atualizada. |
| Campo | Tipo | Descricao |
|---|
/api/v1/tasks/{id}/reward
Consultar reward da tarefa
Retorna reward da task somente para membros da SmartCompany vinculada.
Retorna reward da task somente para membros da SmartCompany vinculada.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Usuário não é membro da SmartCompany da task. |
| 404 | Reward nao encontrado. |
| Campo | Tipo | Descricao |
|---|---|---|
reward |
object | Dados de reward da tarefa. |
/api/v1/tasks/{taskId}/evidence
Listar evidencias da tarefa
Retorna evidências da task para membros da SmartCompany vinculada.
Retorna evidências da task para membros da SmartCompany vinculada.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 403 | Usuário não é membro da SmartCompany da task. |
| Campo | Tipo | Descricao |
|---|---|---|
evidence |
array | Evidencias da tarefa. |
/api/v1/tasks/{taskId}/evidence
Submeter evidencia
Submete evidencia de forma atomica e inicia o fluxo de revisao sem liberar rewards.
Submete evidencia de forma atomica e inicia o fluxo de revisao sem liberar rewards.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
description |
string | Nao | Descrição da evidência; ela ou content_url deve ser informada. |
content_url |
string | Nao | URL da evidência; ela ou description deve ser informada. |
upload_id |
integer | Nao | Identificador positivo de upload do próprio usuário, sem vínculo conflitante de tarefa ou SmartCompany. |
| Status | Descricao |
|---|---|
| 201 | Envio concluido com sucesso. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
evidence_id |
integer | Identificador da evidencia. |
/api/v1/tasks/{taskId}/proof-of-build
Consultar proof of build
Retorna o Proof of Build para membros da SmartCompany vinculada à task.
Retorna o Proof of Build para membros da SmartCompany vinculada à task.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 403 | Usuário não é membro da SmartCompany da task. |
| 404 | Proof of build nao encontrado. |
| Campo | Tipo | Descricao |
|---|---|---|
proof_of_build |
object | Dados de proof of build. |
/api/v1/uploads/image
Enviar imagem
Armazena uma imagem JPG, PNG ou WEBP para usuário autenticado e retorna um caminho público para logo, capa ou perfil.
Armazena uma imagem JPG, PNG ou WEBP para usuário autenticado e retorna um caminho público para logo, capa ou perfil.
| 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. |
| Status | Descricao |
|---|---|
| 201 | Upload concluido com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 422 | Falha de validacao ou nenhum dado de imagem foi enviado. |
| 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. |
/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.
Valida o codigo de 6 digitos enviado. Se estiver invalido ou expirado, a API gera e envia novo codigo automaticamente.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
email |
string | Sim | Email cadastrado do usuario. |
activation_code |
string | Sim | Codigo de ativacao de 6 digitos recebido por email. |
| 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. |
| 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. |
/api/v1/users/contributions
Consultar contribuicoes do usuario autenticado
Retorna historico de contribuicoes e participacao em tarefas do usuario autenticado.
Retorna historico de contribuicoes e participacao em tarefas do usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/users/favorites
Listar SmartCompanies favoritas
Retorna SmartCompanies favoritas do usuario autenticado.
Retorna SmartCompanies favoritas do usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 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. |
/api/v1/users/favorites/{id}/toggle
Alternar favorito da SmartCompany
Adiciona ou remove uma SmartCompany dos favoritos do usuario autenticado.
Adiciona ou remove uma SmartCompany dos favoritos do usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Alternancia concluida com sucesso. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/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.
Retorna o perfil completo do usuario ativo autenticado. O token deve ser enviado no header Authorization Bearer.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|
/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.
Retorna o perfil completo do usuario ativo autenticado. O token deve ser enviado no header Authorization Bearer.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 422 | Falha de validacao no payload enviado. |
| 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. |
/api/v1/users/me/account-settings
Atualizar configurações de conta
Persiste as preferências de notificações, privacidade e segurança apresentadas no modal de perfil.
Persiste as preferências de notificações, privacidade e segurança apresentadas no modal de perfil.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
notification_preferences |
object | Nao | Preferências de notificações do modal. |
privacy_preferences |
object | Nao | Preferências de privacidade do modal. |
security_alerts_enabled |
boolean | Nao | Alertas de login. |
two_factor_enabled |
boolean | Nao | Estado visual da verificação em dois passos. |
| Status | Descricao |
|---|---|
| 200 | Configurações atualizadas. |
| 401 | Token inválido. |
| 422 | Payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/users/me/active-company
Salvar a SmartCompany ativa do usuário autenticado
Salva a última SmartCompany selecionada pelo usuário autenticado após validar a propriedade ou a participação ativa.
Salva a última SmartCompany selecionada pelo usuário autenticado após validar a propriedade ou a participação ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
smart_company_id |
integer | Sim | SmartCompany selected by the authenticated user. |
| Status | Descricao |
|---|---|
| 200 | Active SmartCompany persisted successfully. |
| 401 | Token ausente, invalido ou expirado. |
| 403 | SmartCompany is not owned by or actively associated with the user. |
| 422 | Invalid SmartCompany identifier. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
active_company_id |
integer | Persisted SmartCompany identifier. |
/api/v1/users/me/assigned-tasks
Listar tasks atribuídas ao usuário autenticado
Retorna as tasks atualmente atribuídas ao usuário autenticado, com dados suficientes para a área Minhas Tasks e para agrupar por SmartCompany.
Retorna as tasks atualmente atribuídas ao usuário autenticado, com dados suficientes para a área Minhas Tasks e para agrupar por SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
tasks |
array | Tasks atribuídas, incluindo SmartCompany, descrição, categoria, tokens, prazo e status. |
/api/v1/users/me/companies
Listar SmartCompanies do usuário autenticado
Retorna, de forma consistente, somente as SmartCompanies navegáveis em que o usuário autenticado é Founder ou Co-Founder, com o vínculo estrutural, capabilities efetivas e indicação da empresa ativa.
Retorna, de forma consistente, somente as SmartCompanies navegáveis em que o usuário autenticado é Founder ou Co-Founder, com o vínculo estrutural, capabilities efetivas e indicação da empresa ativa.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | SmartCompanies retornadas com Cache-Control: private, no-store e Vary: Authorization. |
| 401 | Token ausente, inválido ou expirado. |
| 500 | Falha de leitura ou consistência no banco; a resposta inclui request_id. |
| Campo | Tipo | Descricao |
|---|---|---|
companies |
array | SmartCompanies navegáveis em que o usuário é Founder ou Co-Founder. |
companies[].membership.role |
string | Papel estrutural canônico: founder, co_founder, member, contributor ou investor. Nesta listagem, somente founder ou co_founder. |
companies[].membership |
object | Papel estrutural, título, função operacional, estado e capabilities efetivas do usuário na empresa. |
companies[].is_active_company |
boolean | Indica a empresa ativa resolvida para o usuário. |
active_company_id |
integer|null | Última SmartCompany navegável selecionada ou primeira disponível como fallback, sem escrita durante o GET. |
next_cursor |
string|null | Sempre null; esta resposta retorna toda a lista navegável. |
/api/v1/users/me/investments
Listar investimentos do usuario autenticado
Retorna investimentos sandbox do usuario autenticado.
Retorna investimentos sandbox do usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
investments |
array | Investimentos do usuario autenticado. |
/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.
Retorna entradas append-only de ledger derivadas das tabelas reais de wallet, token, reward, investimento e ledger do usuario.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 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. |
/api/v1/users/me/password
Alterar senha autenticada
Valida a senha atual, grava a nova senha e revoga todas as sessões ativas.
Valida a senha atual, grava a nova senha e revoga todas as sessões ativas.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
current_password |
string | Sim | Senha atual. |
new_password |
string | Sim | Nova senha com 8 a 72 caracteres. |
| Status | Descricao |
|---|---|
| 200 | Senha alterada. |
| 422 | Senha atual ou payload inválido. |
| Campo | Tipo | Descricao |
|---|
/api/v1/users/me/rewards
Listar rewards do usuario autenticado
Retorna o ledger append-only de rewards do usuario autenticado.
Retorna o ledger append-only de rewards do usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
rewards |
array | Lancamentos do ledger de rewards. |
/api/v1/users/me/sessions
Encerrar outras sessões
Revoga todas as sessões ativas exceto a sessão que autorizou a requisição.
Revoga todas as sessões ativas exceto a sessão que autorizou a requisição.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Sessões encerradas. |
| Campo | Tipo | Descricao |
|---|
/api/v1/users/me/sessions
Listar sessões ativas
Lista somente as sessões ativas do usuário autenticado, sem expor tokens.
Lista somente as sessões ativas do usuário autenticado, sem expor tokens.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Sessões retornadas. |
| Campo | Tipo | Descricao |
|---|
/api/v1/users/me/sessions/{sessionId}
Encerrar sessão
Revoga uma sessão do próprio usuário.
Revoga uma sessão do próprio usuário.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Sessão encerrada. |
| 404 | Sessão não encontrada. |
| Campo | Tipo | Descricao |
|---|
/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.
Retorna historico de transacoes derivado de tokens, rewards, investimentos, eventos de wallet e ledger do usuario.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
transactions |
array | Transacoes normalizadas do usuario. |
next_cursor |
string|null | Cursor para a proxima pagina, quando existir. |
/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.
Retorna o status atual da wallet e enfileira provisioning quando ainda nao existe wallet ou job.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 422 | Falha de validacao no payload enviado. |
| 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. |
/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.
Cria ou reutiliza um job de provisioning sem duplicar a wallet. O usuario permanece ativo se o provider falhar.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|
| 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. |
/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.
Retorna rendimentos persistidos da wallet do usuario autenticado. Quando nao ha registros, retorna dados vazios.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 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. |
/api/v1/users/notifications
Listar notificacoes do usuario autenticado
Retorna notificacoes do usuario autenticado.
Retorna notificacoes do usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/users/notifications/read
Marcar notificacoes do usuario como lidas
Marca todas as notificacoes do usuario autenticado como lidas.
Marca todas as notificacoes do usuario autenticado como lidas.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Notificacoes marcadas como lidas. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/users/notifications/{notificationId}/read
Marcar notificacao como lida
Marca uma notificacao como lida para o usuario autenticado.
Marca uma notificacao como lida para o usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Notificacao marcada como lida. |
| 404 | Notificacao nao encontrada. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/users/portfolio
Consultar portfolio do usuario autenticado
Retorna dados de tokens, investimentos e SmartCompanies do usuario autenticado.
Retorna dados de tokens, investimentos e SmartCompanies do usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/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.
Registra uma conta inativa, salva a senha com seguranca e envia codigo de ativacao de 6 digitos por email.
| 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. |
| 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. |
| 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. |
/api/v1/users/reputation
Consultar reputacao do usuario autenticado
Retorna informacoes de reputacao e build score do usuario autenticado.
Retorna informacoes de reputacao e build score do usuario autenticado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
/api/v1/users/search
Buscar usuários
Busca usuários ativos por nome ou e-mail usando o parâmetro de consulta q. O e-mail é usado somente como critério de busca e nunca é retornado.
Busca usuários ativos por nome ou e-mail usando o parâmetro de consulta q. O e-mail é usado somente como critério de busca e nunca é retornado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
q |
string | Nao | Termo de busca; menos de 2 caracteres retorna um array users vazio. |
| Status | Descricao |
|---|---|
| 200 | Usuários retornados com sucesso. |
| 401 | Token ausente, inválido ou expirado. |
| Campo | Tipo | Descricao |
|---|---|---|
users |
array | Usuários encontrados. |
users[].id |
integer | Identificador do usuário. |
users[].name |
string|null | Nome de exibição do usuário. |
users[].username |
string|null | Nome de usuário público. |
users[].avatar_url |
string|null | Alias do caminho público da imagem de perfil. |
users[].profile_image_path |
string|null | Caminho público da imagem de perfil. |
users[].reputation_score |
integer | Pontuação de reputação do usuário. |
/api/v1/users/update
Atualizar perfil e preferências do usuário autenticado
Atualiza campos editáveis de perfil, idioma, tema, notificações e privacidade do usuário ativo autenticado. O token deve ser enviado no header Authorization Bearer.
Atualiza campos editáveis de perfil, idioma, tema, notificações e privacidade do usuário ativo autenticado. O token deve ser enviado no header Authorization Bearer.
| 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. |
| 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. |
| 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. |
/api/v1/users/{id}
Consultar perfil publico de usuario
Retorna perfil publico e informacoes de contribuicao de um usuario.
Retorna perfil publico e informacoes de contribuicao de um usuario.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 404 | Usuario nao encontrado. |
| 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. |
/api/v1/vaults/{id}/movements
Listar movimentos do vault
Retorna o ledger append-only do vault para membros ativos, incluindo unidade USD, autoria, referências de idempotência e saldo acumulado.
Retorna o ledger append-only do vault para membros ativos, incluindo unidade USD, autoria, referências de idempotência e saldo acumulado.
| Campo | Tipo | Obrigatorio | Descricao |
|---|
| Status | Descricao |
|---|---|
| 200 | Dados retornados com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 403 | Usuário não é membro da SmartCompany do vault. |
| Campo | Tipo | Descricao |
|---|---|---|
movements |
array | Lancamentos de movimento do vault. |
/api/v1/vaults/{id}/movements
Criar movimento de vault
Registra movimento append-only no vault. Exige Idempotency-Key e autoridade de tesouraria da SmartCompany.
Registra movimento append-only no vault. Exige Idempotency-Key e autoridade de tesouraria da SmartCompany.
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
Idempotency-Key |
string | Sim | Header obrigatório de idempotência. |
movement_type |
string | Sim | Tipo: credit, debit ou correction. |
amount_usd |
number | Sim | Valor em USD maior que zero. |
reason |
string | Sim | Motivo do movimento. |
| Status | Descricao |
|---|---|
| 201 | Criacao concluida com sucesso. |
| 401 | Token ausente, invalido ou expirado. |
| 403 | Usuário sem autoridade de tesouraria na SmartCompany do vault. |
| 422 | Falha de validacao no payload enviado. |
| Campo | Tipo | Descricao |
|---|---|---|
message |
string | Mensagem de resultado da operacao. |
movement_id |
integer | Identificador do movimento. |
vault_id |
integer | Identificador do vault. |