Scale Intelligence■ Docs
Docs / Reference / act: sign up

act: sign up.

The company's name, and its domain where known, from a signed-in person who belongs to no tenant to the tenant, made on the trial plan with the person as its first member and owner, in one transaction with its events

Figure 1POST /v1/act/sign_upspecified
CALLERyour app or an agentholds the keyAPI GATEWAY/v1/act/sign_up4 headersCORE: ACTrung usergrant actRECORDreads or writesCARD, 200body TenantThe input is SignUpInput. Every response carries the contract's hash.flows forwardthe result
The caller sends SignUpInput to /v1/act/sign_up. The platform returns a card whose body is Tenant.
POST/v1/act/sign_up

Sign up. The call needs the user rung under a token with the act grant, and it is served by the platform.

The route takes SignUpInput and returns a card whose body is Tenant.

Request body#

The request body is SignUpInput.

fieldtyperequirednote
companytextyesthe company’s name as the person states it
domaintextnothe company’s website, which the map from a domain reads next

Response#

The route returns a card whose body is Tenant. Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.

Headers#

headerrequiredmeaning
Scale-Scopeyesthe scope the call runs in: tenant/, then /brand/, then /strategy/
Scale-As-True-Onnothe date the facts must have been true on; defaults to now
Scale-As-Known-Onnothe date the facts must have been known on; defaults to now
Scale-Keynofor a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing

A caller needs the user rung and a token with the act grant. The platform serves this route.

Example#

The example sends the smallest body that SignUpInput allows. The build validates it against the schema of SignUpInput.

Example
curl -X POST https://api.scaleintelligence.co/v1/act/sign_up \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "company": "…" }'
import { client } from "@scale/sdk";
const answer = await client.act.sign_up({
    "company": "…"
  });
// answer.body is a Tenant. answer.foot holds the basis, the scope and the time.
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/sign_up",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "company": "…"
    }).json()
let answer: Card = client.post("https://api.scaleintelligence.co/v1/act/sign_up")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&SignUpInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.act.sign_up takes the same input and returns the same card. The tool changes data and needs a grant. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/Tenant. The tool’s page describes it.

POST /v1/act/sign_up
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json

{
  "company": "…"
}
Without a key, this page shows the request only. The request body is SignUpInput, and the route returns a card whose body is Tenant.

Claims#

claimstateroute or tool
The platform serves the route /v1/act/sign_up at contract 0476e35e6e275db5.target/v1/act/sign_up