API reference
Every route, who may call it, what it reads and how it fails, generated from the platform’s OpenAPI document. The API speaks English; your app can translate by code.
429 routes1055 error codes7 webhook events
Introduction
Every route of the Zuger API, generated from its OpenAPI document when this page was built. The API speaks English; your app can translate by code.
Base URLhttps://beta.zuger.ai
FormatJSON in, JSON out. Every body is a JSON object.
AuthenticationAuthorization: Bearer zk_live_…, a key you make in the Console under Developers.
OpenAPI/v1/openapi.json
Snapshot3545e2af, the platform commit this page was built from.
Scopes
A key holds the scopes it was made with, and calls only the routes they name. No scope approves, signs, files, pays, hires or connects a tool: those routes are marked Person, and they answer a key with 403.
runs:readruns:writeapprovals:readagents:readmemory:readmemory:writeroutines:readroutines:writeconnections:readaudit:readwebhooks:readwebhooks:writemarketplace:readfindings:readkya:readkya:write
Request and response bodies
Each route shows its request body, its parameters and what it answers, as JSON Schema from the OpenAPI document; a shape routes share opens where it is used and is listed under Schemas. Field names and their descriptions stay in English, as the API sends them.
Errors
Every failure has one shape: an error object with a type and an English message. A refusal a customer can meet also carries a stable code and its params. Show your own words for a code; show message for a code you do not know yet. How to use them.
{
"error": {
"type": "bad_request",
"message": "The hour must be a whole number from 0 to 23.",
"code": "schedule_part_whole_number",
"params": {
"part": "hour",
"min": "0",
"max": "23"
},
"field": "schedule"
}
}schemaError
Every failure has this shape.
errorErrorDetailOne failure. Other detail fields may appear; ignore what you do not know.
error
Briefs and Runs
Brief an agent, follow what it does, and read the Run that records it.
POST/v1/briefsBrief an agentruns:write
Brief an agent: the words become one Run for it. "mode": "research" makes it a research brief (more look-ups and a written report, counted as 3 Runs); "web": true lets it search the public web, where the deployment has a search key. Returns where to look; the Run is the record.
agent defaults to Dom (CHIEF_OF_STAFF), who routes to the right agent. The agent must be on shift.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idempotency-keyheaderstringAny string up to 200 characters (letters, digits,
.,:,_,-). The same key from the same caller within a day is the same brief, answered again rather than started again.
Request bodyrequired
textstringWhat you want done: 2 to 4,000 characters.
minLength2· maxLength4000agentenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"documentsarray of stringIds of uploaded files for it to read (
POST /v1/documents), up to five.modeenumresearch: more look-ups and a written report, counted as 3 Runs."research"webbooleantruelets it search the public web, where the deployment has a search key.
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. The company is frozen for non-payment or being deleted; or the agent briefed is one Zuger has not switched on for the company yet (codeagent_not_switched_on_brief, the agent inparams.agent). - 409
paused_by_zuger: Zuger paused this agent or all briefs for a while (pausedsays until when). - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/briefs \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"text": "…"}'GET/v1/handoffsList hand-offs between agentsruns:read
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
limitqueryintegerHow many, newest first: 1 to 60, 20 by default.
Responses
200Success
handoffsarray of objecthandoffs
runIdstringAn id.
titlestringfromenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"toenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"becausestringWhy, up to 160 characters.
atstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/handoffs \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/runsList Runsruns:read
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
limitqueryintegerHow many, newest first: 1 to 100, 25 by default.
Responses
200Success
runsarray of RunSummaryruns
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/runs \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/runs/{id}Read a Runruns:read
An API key or a connected app never gets what Bernina held back (held is left out of a Bernina review).
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
idpathstring
Responses
200The Run end to end: its steps, what each cost, its approvals, hand-offs and Bernina's checkpoints.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. - 404No such Run in this company.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/runs/{id} \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/briefs/{id}/stepsFollow a brief's stepsruns:read
What the agent is doing on a brief you sent, step by step: the kind of work and the tools it looks things up in, never what about. Pass "after" (the "next" from the last answer); the call waits up to 15 seconds for a new step. When "finished" is true, read the Run named by "runId" for the answer. "live": false means this deployment cannot show steps: read the Run instead.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
idpathstringafterqueryintegerThe
nextfrom the last answer; 0 to start. Up to 1,000.
Responses
200Answers when there is a new step, or after 15 seconds with none.
stepsarray of objectNew steps, oldest first: the kind of work and the tools it looks things up in, never what about.
steps
phaseenumThe kind of work.
"started"·"files"·"checking"·"reading"·"lookup"·"working"·"preparing"·"writing"·"reviewing"·"finished"toolstringFor a look-up: the tool, by its catalogue name.
whatenumFor preparing: what kind of thing.
"document"·"approval"·"question"·"hire"countintegerrunIdstringThe Run, once there is one.
statusenumWhere the Run is.
AWAITING_INPUT: it asked you a question (answer withPOST /v1/runs/{id}/checkin).AWAITING_APPROVAL: something it prepared waits on a person.QUEUED_FOR_ALLOWANCE: waiting for Runs; it starts by itself when there are.HELD_BY_BERNINA: finished, its answer held for a person to release."QUEUED"·"QUEUED_FOR_ALLOWANCE"·"COST_CEILING_HIT"·"STOPPED_BY_BERNINA"·"HELD_BY_BERNINA"·"RUNNING"·"AWAITING_APPROVAL"·"AWAITING_INPUT"·"BLOCKED"·"DONE"·"FAILED"·"CANCELLED"atintegerMilliseconds since 1970.
nextintegerAsk again with
afterset to this.finishedbooleanThe Run has finished, however it ended: stop asking and read the Run.
runIdstring | nullThe Run, once the worker has started one.
livebooleanfalse: this deployment cannot show steps; read the Run instead.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. - 404Not a brief id (
brf_…). - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/briefs/{id}/steps \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/runs/{id}/checkinAnswer a Run's questionruns:write
Answer the question a Run asked (status AWAITING_INPUT): the agent carries on as a new Run with your answer. Or send "stop": true and it ends there. Zuger never asks for a password, a code or a card number.
answer is required unless stop is true.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.checkin
Parameters
idpathstring
Request body
answerstringYour answer, up to 2,000 characters. Never a card number, a password or a code.
maxLength2000stopbooleantrueends it there instead of answering.
Responses
200Success
one of
- object The agent carries on as a new Run with your answer.
answeredenumtruerunIdstringAn id.
queuedenumtrueagentenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"atintegerMilliseconds since 1970.
titlestring
- object Stopped there.
stoppedenumtruerunIdstringAn id.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. - 404No such Run.
- 409
paused_by_zuger: briefs or this agent are paused by Zuger; the question stays open. - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/runs/{id}/checkin \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"answer": "…", "stop": true}'Approvals
What agents prepared and stopped for. An API key can read the queue; only a person with a passkey decides.
GET/v1/approvalsList approvalsapprovals:read
The newest 500 of that status. An API key or a connected app never gets what Bernina held back (held is left out).
AccessAn API key with the scope approvals:read, or a person signed in.
Operationapprovals.read
Parameters
statusqueryPENDINGby default.
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
approvals:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/approvals \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/approvals/delegationRead who may decide each kind of approvalPerson
No API key can call this. It needs a person, signed in.
For each kind of approval, the least role that may decide it.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
onPlanbooleanDelegated approvals come with the plan.
editablebooleanThe caller may change them (the owner, on a plan with them).
planNamestringkeptbooleanA policy chosen on a bigger plan, still in force (it only narrows).
clearablebooleanThe owner may clear a kept policy.
categoriesarray of objectcategories
categoryenumWhat kind of decision it is.
"MONEY_OUT"·"FILING"·"CONTRACT"·"CUSTOMER_FACING"·"DATA_WRITE"·"SCHEDULING"·"INTERNAL_NOTE"·"BERNINA_REVIEW"·"UPGRADE_OFFER"·"TOPUP"labelstringaboutstringroleenumThe least role that may decide it.
"MEMBER"·"ADMIN"·"OWNER"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
PATCH/v1/approvals/delegationSet who may decide each kind of approvalPerson
No API key can call this. It needs a person, signed in.
Set who may decide each kind of approval. Owner only; Ultra.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request body
rolesmap of enum{ CATEGORY: ROLE }. A category left out, orMEMBER, is anyone in the company.{}clears the policy.
Responses
200Success
categoriesarray of objectcategories
categoryenumWhat kind of decision it is.
"MONEY_OUT"·"FILING"·"CONTRACT"·"CUSTOMER_FACING"·"DATA_WRITE"·"SCHEDULING"·"INTERNAL_NOTE"·"BERNINA_REVIEW"·"UPGRADE_OFFER"·"TOPUP"labelstringaboutstringroleenum"MEMBER"·"ADMIN"·"OWNER"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. The owner only, and choosing a policy needs Ultra.
- 429Every failure has this shape.
GET/v1/approvals/{id}Read an approvalapprovals:read
AccessAn API key with the scope approvals:read, or a person signed in.
Operationapprovals.read
Parameters
idpathstring
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
approvals:readscope. - 404No such approval in this company.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/approvals/{id} \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/approvals/{id}Decide an approval with a passkeyPerson
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Request bodyrequired
decisionenum"APPROVED"·"REJECTED"assertionobjectA passkey assertion from
POST /v1/approvals/{id}/signature, no more than two minutes old.assertion
credentialIdstringchallengestringresponseobjectThe browser's WebAuthn assertion response.
reasonstringWhy, kept with the decision.
Responses
200Success
idstringAn id.
statusenumWhere the decision is.
"PENDING"·"APPROVED"·"REJECTED"·"EXPIRED"·"CANCELLED"decidedAtstring | nullNull while a billing card waits for its payment.
humanNextStepstring | nullbillingobjectOn an UpgradeOffer or a top-up: what Stripe said (a checkout to open, a payment to confirm in place, or paid).
notestringA hire that did not start as approved: why, and what to do.
hireobjectA priced hire whose bank wants the payment confirmed in place.
hire
needsActionenumtrueclientSecretstringpublicKeystring | nulllistingIdstringAn id.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
- 404No such approval.
- 409It was decided meanwhile.
- 429Every failure has this shape.
POST/v1/approvals/{id}/doneMark an approval as carried outPerson
No API key can call this. An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
Say you have carried out something you approved. A record, not an act; done: false takes it back.
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Request body
donebooleanfalsetakes the mark back. Anything else marks it done.notestringUp to 400 characters.
maxLength400
Responses
200A record that a person carried out what they approved: nothing is filed, signed, paid or sent by it.
idstringAn id.
doneAtstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
- 404No such approval.
- 429Every failure has this shape.
POST/v1/approvals/{id}/fileFile an approval (there is no such thing)Person
Why no key
Zuger prepares; you file. No endpoint submits a return, signs a contract or moves money.
AccessA person, signed in. No API key can call this.
Operationapprovals.file
Parameters
idpathstring
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Zuger prepares; you file. No endpoint submits a return, signs a contract or moves money.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/approvals/{id}/signatureStart signing an approvalPerson
Why no key
The signature is the decision. There is no way to obtain one without the device that holds the passkey.
AccessA person, signed in. No API key can call this.
Operationapprovals.sign
Parameters
idpathstring
Request body
decisionenumWhich decision this signature is for: an approval that could not be carried out is said now, before anyone signs.
"APPROVED"·"REJECTED"
Responses
200Success
optionsobjectWebAuthn
PublicKeyCredentialRequestOptionsfor the browser, bound to this one approval.tokenstringSend back with the assertion.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403The signature is the decision. There is no way to obtain one without the device that holds the passkey.
- 404No such approval.
- 429Every failure has this shape.
Agents
The company's agents on shift.
GET/v1/agentsList agentsagents:read
AccessAn API key with the scope agents:read, or a person signed in.
Operationagents.read
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
agents:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/agents \
-H "Authorization: Bearer $ZUGER_KEY"Opportunities Coming online
Dom's Opportunities: ideas from the company's own data. Switched on one company at a time: where it is not, the read answers available: false and every write is refused with 403.
GET/v1/opportunitiesRead Dom's Opportunitiesruns:read
Dom’s Opportunities: the latest brief (what changed since the one before, the signals counted in your own data with links to their records, three to five ideas each with its evidence, size and assumptions, a first test with a success line, what agents could prepare, risks and what would prove it wrong), the ideas you saved or are testing, the tests Dom followed, the weight of the next brief (3 Runs, 5 with web research, 6 on Max and Ultra; the first one free) and its schedule; the idea pipeline (suggested, saved, testing, won, dropped), what ideas brought in this quarter from invoices and deals linked to their tests, how earlier size ranges compared, and the alerts raised between briefs (an alert’s short brief weighs 1 Run). Where Opportunities are not switched on for the company, it answers { "available": false } and nothing else.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Responses
200The Opportunities page, or { "available": false } where Opportunities are not switched on for the company.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/opportunities \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/opportunities/briefsAsk Dom for an Opportunities briefruns:write
Ask Dom for an Opportunities brief now, optionally with a focus ("ideas to fill January"). It weighs 3 Runs, 5 with web research (6 on Max and Ultra); your first one is free. The same as saying "find opportunities" to Dom. 409 while Dom is already writing one; 403 where Opportunities are not switched on.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Request body
focusstringWhat to look for ("ideas to fill January"), up to 300 characters.
maxLength300
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Opportunities are not switched on for the company. - 409Dom is already writing one.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/opportunities/briefs \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"focus": "…"}'PATCH/v1/opportunities/settingsChange how Dom writes Opportunities briefsPerson
No API key can call this. It needs a person, signed in.
How often Dom writes an Opportunities brief (weekly, monthly, on request or off), which levels of idea (IMPROVE, ADJACENT, NEW_VENTURE), whether it researches the web (market, competitors, grants), your goals and limits (goals: revenueKind recurring, one_off or either; noNewHires; marginFloorPct; markets; testBudget and its currency) and how alerts reach you (alertMode: off, fold into the next brief, or mini_brief now for 1 Run). Owner or admin. Answers the Opportunities page as GET /v1/opportunities does. 403 where Opportunities are not switched on.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request body
frequencyenumHow often;
nullgoes back to the plan's default."weekly"·"monthly"·"on_request"·"off"·nulllevelsarray of enumWhich levels of idea; at least one.
webbooleanResearch the web (market, competitors, grants), where the deployment can.
goalsobjectv1.1: the company's goals and limits. Ideas that break a limit are left out.
goals
revenueKindenum"recurring"·"one_off"·"either"noNewHiresbooleanmarginFloorPctinteger | nullWhole percent, 0 to 95.
marketsarray of stringEight at most; a comma-separated string is read too.
testBudgetnumber | nullThe most a first test may cost in cash, in whole units, 0 to 1,000,000.
currencystringThe budget's currency, three letters; needed with a budget.
alertModeenumv1.1: how alerts reach you: off, folded into the next brief (nothing more charged), or a short brief now (1 Run).
"off"·"fold"·"mini_brief"
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin, or Opportunities are not switched on for the company.
- 429Every failure has this shape.
POST/v1/opportunities/cards/{id}/decisionSave an idea, say it is not for you, or mark a tested one won or droppedruns:write
Save an idea (decision SAVED), say it is not for you (NOT_FOR_US, with an optional note: Dom learns from it for your company only), or take either back (NONE). An idea whose first test was prepared is marked WON or DROPPED; NONE takes that back to testing. 409 while its first test is being prepared, or for a decision that does not fit where the idea stands; 403 where Opportunities are not switched on.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request bodyrequired
decisionenumNONEtakes either back; on a won or dropped idea it goes back to testing.WONandDROPPEDonly after its first test was prepared."SAVED"·"NOT_FOR_US"·"NONE"·"WON"·"DROPPED"notestringWith
NOT_FOR_US: why, up to 300 characters. Dom learns from it for this company only.maxLength300
Responses
200Success
okenumtruedecisionenum"SAVED"·"NOT_FOR_US"·"TESTING"·"WON"·"DROPPED"·null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Opportunities are not switched on for the company. - 404No such idea.
- 409Its first test is being prepared, or the decision does not fit where the idea stands.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/opportunities/cards/{id}/decision \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"decision": "SAVED"}'POST/v1/opportunities/cards/{id}/preparePrepare an idea's first testruns:write
Prepare an idea’s first test: a brief to each agent that prepares something for it (Eiger outreach drafts, Matterhorn post drafts, Säntis a pricing note, otherwise Dom), 1 Run each. Each makes normal proposals you approve as usual; nothing is sent, posted or changed by this. Dom then follows the test and reports its outcome in the next brief. 409 when its first test is already being prepared; 403 where Opportunities are not switched on.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Responses
200Success
okenumtruebriefsarray of objectOne brief per agent that prepares something for it.
briefs
agentenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"briefIdstring
runsintegerWhat it weighed: 1 Run each.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Opportunities are not switched on for the company. - 404No such idea.
- 409Its first test is already being prepared.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/opportunities/cards/{id}/prepare \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/opportunities/cards/{id}/reactionSay you would act on an idearuns:write
Say you would act on an idea (wouldAct: true), or take it back. A reaction, counted to see which ideas are worth acting on; it changes nothing else.
A reaction, counted to see which ideas are worth acting on; it changes nothing else.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request bodyrequired
wouldActbooleantrueto say you would act on it,falseto take that back.
Responses
200Success
okenumtruewouldActboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Opportunities are not switched on for the company. - 404No such idea.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/opportunities/cards/{id}/reaction \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"wouldAct": true}'Venture plans Coming online
Dom's Venture plan: the full startup plan for a new business, from an idea to a running company, with one economics model behind every number. Switched on one company at a time; Pro, Max and Ultra.
GET/v1/venture-deadlinesDeadlines accepted from Venture plansruns:read
Grant and programme deadlines a person accepted from the company's Venture plans, for Pilatus's calendar page: name, date, source page, plan.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Responses
200Success
deadlinesarray of objectdeadlines
idstringAn id.
planIdstringAn id.
namestringurlstring (uri)dueOnstring (date-time)countrystring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/venture-deadlines \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/venture-plansList Venture plansruns:read
Dom’s Venture plans: whether they are on for the company and its plan (Pro, Max and Ultra), what they weigh (15 Runs a plan, 20 with web research, 2 a section again, 1 for each agent preparing a first step or a test), the plans made, and the ideas from Opportunities to make one from.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Responses
200Venture plans, or { "available": false }.
any of
- object Where `dom_venture_plan` is off for the company.
availableenumfalse
- object
availableenumtrueplanstringThe company's plan (database code).
eligiblebooleanPro, Max and Ultra have Venture plans.
upgradeTostring | nullThe plan to move up to, where it has none.
weightobjectweight
planinteger15 Runs.
webinteger20 Runs with web research.
sectioninteger2 Runs.
firstStepinteger1 Run an agent.
testinteger1 Run an agent.
webAvailablebooleansharingbooleanplansarray of objectplans
idstringAn id.
titlestringstatusenumHELD: waiting for Bernina's review."DRAFTING"·"READY"·"HELD"·"FAILED"versionintegerThe current version (0 while the first is written).
languageenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"currencystringwebbooleancardIdstring | nullAn id.
sectionRunningenumOne of the ten sections.
"idea"·"identity"·"market"·"economics"·"strategy"·"setup"·"plan"·"risks"·"sustainability"·"funding"·nullreviewDueAtstring | nullWhen Dom asks for the monthly review.
ratinginteger | null1 to 5.
wouldUseboolean | nullcreatedAtstring (date-time)updatedAtstring (date-time)
ideasarray of objectIdeas to make a plan from.
ideas
idstringAn id.
levelstringtitlestringdecisionstring | nullcreatedAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/venture-plans \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plansAsk Dom for a Venture planruns:write
Ask Dom for a Venture plan on an Opportunities idea (cardId), the full startup plan for a new business in ten sections: 15 Runs, 20 with web research (web: market, competitors, grants, each linked). Pro, Max and Ultra. Nothing is filed, signed, sent or spent by a plan.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Request bodyrequired
cardIdstringThe Opportunities idea.
webbooleanResearch the web: market, competitors, grants (20 Runs).
Responses
200Success
okenumtrueplanIdstringAn id.
briefIdstringFollow it with
GET /v1/briefs/{id}/steps.runsinteger15, or 20 with web research.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Not switched on, or the plan has no Venture plans (Pro, Max and Ultra do). - 404No such idea.
- 409Dom is already writing a plan for this idea.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"cardId": "…"}'GET/v1/venture-plans/{id}Read a Venture planruns:read
One Venture plan: its current version (the ten sections, every figure as a token of its economics model, the data figures with their records, the web sources), the model's inputs with where each comes from (the assumption ledger), its first tests, versions, exports and shared links.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
idpathstring
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/venture-plans/{id} \
-H "Authorization: Bearer $ZUGER_KEY"DELETE/v1/venture-plans/{id}Delete a Venture planPerson
No API key can call this. It needs a person, signed in.
Delete a Venture plan, its versions, its exports and their files, and its shared links. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Responses
200Success
okenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin, or not switched on.
- 404No such Venture plan.
- 429Every failure has this shape.
POST/v1/venture-plans/{id}/askAsk a Venture plan a questionruns:write
Ask the plan a question (question), 2 Runs: Dom answers from the plan alone, with the inputs a "what if" would change and what they do to the figures. Nothing in the plan changes until you save the scenario.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request bodyrequired
questionstringAt most 1,000 characters.
Responses
200Success
okenumtrueaskIdstringAn id.
briefIdstringrunsinteger2 Runs.
- 400Ask a question about the plan.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409The last question is still being answered, or the plan is busy.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/ask \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"question": "…"}'GET/v1/venture-plans/{id}/basicsA Venture plan's legal drafts, team, funding scenarios, KPIs and brandruns:read
A Venture plan's legal drafts, team plan and job posts, funding scenarios, KPI tracker (once launched) and name and brand starter with its domains and trademark searches.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
idpathstring
Responses
200Success
weightsobjectweights
legalinteger1 Run.
jobsinteger1 Run.
brandinteger1 Run.
legalobjectlegal
kindsarray of enumdraftsarray of objectdrafts
idstringAn id.
kindenum"founders_agreement"·"ip_assignment"·"nda"·"advisor_agreement"statusenum"DRAFTING"·"READY"·"HELD"·"FAILED"foundersintegerpointsintegerTitlis's points for the lawyer.
createdAtstring (date-time)
teamobjectteam
hiresarray of objecthires
rolestringfromintegerMonth of the plan.
monthlynumber
savedbooleanThe team plan is the model's (else the plan's words, as a start).
postsarray of objectposts
idstringAn id.
rolestringpostobjectpost
rolestringsummarystringyouWillarray of stringyouBringarray of stringweOfferarray of string
createdAtstring (date-time)
runningboolean
capTablesarray of objectcapTables
idstringAn id.
namestringtableobjectThe scenario as saved (venture-captable.js normaliseCapTable).
updatedAtstring (date-time)
kpiobject | nullkpi
launchedAtstring (date-time)rowsarray of objectrows
monthstringYYYY-MM
nintegerMonth of the plan.
keyenum"revenue"·"newCustomers"·"activeCustomers"targetnumberactualnumber | nullFrom the company's invoices; null without data.
rationumber | nullstatusenum"ahead"·"on_track"·"watch"·"behind"·"no_data"
latestobjectThe latest month with data, per figure.
brandobject | nullbrand
statusenum"DRAFTING"·"READY"·"HELD"·"FAILED"starterobject | nullNames (with why, tagline and domain label), voice, words to use and avoid.
domainsarray of object | nulldomains
namestringdomainstringstateenum"registered"·"not_registered"·"unknown"·"no_rdap"
domainsAtstring | nullrdapCheckedstringtrademarksCheckedstringtrademarksarray of objecttrademarks
namestringlinksarray of objectlinks
idstringofficestringcoversstringurlstring (uri)prefilledboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/venture-plans/{id}/basics \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/brandDraft names and a brand starterruns:write
Matterhorn drafts name ideas and a brand starter, 1 Run.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Responses
200Success
okenumtrueagentstringrunsinteger1 Run.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409Still drafting, or the plan is busy.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/brand \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/cap-tablesSave a funding scenarioruns:write
Save a funding scenario (name; table: founders with shares, an option pool percentage, priced rounds and SAFEs; id to change one), simulated in code. Not investment advice.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request bodyrequired
idstringA scenario to change.
namestringtableobjecttable
foundersarray of objectfounders
namestringsharesinteger
poolPctnumber0 to 40.
roundsarray of objectSix at most.
rounds
kindenum"priced"·"safe"namestringamountnumberpreMoneynumberA priced round.
poolTopUpPctnumbercapnumberA SAFE's valuation cap.
discountPctnumberA SAFE's discount.
Responses
200Success
okenumtrueidstringAn id.
founderPctnumber | null
- 400No founder with shares.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409Ten scenarios already.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/cap-tables \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"table": {}}'POST/v1/venture-plans/{id}/choicesChoose the mission, vision and values draftsruns:write
Choose a draft of the mission, the vision and the values (mission, vision, values: the draft's number from 0).
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request body
missionintegerThe draft, from 0.
visionintegerThe draft, from 0.
valuesintegerThe set, from 0.
Responses
200Success
okenumtrueversionintegerThe new version.
- 400Not one of the drafts.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409Dom is writing the plan or a section of it, it waits for Bernina's review, or it changed meanwhile.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/choices \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"mission": 1, "vision": 1, "values": 1}'POST/v1/venture-plans/{id}/companyMake the company from a Venture planPerson
No API key can call this. It needs a person, signed in.
From plan to company: add the new company to this account (legalName, jurisdiction), within your plan's company limit, with the plan's budget and targets in its memory and Pilatus's formation checklist as a file. Files nothing: the checklist is for you and your adviser. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Request bodyrequired
legalNamestringjurisdictionstringISO 3166-1 alpha-2.
langenumThe formation checklist's language.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"
Responses
200Success
okenumtrueentityobjectentity
idstringAn id.
legalNamestringjurisdictionstring
checklistExportIdstring | nullThe formation checklist, with the plan's exports. Null where it was not kept.
checklistRefusedobjectchecklistRefused
typestringmessagestringWhy the file was not kept: the plan's storage limit. The company is made all the same.
- 400A legal name and a country are needed.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin, or the plan has no room for another company (the upgrade is in the plans).
- 404Nothing by that id in this company.
- 409The plan is already a company here, or busy.
- 429Every failure has this shape.
GET/v1/venture-plans/{id}/demandA Venture plan's demand check, questions, grants and companyruns:read
What a plan has beyond its words: the demand check (its landing page, waitlist figures and surveys, where venture_demand_check is on), the questions asked of it and their scenarios, grants (the starter list, or deadlines found on the web) and the company it became.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
idpathstring
Responses
200Success
demandobjectdemand
availablebooleanventure_demand_checkis on for the company.weightsobjectweights
landinginteger1 Run.
surveyinteger1 Run.
landingobject | nulllanding
idstringAn id.
statusenum"DRAFTING"·"PROPOSED"·"LIVE"·"PAUSED"·"ENDED"·"FAILED"urlstring | nullThe page, at its own address on Zuger, once approved.
refusalsarray of stringWhy a draft was not kept (field:reason).
copyobject | nullThe words, figures written in.
copy
headlinestringsubstringbulletsarray of stringctastringpriceLinestring
approvalIdstring | nullAn id.
publishedAtstring | nullendsAtstring | nullendedAtstring | null
statsobject | nullstats
viewsintegersignupsintegerconfirmedintegerOnly these count.
payobjectpay
yesintegermaybeintegernointeger
surveyAnswersintegerconversionPctnumber | nullVisits to confirmed, from 50 visits.
atstring (date-time)
surveysarray of objectsurveys
idstringAn id.
statusenum"DRAFTING"·"PROPOSED"·"SENT"·"CANCELLED"·"FAILED"recipientsintegeranswersintegerapprovalIdstring | nullAn id.
sentAtstring | nullrefusalsarray of stringquestionsinteger
asksarray of objectasks
idstringAn id.
statusenum"ASKED"·"ANSWERED"·"HELD"·"FAILED"questionstringanswerstring | nullWith figures as tokens of the scenario's model.
changesarray of objectchanges
keyenum"price"·"grossMarginPct"·"startCustomers"·"organicNew"·"marketingMonthly"·"marketingGrowthPct"·"cac"·"churnPct"·"fixedMonthly"·"hireMonthly"·"hireFrom"·"setupCost"·"startingCash"·"fundingAmount"·"fundingMonth"valuenumberwhystring
versionintegersavedAsVersioninteger | nullcreatedAtstring (date-time)deltasarray of object | nulldeltas
keystringbeforenumber | nullafternumber | null
askWeightinteger2 Runs.
grantsobjectgrants
webbooleanDeadlines can be looked up (a plan made with web research).
weightinteger1 Run.
startersarray of objectOfficial programmes, checked 2026-10-21; no dates.
starters
countrystringnamestringurlstring (uri)The programme's official page.
operatorstringtypeenum"grant"·"loan"·"equity"·"mixed"whostringdeadlinestring | nullsourceenum"curated"·"web"
deadlinesarray of objectdeadlines
idstringAn id.
namestringurlstring (uri)whostring | nullcountrystringdueOnstring (date-time)statusenum"PROPOSED"·"ACCEPTED"·"DISMISSED"·"DONE"
entityobject | nullentity
idstringAn id.
legalNamestringjurisdictionstringatstring (date-time)
countriesarray of string
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/venture-plans/{id}/demand \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/exportsExport a Venture planPerson
No API key can call this. It needs a person, signed in.
Export the plan now (format: pdf, docx, xlsx with live formulas, csv, summary_pdf for the one-page summary, pitch_pdf for the pitch outline; lang: one of the eight languages). Kept with your files, sealed, and given back as base64.
AccessA person, signed in. No API key can call this.
Operationdocuments.read
Parameters
idpathstring
Request bodyrequired
formatenumpdfthe full plan,docxfor editing,xlsxthe model with live formulas,csv,summary_pdfthe one-page summary,pitch_pdfthe ten-slide outline."pdf"·"docx"·"xlsx"·"csv"·"summary_pdf"·"pitch_pdf"·"interview_pdf"·"interview_docx"·"formation_pdf"·"legal_pdf"·"legal_docx"·"captable_xlsx"langenumThe language; the person's own by default.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"
Responses
200Success
idstringAn id.
formatenum"pdf"·"docx"·"xlsx"·"csv"·"summary_pdf"·"pitch_pdf"·"interview_pdf"·"interview_docx"·"formation_pdf"·"legal_pdf"·"legal_docx"·"captable_xlsx"langenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"versionintegerfilenamestringmimeTypestringsizeBytesintegerdatastringThe file, base64.
- 400Not one of the formats.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Venture plans are not switched on for the company.
- 404No such Venture plan.
- 409The plan has no version to export yet.
- 429Every failure has this shape.
POST/v1/venture-plans/{id}/first-stepsPrepare the first steps of a Venture planruns:write
Prepare the first steps: a brief to each agent that prepares one (Eiger outreach drafts, Matterhorn landing-page copy and posts, Säntis a budget, Pilatus a formation checklist, Zermatt role drafts; Dom for any not on shift), 1 Run each. Each makes proposals you approve as usual; nothing is filed, signed, sent, posted or spent.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Responses
200Success
okenumtruebriefsarray of objectbriefs
agentstringbriefIdstring
runsinteger1 Run each.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409They are already being prepared, or the plan is busy.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/first-steps \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/grantsLook up grant deadlines for a Venture planruns:write
Pilatus looks up grants and programmes for the plan's countries on the web, with their application deadlines where the page itself gives one (1 Run; a plan made with web research). Each deadline waits for you to add it to the calendar.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Responses
200Success
okenumtruebriefIdstringagentstringrunsinteger1 Run.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409Only for a plan made with web research.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/grants \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/job-postsDraft job posts for the team planruns:write
Zermatt drafts a job post for each role of the team plan, 1 Run, held to the fairness rule. Nothing is published.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Responses
200Success
okenumtruebriefIdstringagentstringrunsinteger1 Run.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409No role yet, or Zermatt is still drafting.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/job-posts \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/landingDraft a landing page for a Venture planruns:write
Matterhorn drafts the words of a landing page with a waitlist for the plan (1 Run). It goes live at its own address on Zuger only when you approve the words with your passkey, for 30 days. Owner or admin.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Responses
200Success
okenumtruelandingIdstringAn id.
briefIdstringagentstringrunsinteger1 Run.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. The demand check is off, or not the owner or an admin. - 404Nothing by that id in this company.
- 409A page is up, waits for approval or is being drafted, or the plan is busy.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/landing \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/launchMark a Venture plan launchedruns:write
Mark the plan launched (month: YYYY-MM, this month by default): the KPI tracker counts from it. Owner or admin.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request body
monthstringYYYY-MM; this month by default.
Responses
200Success
okenumtruelaunchedAtstring (date-time)
- 400A month from the last three years, not in the future.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Not the owner or an admin. - 404Nothing by that id in this company.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/launch \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"month": "…"}'POST/v1/venture-plans/{id}/legalPrepare a draft for the founders' lawyerruns:write
Prepare a draft for the founders' lawyer (kind: founders_agreement, ip_assignment, nda, advisor_agreement; founders: name, role, sharesPct, vestingMonths, cliffMonths), 1 Run for Titlis's points. Not legal advice; nothing is signed or sent. Owner or admin.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request bodyrequired
kindenum"founders_agreement"·"ip_assignment"·"nda"·"advisor_agreement"foundersarray of objectSix at most.
founders
namestringrolestringsharesPctnumber0 to 100; together at most 100.
vestingMonthsinteger0 to 60; 48 by default.
cliffMonthsinteger0 to 24; 12 by default.
Responses
200Success
okenumtruedraftIdstringAn id.
agentstringrunsinteger1 Run.
- 400Not a kind, no founder, or shares over 100%.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Not the owner or an admin, or not on Pro and up. - 404Nothing by that id in this company.
- 409The plan is busy.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/legal \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"kind": "founders_agreement", "founders": []}'PATCH/v1/venture-plans/{id}/modelChange a Venture plan's economics modelruns:write
Change the economics model's inputs (values), the low and high cases (scenarios), billing or the horizon: every figure in the plan moves with them. An input from your data that you change becomes your assumption. Returns what moved (break-even, runway, funding needed…).
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request body
valuesmap of numberInputs to change, by key.
scenariosobjectscenarios
lowmap of numberhighmap of number
billingenum"monthly"·"one_off"monthsenum12·18·24·36
Responses
200Success
okenumtrueversionintegerdeltasarray of objectWhat moved: break-even, runway, funding needed, payback, revenue in month 12, cash at the end.
deltas
keystringbeforenumber | nullafternumber | null
- 400An input the model cannot take.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409Dom is writing the plan or a section of it, it waits for Bernina's review, or it changed meanwhile.
- 429Every failure has this shape.
curl -X PATCH https://beta.zuger.ai/v1/venture-plans/{id}/model \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"values": {}, "scenarios": {}, "billing": "monthly"}'POST/v1/venture-plans/{id}/ratingRate a Venture planruns:write
Rate a Venture plan from 1 to 5 (rating) and say whether you would use it (wouldUse). Zuger reads the figures to make plans better.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request body
ratinginteger1 to 5.
wouldUsebooleanYou would use it.
Responses
200Success
okenumtrueratinginteger | nullwouldUseboolean | null
- 400A rating is from 1 to 5.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/rating \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"rating": 1, "wouldUse": true}'POST/v1/venture-plans/{id}/reviewMark a Venture plan's monthly review doneruns:write
Mark the monthly review of a living plan done: Dom asks again in 30 days.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Responses
200Success
okenumtruereviewDueAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/review \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/surveyDraft a survey for a waitlistruns:write
Moléson drafts a short survey for the people who confirmed their address on the waitlist (1 Run; note: what you want to learn). Sent only when you approve it with your passkey, signed with your name. Owner or admin.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request body
notestringWhat you want to learn, a line.
Responses
200Success
okenumtruesurveyIdstringAn id.
briefIdstringagentstringrunsinteger1 Run.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. The demand check is off, or not the owner or an admin. - 404Nothing by that id in this company.
- 409No page, nobody confirmed yet, or a survey waits.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/survey \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"note": "…"}'PATCH/v1/venture-plans/{id}/teamSave a Venture plan's team planruns:write
Save the team plan (hires: role, from month, monthly cost; twelve at most) as a new version: every figure follows the roles. Returns what moved.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Request bodyrequired
hiresarray of objectTwelve at most.
hires
rolestringfrominteger1 to the plan's horizon.
monthlynumber0 to 10,000,000.
Responses
200Success
okenumtrueversionintegerdeltasarray of objectdeltas
keystringbeforenumber | nullafternumber | null
- 400A start month or a cost out of range.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409Dom is writing the plan or a section of it, it waits for Bernina's review, or it changed meanwhile.
- 429Every failure has this shape.
curl -X PATCH https://beta.zuger.ai/v1/venture-plans/{id}/team \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"hires": []}'POST/v1/venture-plans/{id}/brand/domainsLook up the names' domains by RDAPruns:write
Look up each name's domains by RDAP, the registries' own lookup: registered, not registered now, or unknown. Nothing is registered.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Responses
200Success
okenumtruedomainsarray of objectdomains
namestringdomainstringstateenum"registered"·"not_registered"·"unknown"·"no_rdap"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409No names yet, or looked up a moment ago.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/brand/domains \
-H "Authorization: Bearer $ZUGER_KEY"DELETE/v1/venture-plans/{id}/cap-tables/{tableId}Delete a funding scenarioruns:write
Delete a funding scenario.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstringtableIdpathstring
Responses
200Success
okenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. - 404No such scenario.
- 429Every failure has this shape.
curl -X DELETE https://beta.zuger.ai/v1/venture-plans/{id}/cap-tables/{tableId} \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/deadlines/{deadlineId}Add a deadline to the calendar, or dismiss itruns:write
Add a deadline Pilatus found to the calendar (accept: true), or dismiss it. Owner or admin.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstringdeadlineIdpathstring
Request bodyrequired
acceptboolean
Responses
200Success
okenumtruestatusenum"ACCEPTED"·"DISMISSED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Not the owner or an admin. - 404No such deadline waiting.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/deadlines/{deadlineId} \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"accept": true}'POST/v1/venture-plans/{id}/demand/applyTake the demand check's results into the planruns:write
Take what the demand check showed into the plan's ledger (a new version): the price answers confirm or refute the price assumption, the page's conversion is evidence for organic growth.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Responses
200Success
okenumtrueversionintegerverdictstring | nulldeltasarray of objectdeltas
keystringbeforenumber | nullafternumber | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404Nothing by that id in this company.
- 409Nothing new to take in, or the plan is busy.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/demand/apply \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/venture-plans/{id}/exports/{exportId}Download an export of a Venture planPerson
No API key can call this. It needs a person, signed in.
An export made earlier, as base64, to open or save.
AccessA person, signed in. No API key can call this.
Operationdocuments.read
Parameters
idpathstringexportIdpathstring
Responses
200Success
idstringAn id.
filenamestringmimeTypestringsizeBytesintegerdatastringThe file, base64.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Venture plans are not switched on for the company.
- 404No such export.
- 429Every failure has this shape.
POST/v1/venture-plans/{id}/landing/endEnd a Venture plan's landing pageruns:write
End the plan's landing page now: it says it is no longer open. The waitlist and its figures stay. Owner or admin.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstring
Responses
200Success
okenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Not the owner or an admin. - 404This plan has no landing page.
- 409This landing page is not up.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/landing/end \
-H "Authorization: Bearer $ZUGER_KEY"PATCH/v1/venture-plans/{id}/sections/{section}Edit a section of a Venture planruns:write
Change the words of a section (edits: each a path in the section and its new text). A number equal to one of the model's figures becomes that figure, so it moves with the model; any other number is refused.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstringsectionpathstring
Request bodyrequired
editsarray of objectUp to 40 changes.
edits
pathstringThe field, as
<section>.<field>or<section>.<list>.<n>.textstringIts new words; figures as tokens.
Responses
200Success
okenumtrueversionintegerThe new version.
- 400A number not in the model, a field that cannot be edited, or nothing said.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409Dom is writing the plan or a section of it, it waits for Bernina's review, or it changed meanwhile.
- 429Every failure has this shape.
curl -X PATCH https://beta.zuger.ai/v1/venture-plans/{id}/sections/{section} \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"edits": []}'GET/v1/venture-plans/{id}/versions/{number}Read an earlier version of a Venture planruns:read
An earlier version of a Venture plan: its words and its model as they were.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
idpathstringnumberpathstring
Responses
200Success
numberintegerreasonenum"generated"·"section_regenerated"·"section_edited"·"inputs_changed"·"drafts_chosen"·"test_started"·"test_result"·"restored"·"reviewed"·"ask_scenario"·"demand_result"·"team_plan"sectionenumOne of the ten sections.
"idea"·"identity"·"market"·"economics"·"strategy"·"setup"·"plan"·"risks"·"sustainability"·"funding"·nullcreatedAtstring (date-time)contentVentureContentThe plan's words. Prose names figures as tokens,
{{key}}or{{key.low}}/{{key.high}}: price, grossMarginPct, cac, churnPct, paybackMonths, ltv, ltvToCac, contributionMarginPct, breakEvenMonth, runwayMonths, lowestCash, lowestCashMonth, fundingNeed, revenueMonth12, revenueEnd, revenueYear1, revenueYear2, customersEnd, cashEnd, startingCash, fixedMonthly, marketingMonthly, setupCost, fundingAmount, months, newCustomersTotal.content
modelVentureModelThe economics model. Every figure in the plan is computed from it in code (apps/console/public/venture-model.js).
model
- 400A version is a whole number from 1.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/venture-plans/{id}/versions/{number} \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/asks/{askId}/saveSave an answer's scenario as a versionruns:write
Save the scenario of an answer as a new version of the plan (on the version it was asked of).
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstringaskIdpathstring
Responses
200Success
okenumtrueversionintegerThe new version.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such question.
- 409It changes no input, or the plan changed since.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/asks/{askId}/save \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/assumptions/{key}/testTest an assumption of a Venture planruns:write
Test an assumption in a week: an Opportunities idea of its own carrying its test and success line, whose first test the agents prepare (1 Run each, proposals you approve as usual). Dom follows it and the plan takes the result back.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstringkeypathstring
Responses
200Success
okenumtruecardIdstringThe Opportunities card testing it.
runsinteger1 Run for each agent preparing it.
briefsarray of objectbriefs
agentstringbriefIdstring
versioninteger
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such assumption with a test.
- 409It is already being tested, the idea it came from is gone, or the plan is busy.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/assumptions/{key}/test \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/venture-plans/{id}/cap-tables/{tableId}/exportExport a funding scenario as a workbookPerson
No API key can call this. It needs a person, signed in.
A funding scenario as a workbook (lang), kept with the plan's exports.
AccessA person, signed in. No API key can call this.
Operationdocuments.read
Parameters
idpathstringtableIdpathstring
Request body
langenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"
Responses
200Success
idstringAn id.
filenamestringmimeTypestringsizeBytesintegerdatastringThe file, base64.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 404No such scenario.
- 429Every failure has this shape.
POST/v1/venture-plans/{id}/legal/{draftId}/exportExport a legal draftPerson
No API key can call this. It needs a person, signed in.
A legal draft as PDF or Word (format: pdf or docx; lang for the frame). Kept with the plan's exports, sealed.
AccessA person, signed in. No API key can call this.
Operationdocuments.read
Parameters
idpathstringdraftIdpathstring
Request body
formatenum"pdf"·"docx"langenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"
Responses
200Success
idstringAn id.
filenamestringmimeTypestringsizeBytesintegerdatastringThe file, base64.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 404No such draft.
- 409The draft is not ready yet.
- 429Every failure has this shape.
POST/v1/venture-plans/{id}/sections/{section}/regenerateAsk Dom to write a section againruns:write
Ask Dom to write one section again, with what you would like different (note): 2 Runs. The rest of the plan stays as it is.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstringsectionpathstring
Request body
notestringWhat you would like different, up to 400 characters.
maxLength400
Responses
200Success
okenumtruebriefIdstringrunsinteger2.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409Dom is writing the plan or a section of it, it waits for Bernina's review, or it changed meanwhile.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/sections/{section}/regenerate \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"note": "…"}'POST/v1/venture-plans/{id}/versions/{number}/restoreRestore an earlier version of a Venture planruns:write
Make an earlier version the current one again, as a new version (nothing is written over).
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Parameters
idpathstringnumberpathstring
Responses
200Success
okenumtrueversionintegerThe new version.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Venture plans are not switched on for the company. - 404No such Venture plan.
- 409Dom is writing the plan or a section of it, it waits for Bernina's review, or it changed meanwhile.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/venture-plans/{id}/versions/{number}/restore \
-H "Authorization: Bearer $ZUGER_KEY"Outside agents (KYA)
Developer companies register agents built and run elsewhere: domain proofs, opaque did:web subjects, public keys. Switched on one company at a time (kya_ext); where it is not, every path answers 404. No credential is issued yet.
GET/v1/kya/agentsList outside agentskya:read
The developer company's outside agents: each one's opaque DID, manifest, declared scopes, domain, state and keys (public halves only).
AccessAn API key with the scope kya:read, or a person signed in.
Operationkya.read
Responses
200Success
agentsarray of KyaExtAgentagents
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:readscope. Not a developer company, or a connected app (an agent never registers itself). - 404With
kya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kya/agents \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/kya/agentsRegister an outside agentkya:write
Register an outside agent on a domain the company has proven: its name, description, its Ed25519 public key as a JWK (never the private key: a JWK holding it is refused) and its manifest (what it does, the scopes it declares, model and provider only if you choose, a homepage on the domain). Gives it an opaque did:web:zuger.ai:ext:… subject. Debits no Runs and issues no credential yet. Owner or admin.
At most 5 an hour and 20 a day for a developer company, 25 at a time (config/kya-ext.json); past them a 429 or a 409.
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Request bodyrequired
namestring2 to 80 characters.
descriptionstringUp to 1,000 characters.
publicJwkobjectAn Ed25519 public key as a JWK (RFC 8037). A JWK holding the private part (
d) is refused and never stored.publicJwk
ktyenum"OKP"crvenum"Ed25519"xstringThe 32-byte public key, base64url.
domainstringA domain the company has proven.
manifestobjectmanifest
doesstringWhat it does, up to 2,000 characters.
scopesarray of stringOne to twenty of Zuger's scopes it declares; never execute:*.
modelstringUp to 80 characters, only if you choose.
providerstringUp to 80 characters, only if you choose.
homepagestring (uri)https, on the domain.
Responses
- 400A domain not proven by the company, a key with its private part or not Ed25519, a scope that is not Zuger's or is execute:*, or words too long.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. Not a developer company, not the owner or an admin, the address not confirmed, or a connected app (an agent never registers itself). - 404With
kya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 409The key belongs to another agent, or the company has as many agents as it may.
- 429Every failure has this shape.
- 503KYA_EXT_HMAC_KEY is not set on this deployment.
curl -X POST https://beta.zuger.ai/v1/kya/agents \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "…", "publicJwk": {}, "domain": "…", "manifest": {}}'POST/v1/kya/developersOpen a developer companyPublic
Open a developer company: a company that registers agents built and run elsewhere, signed in with a passkey as any other, with no plan, no Runs and no Zuger agents. Answers the same whether or not the address has an account; the link goes to the address. Throwaway mail providers are refused. Opens only when kya_ext is on for everyone.
AccessPublic: no key and no sign-in.
Operationpost_v1_kya_developers
Request bodyrequired
emailstring (email)The new account's address. Trimmed and lower-cased.
namestringYour name, 2 to 80 characters.
companyNamestring2 to 120 characters; made from the address otherwise.
localestringThe language for emails and the Console.
Responses
200The same answer whether or not the address has an account: the link (to set up a passkey) goes to the address. Nothing here grants access.
sentenumtruenotestring
- 400Throwaway mail providers are refused.
- 403No email provider is configured on this deployment, or sign-ups from this network are refused.
- 404Developer sign-up is open only while
kya_extis on for everyone. - 409Sign-ups are paused by Zuger (
paused_by_zuger). - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/kya/developers \
-H "Content-Type: application/json" \
-d '{"email": "…", "name": "…"}'POST/v1/kya/domainsProve a domainkya:write
Prove a domain: dns (a TXT record at _zuger-kya.<domain>), well_known (the line in https://<domain>/.well-known/zuger-kya.txt) or email (your own confirmed address at the domain, checked at once). Answers what to publish; check it with POST /v1/kya/domains/{id}/check. Zuger checks every proof again every 30 days, and a lost proof lapses the agents registered on it.
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Request bodyrequired
domainstringThe domain to prove, such as example.com.
methodenumdns: a TXT record at_zuger-kya.<domain>;well_known: the line inhttps://<domain>/.well-known/zuger-kya.txt;email: your own confirmed address at the domain."dns"·"well_known"·"email"
Responses
- 400Not a domain name, Zuger's own, a throwaway or public mail provider, or (email) your confirmed address is not at it.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. Not a developer company, not the owner or an admin, the address not confirmed, or a connected app (an agent never registers itself). - 404With
kya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 409The company has as many domains as it may.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/kya/domains \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"domain": "…", "method": "dns"}'GET/v1/kya/keysList delegated keyskya:read
The delegated keys of the developer company's outside agents, one row per 24-hour grant, newest first.
AccessAn API key with the scope kya:read, or a person signed in.
Operationkya.read
Parameters
agentIdquerystringAn id.
livequeryOnly the live grants.
Responses
200Success
keysarray of KyaDelegatedKeykeys
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:readscope. Not a developer company, or a connected app. - 404With
kya_delegated_keysoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kya/keys \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/kya/registrantRead the developer company's registrationkya:read
The developer company as the operator of its outside agents: its opaque registrant DID (once it has one), its domains with how each is proven and what to publish, and the limits. No credential is issued yet.
AccessAn API key with the scope kya:read, or a person signed in.
Operationkya.read
Responses
200Success
didstring | nullThe registrant DID, once the company has proven a domain or registered an agent.
domainsarray of KyaExtDomaindomains
limitsobjectThe caps from config/kya-ext.json: agents and domains, registrations an hour and a day, key changes a day, seconds between checks.
recheckDaysintegerissuingbooleanFalse: no credential is issued yet (A3).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:readscope. Not a developer company, or a connected app (an agent never registers itself). - 404With
kya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kya/registrant \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/kya/agents/{id}Read an outside agentkya:read
One outside agent.
AccessAn API key with the scope kya:read, or a person signed in.
Operationkya.read
Parameters
idpathstring
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:readscope. Not a developer company, or a connected app (an agent never registers itself). - 404No such agent. With
kya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kya/agents/{id} \
-H "Authorization: Bearer $ZUGER_KEY"DELETE/v1/kya/agents/{id}Remove an outside agentkya:write
Remove an outside agent for good: its keys are revoked and its DID document is gone at once.
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Parameters
idpathstring
Responses
200Success
okenumtrueidstringAn id.
stateenum"REMOVED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. Not a developer company, not the owner or an admin, the address not confirmed, or a connected app (an agent never registers itself). - 404No such agent. With
kya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl -X DELETE https://beta.zuger.ai/v1/kya/agents/{id} \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/kya/keys/delegationsList key delegation requestskya:read
The key delegation requests of the developer company's outside agents, newest first: waiting, approved, declined, lapsed or refused.
AccessAn API key with the scope kya:read, or a person signed in.
Operationkya.read
Parameters
statequeryagentIdquerystringAn id.
Responses
200Success
requestsarray of KyaKeyRequestrequests
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:readscope. Not a developer company, or a connected app. - 404With
kya_delegated_keysoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kya/keys/delegations \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/kya/keys/delegationsAsk for a key to be delegatedkya:write
An outside agent asks for a 24-hour software key it made to be delegated: its public Ed25519 key, the scopes it wants (from those it declared), and optionally the live key it replaces. An owner decides it in the Console with a passkey; nothing is decided here. Capped per agent per day; an unusual request (a new country, a burst) needs a second passkey or is refused.
At most 10 requests an agent a day and 3 waiting at once (config/kya-delegated-keys.json); past them a 429. A request that is unusual in two ways at once (a new country and a burst) is recorded as refused and answered 403.
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Request bodyrequired
agentIdstringThe agent, by id; or
agentDid.agentDidstringThe agent, by its did:web subject.
publicJwkobjectAn Ed25519 public key as a JWK (RFC 8037). A JWK holding the private part (
d) is refused and never stored.publicJwk
ktyenum"OKP"crvenum"Ed25519"xstringThe 32-byte public key, base64url.
scopesarray of stringFrom the scopes the agent declared; never execute:*.
replacesstringA live delegated key of the same agent this one replaces.
Responses
- 400A key with its private part or not Ed25519, a scope the agent did not declare, or a key to replace that is not live.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. Not a developer company, not the owner or an admin (a key by its creator's role), a connected app, the agent frozen, or the request unusual. - 404No such agent. With
kya_delegated_keysoff for the company, every one of these paths answers 404, as an unknown path does. - 409The agent is not active, or the key is already in use.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/kya/keys/delegations \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"publicJwk": {}, "scopes": []}'POST/v1/kya/agents/{id}/keysRotate an outside agent's keykya:write
Rotate an outside agent's key: the new Ed25519 public JWK becomes its key and the old one is revoked in the same step.
At most 10 key changes a day for an agent (a 429 past them).
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Parameters
idpathstring
Request bodyrequired
publicJwkobjectAn Ed25519 public key as a JWK (RFC 8037). A JWK holding the private part (
d) is refused and never stored.publicJwk
ktyenum"OKP"crvenum"Ed25519"xstringThe 32-byte public key, base64url.
Responses
- 400A key with its private part, or not Ed25519.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. Not a developer company, not the owner or an admin, the address not confirmed, or a connected app (an agent never registers itself). - 404No such agent. With
kya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 409The agent was removed, or the key is already its key or another agent's.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/kya/agents/{id}/keys \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"publicJwk": {}}'GET/v1/kya/agents/{id}/listingRead your agent's listing in the directorykya:read
Your outside agent's listing in the directory: the card published, and, read now, why it is not shown if it is not (withdrawn, the agent not active, the domain not proven, the card's key changed, frozen).
AccessAn API key with the scope kya:read, or a person signed in.
Operationkya.read
Parameters
idpathstring
Responses
200Success
agentIdstringAn id.
didstringlistedbooleanshownbooleanShown in the directory now.
notShownBecausearray of enumRead now; empty when it is shown.
listedAtstring | nullwithdrawnAtstring | nullcardHashstring | nullcardobject | nullThe A2A agent card as published.
skillsarray of stringskillTaxonomyarray of string
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:readscope. Not a developer company, or a connected app (an agent never lists itself). - 404No such agent. With
kya_networkorkya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kya/agents/{id}/listing \
-H "Authorization: Bearer $ZUGER_KEY"PUT/v1/kya/agents/{id}/listingList your agent in the directorykya:write
List your outside agent in the directory with its A2A 1.0 agent card: signed by the agent's current key, Zuger's KYA extension naming its DID, its languages and regions, every address on its proven domain, skills tagged from Zuger's list, and no email address or id. Replaces the card listed before.
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Parameters
idpathstring
Request bodyrequired
cardobjectAn A2A 1.0 agent card signed by the agent's current key (A2A §8.4), with Zuger's KYA extension
https://zuger.ai/kya/a2a/v0.1(params: did, languages, regions, and optionally price, sla, mcp, handshake).
Responses
200Success
agentIdstringAn id.
didstringlistedbooleanshownbooleanShown in the directory now.
notShownBecausearray of enumRead now; empty when it is shown.
listedAtstring | nullwithdrawnAtstring | nullcardHashstring | nullcardobject | nullThe A2A agent card as published.
skillsarray of stringskillTaxonomyarray of string
- 400The card is not an A2A 1.0 card, is not signed by the agent's current key, names another DID, has an address off the proven domain, an untagged skill, an email address or an id.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. Not a developer company, not the owner or an admin, the address not confirmed, or a connected app (an agent never lists itself). - 404No such agent. With
kya_networkorkya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 409The agent is not active, or its domain is not proven.
- 429Every failure has this shape.
curl -X PUT https://beta.zuger.ai/v1/kya/agents/{id}/listing \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"card": {}}'DELETE/v1/kya/agents/{id}/listingTake your agent out of the directorykya:write
Take your outside agent out of the directory at once. Its card is kept, withdrawn; listing it again shows it.
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Parameters
idpathstring
Responses
200Success
agentIdstringAn id.
didstringlistedbooleanshownbooleanShown in the directory now.
notShownBecausearray of enumRead now; empty when it is shown.
listedAtstring | nullwithdrawnAtstring | nullcardHashstring | nullcardobject | nullThe A2A agent card as published.
skillsarray of stringskillTaxonomyarray of string
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. Not a developer company, not the owner or an admin, the address not confirmed, or a connected app (an agent never lists itself). - 404No such agent. With
kya_networkorkya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 409The agent is not listed.
- 429Every failure has this shape.
curl -X DELETE https://beta.zuger.ai/v1/kya/agents/{id}/listing \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/kya/domains/{id}/checkCheck a domain's proof nowkya:write
Look for a domain's proof now (once a minute at most). Found, the domain is proven, and agents that lapsed with it come back.
Once a minute at most for a domain (a 429 otherwise).
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Parameters
idpathstring
Responses
200Success
foundbooleanreasonstring | nullWhy it was not found.
domainKyaExtDomainA domain the developer company proves.
domain
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. Not a developer company, not the owner or an admin, the address not confirmed, or a connected app (an agent never registers itself). - 404No such domain. With
kya_extoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/kya/domains/{id}/check \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/kya/keys/delegations/{id}Read a key delegation requestkya:read
One key delegation request, with the delegated key once an owner approved it (ready to issue: credentials come with milestone A3).
AccessAn API key with the scope kya:read, or a person signed in.
Operationkya.read
Parameters
idpathstring
Responses
200Success
idstringAn id.
kindenum"delegate"·"renew"agentIdstringAn id.
agentNamestring | nullagentDidstringThe agent's opaque did:web subject.
thumbprintstringRFC 7638 SHA-256 of the key, base64url.
fingerprintstringThe thumbprint's first 32 characters in groups of four, as people compare it.
scopesarray of stringDeclared scopes asked for: never enforced or granted by Zuger, never execute:*.
lifetimeSecondsinteger86400: a delegated key lives 24 hours.
assuranceenum"registered"·"verified"originobjectWhere it came from, as a class: never an address.
origin
countrystring | nullWhere Zuger read the request came from, two letters.
networkenum"ipv4"·"ipv6"·nullclientstringsdk-typescript, sdk-python, curl or other.
signalsarray of enumWhat made it unusual; one signal asks for a second passkey.
passkeysNeededinteger1, or 2 for an unusual request.
replacesstring | nullThe live delegated key this one replaces (rotation).
renewsstring | nullThe live delegated key a renewal renews.
stateenum"pending"·"approved"·"declined"·"lapsed"·"refused"refusalstring | nullWhy the rules refused or lapsed it: unusual, frozen, agent_gone, lapsed.
createdAtstring (date-time)waitsUntilstring (date-time)When it lapses if nobody decides it.
decidedAtstring | nullgrantIdstring | nullAn id.
grantany ofgrant
- null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:readscope. Not a developer company, or a connected app. - 404No such key request. With
kya_delegated_keysoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kya/keys/delegations/{id} \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/kya/keys/{id}/renewRenew a delegated keykya:write
An outside agent asks to renew a live delegated key for another 24 hours: renewed at once where no tap is needed (a Registered agent in good standing, a Verified one inside its standing window), else waiting for an owner's passkey.
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Parameters
idpathstring
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. Not a developer company, not the owner or an admin, or a connected app. - 404No such delegated key. With
kya_delegated_keysoff for the company, every one of these paths answers 404, as an unknown path does. - 409Renewed or revoked already, or it cannot be renewed (expired, the agent frozen or not active): ask for a new delegation.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/kya/keys/{id}/renew \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/kya/keys/{id}/revokeRevoke a delegated keyPerson
No API key can call this. A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's.
Revoke a delegated key with a passkey, at once and for good.
Why no key
A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's.
AccessA person, signed in. No API key can call this.
Operationkya.decide
Parameters
idpathstring
Request bodyrequired
assertionobjectA WebAuthn assertion:
{ credentialId, challenge (the token), response }, as the Console sends it.
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's. Not the owner or an admin, the address not confirmed, a passkey missing, not this person's, not checking out against the payload, or (a Verified agent) the account holds fewer than two passkeys. Never an API key or a connected app.
- 404No such delegated key. With
kya_delegated_keysoff for the company, every one of these paths answers 404, as an unknown path does. - 409Renewed or revoked already.
- 429Every failure has this shape.
POST/v1/kya/keys/{id}/signatureStart the passkey for a standing window or a revocationPerson
No API key can call this. A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's.
The passkey challenge for a standing window (standing_window, 1 to 7 days, Verified agents only) or a revocation (revoke) of a live delegated key.
Why no key
A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's.
AccessA person, signed in. No API key can call this.
Operationkya.decide
Parameters
idpathstring
Request bodyrequired
actionenum"standing_window"·"revoke"daysinteger1 to 7, for a standing window.
Responses
- 400Neither standing_window nor revoke, or days not 1 to 7.
- 401Not signed in: no session, or no valid API key.
- 403A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's. Not the owner or an admin, the address not confirmed, a passkey missing, not this person's, not checking out against the payload, or (a Verified agent) the account holds fewer than two passkeys. Never an API key or a connected app.
- 404No such delegated key. With
kya_delegated_keysoff for the company, every one of these paths answers 404, as an unknown path does. - 409Renewed or revoked already, or a standing window asked for a Registered agent.
- 429Every failure has this shape.
POST/v1/kya/keys/{id}/standingSet a standing windowPerson
No API key can call this. A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's.
Set a standing window of 1 to 7 days on a Verified agent's live key with a passkey: renewals inside it need no tap.
Why no key
A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's.
AccessA person, signed in. No API key can call this.
Operationkya.decide
Parameters
idpathstring
Request bodyrequired
daysinteger1 to 7.
assertionobjectA WebAuthn assertion:
{ credentialId, challenge (the token), response }, as the Console sends it.
Responses
- 400Days not 1 to 7.
- 401Not signed in: no session, or no valid API key.
- 403A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's. Not the owner or an admin, the address not confirmed, a passkey missing, not this person's, not checking out against the payload, or (a Verified agent) the account holds fewer than two passkeys. Never an API key or a connected app.
- 404No such delegated key. With
kya_delegated_keysoff for the company, every one of these paths answers 404, as an unknown path does. - 409Renewed or revoked already, or the agent is Registered.
- 429Every failure has this shape.
POST/v1/kya/keys/delegations/{id}/decisionApprove or decline a key delegationPerson
No API key can call this. A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's.
Approve a key delegation with a passkey (two for an unusual request), or decline it. Approved, the key is recorded as delegated for 24 hours.
Why no key
A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's.
AccessA person, signed in. No API key can call this.
Operationkya.decide
Parameters
idpathstring
Request bodyrequired
decisionenum"approve"·"decline"assertionsarray of objectOne assertion, or two different passkeys for an unusual request.
assertionobjectA WebAuthn assertion:
{ credentialId, challenge (the token), response }, as the Console sends it.
Responses
- 400Neither approve nor decline.
- 401Not signed in: no session, or no valid API key.
- 403A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's. Not the owner or an admin, the address not confirmed, a passkey missing, not this person's, not checking out against the payload, or (a Verified agent) the account holds fewer than two passkeys. Never an API key or a connected app.
- 404No such key request. With
kya_delegated_keysoff for the company, every one of these paths answers 404, as an unknown path does. - 409Decided already, lapsed, the agent not active, or the key already in use.
- 429Every failure has this shape.
POST/v1/kya/keys/delegations/{id}/signatureStart the passkey for a key delegationPerson
No API key can call this. A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's.
The passkey challenge for approving a key delegation: its WebAuthn challenge is the SHA-256 of the payload (the agent, the key, the scopes, the expiry), which is returned beside it. A second passkey leaves out the first (exclude).
Why no key
A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's.
AccessA person, signed in. No API key can call this.
Operationkya.decide
Parameters
idpathstring
Request body
excludearray of stringThe passkey already used, for the second one.
Responses
200Success
optionsobjectWebAuthn request options;
challengeis the payload's SHA-256.tokenstringSent back with the assertion.
payloadobjectWhat the passkey commits to: the agent, the key's thumbprint, the scopes, iat, exp, the audience, the request and a nonce.
challengestringThe payload's SHA-256, base64url.
passkeysNeededinteger
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A key is delegated to an agent by a person, with a passkey whose challenge commits to that key, its scopes and its expiry. An agent never approves its own key, and an API key is the agent's. Not the owner or an admin, the address not confirmed, a passkey missing, not this person's, not checking out against the payload, or (a Verified agent) the account holds fewer than two passkeys. Never an API key or a connected app.
- 404No such key request. With
kya_delegated_keysoff for the company, every one of these paths answers 404, as an unknown path does. - 409Decided already, or lapsed.
- 429Every failure has this shape.
Emergency stop (KYA)
A person, signed in, stops one agent, the whole fleet or the agents holding one skill with a passkey, and only a passkey restarts them. Never by an API key. Switched on one company at a time (kya_stop); where it is not, every path answers 404.
GET/v1/kya/stopRead the emergency stopPerson
No API key can call this. An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
The emergency stop: whether a stop of the whole fleet needs a second person's passkey, the agents and what holds them, the skills that can be stopped, and the last fifty stops with what each ended. Owner or admin.
Why no key
An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
AccessA person, signed in. No API key can call this.
Operationkya.stop
Responses
200Success
twoPersonbooleanA stop of the whole fleet waits for a second person's passkey.
canChangeSettingbooleanThe owner may change it.
agentsarray of objectagents
idstringAn id.
kindstringnamestringstateenum"RUNNING"·"PAUSED"·"STOPPED"
skillsarray of objectskills
skillstringfleetbooleanEvery agent holds it: stopping it stops the fleet.
kindsarray of stringThe kinds of agent that hold it.
scopesarray of enumstopsarray of KyaStopThe last fifty, newest first.
stops
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop. Not the owner or an admin, or not a person signed in (a key or a connected app never stops or restarts agents).
- 404With
kya_stopoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/kya/stopMake an emergency stopPerson
No API key can call this. An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
Stop agents now with the passkey assertion: they go off shift, their running and waiting Runs end cancelled and are never charged, what they were waiting for is withdrawn, and kya.stopped is sent to your webhooks. A stop of the whole fleet waits for a second person's passkey where the company asks for one. Never by an API key.
Why no key
An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
AccessA person, signed in. No API key can call this.
Operationkya.stop
Request bodyrequired
scopeenumagent: one agent;operator: every agent of the company;skill: the agents that hold one skill."agent"·"operator"·"skill"targetstringThe agent's id for
agent, the skill (a scope such aspublish:social) forskill; left out foroperator.assertionobjectThe passkey assertion bound to this one action.
assertion
credentialIdstringThe passkey's credential id.
challengestringThe
tokenfrom the signature call.responseobjectThe browser's WebAuthn assertion response.
Responses
200Stopped, or (a stop of the whole fleet where the company asks for two people) waiting for a second person's passkey.
stopobjectstop
idstringAn id.
stateenum"STOPPED"·"WAITING_SECOND"waitsUntilstring (date-time)A fleet stop waiting for a second passkey lapses then.
agentsintegerrunsCancelledintegerproposalsWithdrawnintegerdurationMsinteger
- 400An unknown scope or skill, or a fleet stop already waits.
- 401Not signed in: no session, or no valid API key.
- 403An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop. Not the owner or an admin, not a person signed in, or the passkey did not check out.
- 404No such agent. With
kya_stopoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
PATCH/v1/kya/stop/settingsAsk for two people to stop the fleetPerson
No API key can call this. An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
Whether a stop of the whole fleet needs a second person's passkey (twoPerson). The owner's choice; off by default.
Why no key
An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
AccessA person, signed in. No API key can call this.
Operationkya.stop
Request bodyrequired
twoPersonbooleanA stop of the whole fleet waits for a second person's passkey.
Responses
200Success
twoPersonboolean
- 400Not true or false, or nobody else in the company could give a second passkey yet.
- 401Not signed in: no session, or no valid API key.
- 403An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop. Only the owner changes it.
- 404With
kya_stopoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/kya/stop/signatureStart an emergency stop with a passkeyPerson
No API key can call this. An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
Start an emergency stop: a passkey challenge bound to what it reaches (scope agent, operator or skill, and target: the agent's id or the skill). Owner or admin.
Why no key
An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
AccessA person, signed in. No API key can call this.
Operationkya.stop
Request bodyrequired
scopeenumagent: one agent;operator: every agent of the company;skill: the agents that hold one skill."agent"·"operator"·"skill"targetstringThe agent's id for
agent, the skill (a scope such aspublish:social) forskill; left out foroperator.
Responses
200Success
optionsobjectWebAuthn request options for
navigator.credentials.get, bound to this one stop, request or restart.tokenstringThe challenge token, sent back as
assertion.challenge. Good for two minutes, once.
- 400An unknown scope, or a skill Zuger does not know.
- 401Not signed in: no session, or no valid API key.
- 403An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop. Not the owner or an admin, or not a person signed in (a key or a connected app never stops or restarts agents).
- 404No such agent. With
kya_stopoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/kya/stop/{id}/confirmGive the second passkeyPerson
No API key can call this. An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
Sign a waiting stop of the whole fleet as the second person, with the passkey assertion: it becomes the stop.
Why no key
An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
AccessA person, signed in. No API key can call this.
Operationkya.stop
Parameters
idpathstring
Request bodyrequired
assertionobjectThe passkey assertion bound to this one action.
assertion
credentialIdstringThe passkey's credential id.
challengestringThe
tokenfrom the signature call.responseobjectThe browser's WebAuthn assertion response.
Responses
200Success
stopobjectstop
idstringAn id.
stateenum"STOPPED"agentsintegerrunsCancelledintegerproposalsWithdrawnintegerdurationMsinteger
- 400The request lapsed, was withdrawn or was signed already.
- 401Not signed in: no session, or no valid API key.
- 403An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop. Not the owner or an admin, the request is your own, or the passkey did not check out.
- 404No such stop. With
kya_stopoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/kya/stop/{id}/restartRestart what a stop holdsPerson
No API key can call this. An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
Restart what a stop holds, with the passkey assertion: its agents are back as they were (one another stop still holds stays stopped), and the restart is recorded.
Why no key
An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
AccessA person, signed in. No API key can call this.
Operationkya.stop
Parameters
idpathstring
Request bodyrequired
assertionobjectThe passkey assertion bound to this one action.
assertion
credentialIdstringThe passkey's credential id.
challengestringThe
tokenfrom the signature call.responseobjectThe browser's WebAuthn assertion response.
Responses
200Success
stopobjectstop
idstringAn id.
stateenum"RESTARTED"
restartedarray of stringAgents put back as they were.
stillHeldarray of stringAgents another stop still holds.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop. Not the owner or an admin, or the passkey did not check out.
- 404No stop by that id still holds agents. With
kya_stopoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/kya/stop/{id}/withdrawWithdraw a waiting stop requestPerson
No API key can call this. An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
Take back your own stop request while it waits for a second passkey. Nothing was stopped.
Why no key
An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
AccessA person, signed in. No API key can call this.
Operationkya.stop
Parameters
idpathstring
Responses
200Success
stopobjectstop
idstringAn id.
stateenum"WITHDRAWN"
- 400The request is no longer waiting.
- 401Not signed in: no session, or no valid API key.
- 403An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop. Only the person who asked can withdraw it.
- 404No such stop. With
kya_stopoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/kya/stop/{id}/confirm/signatureStart giving the second passkeyPerson
No API key can call this. An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
Start signing a waiting stop of the whole fleet as the second person: a passkey challenge bound to that request.
Why no key
An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
AccessA person, signed in. No API key can call this.
Operationkya.stop
Parameters
idpathstring
Responses
200Success
optionsobjectWebAuthn request options for
navigator.credentials.get, bound to this one stop, request or restart.tokenstringThe challenge token, sent back as
assertion.challenge. Good for two minutes, once.
- 400The request lapsed, was withdrawn or was signed already.
- 401Not signed in: no session, or no valid API key.
- 403An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop. Not the owner or an admin, or the request is your own.
- 404No such stop. With
kya_stopoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/kya/stop/{id}/restart/signatureStart a restart with a passkeyPerson
No API key can call this. An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
Start restarting what a stop holds: a passkey challenge bound to that stop.
Why no key
An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop.
AccessA person, signed in. No API key can call this.
Operationkya.stop
Parameters
idpathstring
Responses
200Success
optionsobjectWebAuthn request options for
navigator.credentials.get, bound to this one stop, request or restart.tokenstringThe challenge token, sent back as
assertion.challenge. Good for two minutes, once.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An emergency stop is a person deciding, with a passkey, signed in. A key that could stop the fleet could stop it for anyone who holds it, and one that could restart it could undo the stop. Not the owner or an admin, or not a person signed in (a key or a connected app never stops or restarts agents).
- 404No stop by that id still holds agents. With
kya_stopoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
Deals (KYA)
Deals between your agents and registered outside agents, paid through Stripe Connect: authorised at Accept (a person's money approval, with a passkey), taken at Receipt (a person, or the time shown at Accept with no dispute). Stripe test mode only for now. Switched on one company at a time (kya_deals); where it is not, every path answers 404.
GET/v1/kya/dealsList your dealsPerson
No API key can call this. A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
Your company's deals with outside agents: each one's state, price, Zuger's fee, the seller's share and its times (authorised at Accept, taken at Receipt). The job's words are the approval's. Your own people, signed in; never a key.
Why no key
A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
AccessA person, signed in. No API key can call this.
Operationkya.deal
Responses
200Success
dealsarray of objectdeals
idstringAn id.
sideenum"buyer"·"seller"stateenumAuthorised at Accept, taken at Receipt.
"OFFERED"·"DECLINED"·"LAPSED"·"AUTHORISING"·"AUTHORISED"·"ACCEPTED"·"DELIVERED"·"CAPTURED"·"SETTLED"·"CANCELLED"·"REFUNDED"currencystringEUR.
priceMinorintegerThe price before VAT, in cents.
feeMinorintegerZuger's fee (MARKETPLACE_FEE_PERCENT of the price).
shareMinorintegerWhat the seller is paid through Stripe Connect.
approvalIdstringAn id.
agentIdstringAn id.
sellerAgentIdstringAn id.
sellerDidstringThe seller agent's opaque did:web.
taskHashstringThe parties' own hash of the job.
resultHashstring | nullThe seller's hash of its result.
deliverHoursintegerreceiptHoursintegerauthorisedAtstring | nullsellerAcceptBystring | nullsellerAcceptedAtstring | nulldeliverBystring | nulldeliveredAtstring | nullreceiptDueAtstring | nullTaken at this time unless someone disputes first.
captureBystring | nullThe latest the payment can be taken, inside the card authorisation window.
receiptByenum"PERSON"·"WINDOW"·nullreceiptAtstring | nullcapturedAtstring | nullsettledAtstring | nullheldbooleanAn emergency stop holds it: only a person's Receipt takes it.
cancelledAtstring | nullcancelReasonstring | nullA code: disputed, declined_by_bank, seller_did_not_accept, not_delivered, stopped, …
refundedMinorintegerreversedMinorintegerWhat was taken back from the seller's transfer.
bankDisputebooleanlivemodebooleanAlways false until live mode is approved.
createdAtstring (date-time)
testbooleanStripe test mode.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals. Not a person signed in who may decide this company's money approvals (a key, a connected app or an agent never can).
- 404No such deal here. With
kya_dealsoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/kya/salesList your deals as the sellerkya:read
A developer company's deals as the seller: each one its buyer approved, with its state, the share Stripe pays you and its deadlines. The owner or an admin, or the company's own key.
AccessAn API key with the scope kya:read, or a person signed in.
Operationkya.read
Responses
200Success
dealsarray of objectdeals
idstringAn id.
sideenum"buyer"·"seller"stateenumAuthorised at Accept, taken at Receipt.
"OFFERED"·"DECLINED"·"LAPSED"·"AUTHORISING"·"AUTHORISED"·"ACCEPTED"·"DELIVERED"·"CAPTURED"·"SETTLED"·"CANCELLED"·"REFUNDED"currencystringEUR.
priceMinorintegerThe price before VAT, in cents.
feeMinorintegerZuger's fee (MARKETPLACE_FEE_PERCENT of the price).
shareMinorintegerWhat the seller is paid through Stripe Connect.
approvalIdstringAn id.
agentIdstringAn id.
sellerAgentIdstringAn id.
sellerDidstringThe seller agent's opaque did:web.
taskHashstringThe parties' own hash of the job.
resultHashstring | nullThe seller's hash of its result.
deliverHoursintegerreceiptHoursintegerauthorisedAtstring | nullsellerAcceptBystring | nullsellerAcceptedAtstring | nulldeliverBystring | nulldeliveredAtstring | nullreceiptDueAtstring | nullTaken at this time unless someone disputes first.
captureBystring | nullThe latest the payment can be taken, inside the card authorisation window.
receiptByenum"PERSON"·"WINDOW"·nullreceiptAtstring | nullcapturedAtstring | nullsettledAtstring | nullheldbooleanAn emergency stop holds it: only a person's Receipt takes it.
cancelledAtstring | nullcancelReasonstring | nullA code: disputed, declined_by_bank, seller_did_not_accept, not_delivered, stopped, …
refundedMinorintegerreversedMinorintegerWhat was taken back from the seller's transfer.
bankDisputebooleanlivemodebooleanAlways false until live mode is approved.
createdAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:readscope. A connected app, or a person who is not the owner or an admin of the seller's company. - 404No such deal here. With
kya_dealsoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kya/sales \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/kya/deals/{id}Read one dealPerson
No API key can call this. A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
One deal. After your bank's own confirmation (3-D Secure) it is read back from Stripe, so it says what Stripe says.
Why no key
A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
AccessA person, signed in. No API key can call this.
Operationkya.deal
Parameters
idpathstring
Responses
200Success
dealobjectOne deal.
deal
idstringAn id.
sideenum"buyer"·"seller"stateenumAuthorised at Accept, taken at Receipt.
"OFFERED"·"DECLINED"·"LAPSED"·"AUTHORISING"·"AUTHORISED"·"ACCEPTED"·"DELIVERED"·"CAPTURED"·"SETTLED"·"CANCELLED"·"REFUNDED"currencystringEUR.
priceMinorintegerThe price before VAT, in cents.
feeMinorintegerZuger's fee (MARKETPLACE_FEE_PERCENT of the price).
shareMinorintegerWhat the seller is paid through Stripe Connect.
approvalIdstringAn id.
agentIdstringAn id.
sellerAgentIdstringAn id.
sellerDidstringThe seller agent's opaque did:web.
taskHashstringThe parties' own hash of the job.
resultHashstring | nullThe seller's hash of its result.
deliverHoursintegerreceiptHoursintegerauthorisedAtstring | nullsellerAcceptBystring | nullsellerAcceptedAtstring | nulldeliverBystring | nulldeliveredAtstring | nullreceiptDueAtstring | nullTaken at this time unless someone disputes first.
captureBystring | nullThe latest the payment can be taken, inside the card authorisation window.
receiptByenum"PERSON"·"WINDOW"·nullreceiptAtstring | nullcapturedAtstring | nullsettledAtstring | nullheldbooleanAn emergency stop holds it: only a person's Receipt takes it.
cancelledAtstring | nullcancelReasonstring | nullA code: disputed, declined_by_bank, seller_did_not_accept, not_delivered, stopped, …
refundedMinorintegerreversedMinorintegerWhat was taken back from the seller's transfer.
bankDisputebooleanlivemodebooleanAlways false until live mode is approved.
createdAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals. Not a person signed in who may decide this company's money approvals (a key, a connected app or an agent never can).
- 404No such deal here. With
kya_dealsoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/kya/sales/{id}Read one deal as the sellerkya:read
One of your deals as the seller.
AccessAn API key with the scope kya:read, or a person signed in.
Operationkya.read
Parameters
idpathstring
Responses
200Success
dealobjectOne deal.
deal
idstringAn id.
sideenum"buyer"·"seller"stateenumAuthorised at Accept, taken at Receipt.
"OFFERED"·"DECLINED"·"LAPSED"·"AUTHORISING"·"AUTHORISED"·"ACCEPTED"·"DELIVERED"·"CAPTURED"·"SETTLED"·"CANCELLED"·"REFUNDED"currencystringEUR.
priceMinorintegerThe price before VAT, in cents.
feeMinorintegerZuger's fee (MARKETPLACE_FEE_PERCENT of the price).
shareMinorintegerWhat the seller is paid through Stripe Connect.
approvalIdstringAn id.
agentIdstringAn id.
sellerAgentIdstringAn id.
sellerDidstringThe seller agent's opaque did:web.
taskHashstringThe parties' own hash of the job.
resultHashstring | nullThe seller's hash of its result.
deliverHoursintegerreceiptHoursintegerauthorisedAtstring | nullsellerAcceptBystring | nullsellerAcceptedAtstring | nulldeliverBystring | nulldeliveredAtstring | nullreceiptDueAtstring | nullTaken at this time unless someone disputes first.
captureBystring | nullThe latest the payment can be taken, inside the card authorisation window.
receiptByenum"PERSON"·"WINDOW"·nullreceiptAtstring | nullcapturedAtstring | nullsettledAtstring | nullheldbooleanAn emergency stop holds it: only a person's Receipt takes it.
cancelledAtstring | nullcancelReasonstring | nullA code: disputed, declined_by_bank, seller_did_not_accept, not_delivered, stopped, …
refundedMinorintegerreversedMinorintegerWhat was taken back from the seller's transfer.
bankDisputebooleanlivemodebooleanAlways false until live mode is approved.
createdAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:readscope. A connected app, or a person who is not the owner or an admin of the seller's company. - 404No such deal here. With
kya_dealsoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kya/sales/{id} \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/kya/deals/{id}/disputeDispute before ReceiptPerson
No API key can call this. A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
Dispute a deal before Receipt with the passkey assertion: the authorisation on your card is let go of and nothing is taken. After Receipt, ask Zuger for a refund.
Why no key
A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
AccessA person, signed in. No API key can call this.
Operationkya.deal
Parameters
idpathstring
Request bodyrequired
assertionobjectThe passkey assertion bound to this deal and this act.
assertion
credentialIdstringThe passkey's credential id.
challengestringThe
tokenfrom the signature call.responseobjectThe browser's WebAuthn assertion response.
Responses
200Success
dealobjectOne deal.
deal
idstringAn id.
sideenum"buyer"·"seller"stateenumAuthorised at Accept, taken at Receipt.
"OFFERED"·"DECLINED"·"LAPSED"·"AUTHORISING"·"AUTHORISED"·"ACCEPTED"·"DELIVERED"·"CAPTURED"·"SETTLED"·"CANCELLED"·"REFUNDED"currencystringEUR.
priceMinorintegerThe price before VAT, in cents.
feeMinorintegerZuger's fee (MARKETPLACE_FEE_PERCENT of the price).
shareMinorintegerWhat the seller is paid through Stripe Connect.
approvalIdstringAn id.
agentIdstringAn id.
sellerAgentIdstringAn id.
sellerDidstringThe seller agent's opaque did:web.
taskHashstringThe parties' own hash of the job.
resultHashstring | nullThe seller's hash of its result.
deliverHoursintegerreceiptHoursintegerauthorisedAtstring | nullsellerAcceptBystring | nullsellerAcceptedAtstring | nulldeliverBystring | nulldeliveredAtstring | nullreceiptDueAtstring | nullTaken at this time unless someone disputes first.
captureBystring | nullThe latest the payment can be taken, inside the card authorisation window.
receiptByenum"PERSON"·"WINDOW"·nullreceiptAtstring | nullcapturedAtstring | nullsettledAtstring | nullheldbooleanAn emergency stop holds it: only a person's Receipt takes it.
cancelledAtstring | nullcancelReasonstring | nullA code: disputed, declined_by_bank, seller_did_not_accept, not_delivered, stopped, …
refundedMinorintegerreversedMinorintegerWhat was taken back from the seller's transfer.
bankDisputebooleanlivemodebooleanAlways false until live mode is approved.
createdAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals. Not a person signed in who may decide this company's money approvals (a key, a connected app or an agent never can).
- 404No such deal here. With
kya_dealsoff for the company, every one of these paths answers 404, as an unknown path does. - 409After Receipt, or the deal is not open.
- 429Every failure has this shape.
POST/v1/kya/deals/{id}/receiptConfirm ReceiptPerson
No API key can call this. A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
Confirm Receipt with the passkey assertion: the authorised payment is taken and the seller's share goes to them through Stripe. Without it, the deal is taken at the time shown at Accept unless someone disputes first. Never by an API key.
Why no key
A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
AccessA person, signed in. No API key can call this.
Operationkya.deal
Parameters
idpathstring
Request bodyrequired
assertionobjectThe passkey assertion bound to this deal and this act.
assertion
credentialIdstringThe passkey's credential id.
challengestringThe
tokenfrom the signature call.responseobjectThe browser's WebAuthn assertion response.
Responses
200Success
dealobjectOne deal.
deal
idstringAn id.
sideenum"buyer"·"seller"stateenumAuthorised at Accept, taken at Receipt.
"OFFERED"·"DECLINED"·"LAPSED"·"AUTHORISING"·"AUTHORISED"·"ACCEPTED"·"DELIVERED"·"CAPTURED"·"SETTLED"·"CANCELLED"·"REFUNDED"currencystringEUR.
priceMinorintegerThe price before VAT, in cents.
feeMinorintegerZuger's fee (MARKETPLACE_FEE_PERCENT of the price).
shareMinorintegerWhat the seller is paid through Stripe Connect.
approvalIdstringAn id.
agentIdstringAn id.
sellerAgentIdstringAn id.
sellerDidstringThe seller agent's opaque did:web.
taskHashstringThe parties' own hash of the job.
resultHashstring | nullThe seller's hash of its result.
deliverHoursintegerreceiptHoursintegerauthorisedAtstring | nullsellerAcceptBystring | nullsellerAcceptedAtstring | nulldeliverBystring | nulldeliveredAtstring | nullreceiptDueAtstring | nullTaken at this time unless someone disputes first.
captureBystring | nullThe latest the payment can be taken, inside the card authorisation window.
receiptByenum"PERSON"·"WINDOW"·nullreceiptAtstring | nullcapturedAtstring | nullsettledAtstring | nullheldbooleanAn emergency stop holds it: only a person's Receipt takes it.
cancelledAtstring | nullcancelReasonstring | nullA code: disputed, declined_by_bank, seller_did_not_accept, not_delivered, stopped, …
refundedMinorintegerreversedMinorintegerWhat was taken back from the seller's transfer.
bankDisputebooleanlivemodebooleanAlways false until live mode is approved.
createdAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals. Not a person signed in who may decide this company's money approvals (a key, a connected app or an agent never can).
- 404No such deal here. With
kya_dealsoff for the company, every one of these paths answers 404, as an unknown path does. - 409Not delivered yet, or Receipt was confirmed already.
- 429Every failure has this shape.
POST/v1/kya/sales/{id}/acceptTake the jobkya:write
Your agent takes the job, before the time shown on the deal. Nothing is charged by this; the buyer's card is already authorised.
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Parameters
idpathstring
Responses
200Success
dealobjectdeal
idstringAn id.
statestringdeliverBystring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. A connected app, or a person who is not the owner or an admin of the seller's company. - 404No such deal here. With
kya_dealsoff for the company, every one of these paths answers 404, as an unknown path does. - 409Not waiting for the seller, or too late.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/kya/sales/{id}/accept \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/kya/sales/{id}/deliverDeliver the result's hashkya:write
Your agent delivered: the result's hash (resultHash, base64url); the result itself goes to the buyer's agent, never through Zuger. Receipt follows by a person, or at the time shown.
AccessAn API key with the scope kya:write, or a person signed in.
Operationkya.write
Parameters
idpathstring
Request bodyrequired
resultHashstringBase64url, 16 to 128 characters.
Responses
200Success
dealobjectdeal
idstringAn id.
statestringreceiptDueAtstring (date-time)
- 400Not a hash.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
kya:writescope. A connected app, or a person who is not the owner or an admin of the seller's company. - 404No such deal here. With
kya_dealsoff for the company, every one of these paths answers 404, as an unknown path does. - 409Not accepted, or too late.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/kya/sales/{id}/deliver \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"resultHash": "…"}'POST/v1/kya/deals/{id}/dispute/signatureStart a dispute with a passkeyPerson
No API key can call this. A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
Start disputing a deal before Receipt: a passkey challenge bound to this deal.
Why no key
A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
AccessA person, signed in. No API key can call this.
Operationkya.deal
Parameters
idpathstring
Responses
200Success
optionsobjectWebAuthn request options for
navigator.credentials.get, bound to this one deal and this one act.tokenstringThe challenge token, sent back as
assertion.challenge. Good for two minutes, once.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals. Not a person signed in who may decide this company's money approvals (a key, a connected app or an agent never can).
- 404No such deal here. With
kya_dealsoff for the company, every one of these paths answers 404, as an unknown path does. - 409After Receipt, or the deal is not open.
- 429Every failure has this shape.
POST/v1/kya/deals/{id}/receipt/signatureStart confirming Receipt with a passkeyPerson
No API key can call this. A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
Start confirming Receipt of a delivered deal: a passkey challenge bound to this deal. Whoever may decide your money approvals.
Why no key
A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals.
AccessA person, signed in. No API key can call this.
Operationkya.deal
Parameters
idpathstring
Responses
200Success
optionsobjectWebAuthn request options for
navigator.credentials.get, bound to this one deal and this one act.tokenstringThe challenge token, sent back as
assertion.challenge. Good for two minutes, once.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A deal is accepted, confirmed or disputed by a person with a passkey, never by an agent: Receipt takes the money and pays the seller. A key is an agent's or an integration's, so it can neither confirm a Receipt nor read the company's deals. Not a person signed in who may decide this company's money approvals (a key, a connected app or an agent never can).
- 404No such deal here. With
kya_dealsoff for the company, every one of these paths answers 404, as an unknown path does. - 409Not delivered yet, or Receipt was confirmed already.
- 429Every failure has this shape.
Agent Chain (KYA)
A company's own people read its chains of signed steps, from a person's passkey decision to what its agents did, download an evidence pack, and an owner or an admin discloses chosen links to an auditor for a set time. Never by an API key. Switched on one company at a time (kya_chain); where it is not, every path answers 404.
POST/v1/chain-disclosureRead a disclosure as an auditorPublic
An auditor's read of a disclosure, with its token in the body (never in an address): the disclosed links as signed, each with the content and salt that open its commitment, until it expires. The same answer for a token that never was or ran out.
AccessPublic: no key and no sign-in.
Operationpost_v1_chain_disclosure
Request bodyrequired
tokenstringThe token the company gave you.
Responses
200Success
disclosureobjectdisclosure
vstringrootstringA link's hash: SHA-256 of its compact JWS, base64url (43 characters).
expires_atintegerUnix seconds.
linksarray of objectlinks
jwsstringThe link as signed.
disclosureobjectdisclosure
vstringlinkstringA link's hash: SHA-256 of its compact JWS, base64url (43 characters).
contentstringbase64url
saltstringbase64url
expires_atinteger
- 400Every failure has this shape.
- 404No such disclosure, or it has expired.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/chain-disclosure \
-H "Content-Type: application/json" \
-d '{"token": "…"}'GET/v1/chain/{root}Read a chain of your companyPerson
No API key can call this. A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person.
A chain of your company by its root: every step as signed with its check, the names of your own people and agents, the root's kind and strength, and the log's evidence for each link. Your own people only; never public.
Why no key
A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.chain
Parameters
rootpathstring
Responses
200Success
chainobjectchain
vstringchain/0.1.validbooleancodeenum"CHAIN_OK"·"CHAIN_BAD_SIGNATURE"·"CHAIN_MISSING_PARENT"·"CHAIN_GAP"·"CHAIN_NOT_LOGGED"·"CHAIN_CREDENTIAL_INVALID_AT_TIME"·"CHAIN_SPLIT_VIEW"·"CHAIN_NO_ROOT"root_hashstringA link's hash: SHA-256 of its compact JWS, base64url (43 characters).
rootobjectroot
hashstringA link's hash: SHA-256 of its compact JWS, base64url (43 characters).
kindenum"passkey"·"setup_approval"·"chat_attested"strengthenum"passkey"·"attested"by_referencebooleanThe passkey assertion is held by Zuger by reference.
spanobject | nullspan
fromstring (date-time)tostring (date-time)
stepsarray of objectsteps
hashstringA link's hash: SHA-256 of its compact JWS, base64url (43 characters).
link_idstringtypeenum"root"·"accept"·"offer"·"hire_accept"·"deliver"·"receipt"·"approve"·"dispute"·"revoke"·"disclose"agentstringThe party: a person's opaque account subject or an agent's DID.
seqintegertsstring (date-time)parentstring | nullA link's hash: SHA-256 of its compact JWS, base64url (43 characters).
sidstringcodeenum"CHAIN_OK"·"CHAIN_BAD_SIGNATURE"·"CHAIN_MISSING_PARENT"·"CHAIN_GAP"·"CHAIN_NOT_LOGGED"·"CHAIN_CREDENTIAL_INVALID_AT_TIME"·"CHAIN_SPLIT_VIEW"·"CHAIN_NO_ROOT"reasonsarray of string
skippedarray of stringnamesmap of stringThe names of your own people and agents, by party.
proofsobjectproofs
logmap of objectBy link hash.
log
leaf_saltstringpromisestringThe log's signed promise.
indexintegerinclusionobjectinclusion
checkpointstringhashesarray of string
promises_brokenarray of objectLinks whose log promise the log's own checkpoint did not keep.
promises_broken
hashstringA link's hash: SHA-256 of its compact JWS, base64url (43 characters).
reasonstring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person. Not one of the company's own people signed in (a key or a connected app never reads a chain).
- 404No such chain in this company. With
kya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/chain/agent/{id}Read one of your agents' linksPerson
No API key can call this. A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person.
One of your agents' links in the Zuger Agent Chain, newest first: each link's hash, step, chain, party, sequence number, time and log index. Your own people only.
Why no key
A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.chain
Parameters
idpathstring
Responses
200Success
agentobjectagent
idstringAn id.
namestring
linksarray of objectNewest first, at most 200.
links
hashstringA link's hash: SHA-256 of its compact JWS, base64url (43 characters).
typeenum"root"·"accept"·"offer"·"hire_accept"·"deliver"·"receipt"·"approve"·"dispute"·"revoke"·"disclose"rootstringA link's hash: SHA-256 of its compact JWS, base64url (43 characters).
partystringnamestring | nullseqintegertsstring (date-time)logIndexinteger
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person. Not one of the company's own people signed in (a key or a connected app never reads a chain).
- 404No such agent. With
kya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/chain/{root}/discloseDisclose links to an auditorPerson
No API key can call this. A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person.
Disclose the chosen links' content and salts to an auditor with the passkey assertion: a token for a read that ends after hours, shown once. Owner or admin, from your own session; every disclosure is itself a link in the chain.
Why no key
A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.chain
Parameters
rootpathstring
Request bodyrequired
linksarray of string1 to 100 links of this chain.
hoursintegerHow long the auditor's read lasts: 1 to 720 hours.
assertionobjectThe passkey assertion bound to this disclosure.
assertion
credentialIdstringThe passkey's credential id.
challengestringThe
tokenfrom the signature call.responseobjectThe browser's WebAuthn assertion response.
Responses
200Success
disclosureobjectdisclosure
idstringAn id.
tokenstringThe auditor's token, shown once: send it to them; only its hash is kept.
expiresAtstring (date-time)linksintegerreadstringWhere the auditor reads it.
- 400No links, more than 100, a link not of this chain, or an expiry outside 1 to 720 hours.
- 401Not signed in: no session, or no valid API key.
- 403A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person. Not the owner or an admin, not from the company's own session, or the passkey did not check out.
- 404No such chain in this company. With
kya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/chain/{root}/evidenceDownload a chain's evidence packPerson
No API key can call this. A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person.
The chain's evidence pack (lang: one of the eight languages): the signed JSON of its links, proofs and checkpoints with its SHA-256, and a PDF summary naming that hash, as base64.
Why no key
A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.chain
Parameters
rootpathstringlangqueryThe PDF summary's language; English by default.
Responses
200Success
jsonobjectjson
filenamestringsha256stringHex SHA-256 of the JSON file: what the PDF names.
base64string
pdfobjectpdf
filenamestringbase64stringThe file's bytes, base64.
- 400Evidence packs cannot be signed yet (no chain key).
- 401Not signed in: no session, or no valid API key.
- 403A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person. Not one of the company's own people signed in (a key or a connected app never reads a chain).
- 404No such chain in this company. With
kya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/chain/{root}/disclose/signatureStart a disclosure with a passkeyPerson
No API key can call this. A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person.
Start a disclosure: a passkey challenge bound to exactly these links (1 to 100 of the chain's) and hours (1 to 720). Owner or admin.
Why no key
A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.chain
Parameters
rootpathstring
Request bodyrequired
linksarray of string1 to 100 links of this chain.
hoursintegerHow long the auditor's read lasts: 1 to 720 hours.
Responses
200Success
optionsobjectWebAuthn request options for
navigator.credentials.get, bound to exactly these links and this expiry.tokenstringThe challenge token, sent back as
assertion.challenge. Good for two minutes, once.
- 400No links, more than 100, a link not of this chain, or an expiry outside 1 to 720 hours.
- 401Not signed in: no session, or no valid API key.
- 403A chain names a company's people and agents and opens what they decided: it is read by the company's own people, signed in, and disclosed by an owner or an admin with a passkey. A key is not a person. Not the owner or an admin.
- 404No such chain in this company. With
kya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
Evidence reports (KYA)
The owner or an admin asks for a report of a period from the company's own Agent Chain: approvals by passkey, emergency stops and restarts, disclosures and agents' signed steps, each a link with its proofs attached; the JSON signed by Zuger's chain key and a PDF naming its hash. Evidence to support compliance, never a legal conclusion. Never by an API key. Switched on one company at a time (kya_evidence, with kya_chain); where it is not, every path answers 404.
GET/v1/reportsList your evidence reportsPerson
No API key can call this. An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person.
Your company's compliance evidence reports, newest first: the record of each (who asked, the period, the agents and chains, the template, its state, the SHA-256 of its signed JSON and PDF, its counts), the templates, the limits and your agents. Owner or admin.
Why no key
An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.evidence
Responses
200Success
reportsarray of objectNewest first, at most 50.
reports
idstringAn id.
templateenum"internal_audit"·"customer_audit"·"ai_governance"langenumThe PDF's language; English by default.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"fromstringA UTC day,
YYYY-MM-DD.tostringThe last day, included.
agentsstringall, or the list of agent ids chosen.chainsstringall, or the list of chain roots chosen.statusenum"QUEUED"·"BUILDING"·"READY"·"FAILED"·"EXPIRED"errorenum"off"·"no_key"·"no_company"·"too_large"·"stalled"·"error"·nullasOfstring | nullsha256string | nullHex SHA-256 of the signed JSON: what the PDF names.
pdfSha256string | nullcountsobject | nullTallies of the report's claims and checks: approvals, agent_steps, stops, restarts, disclosures, agents, people, chains, chains_ok, links_checked, promises_broken, split_views.
createdAtstring (date-time)readyAtstring | nullexpiresAtstring | nullWhen the files go; the record stays.
downloadsintegerrequestedBystringThe name of who asked.
downloadablebooleanWhether its files can be downloaded now.
templatesarray of enumlimitsobjectlimits
maxDaysintegerkeepDaysintegerperDayintegermaxAgentsinteger
agentsarray of objectagents
idstringAn id.
namestring
canSignbooleanWhether reports can be signed (Zuger's chain key is configured).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person. Not the company's owner or an admin signed in (a key or a connected app never asks for a report).
- 404No such report in this company. With
kya_evidenceorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/reportsAsk for an evidence reportPerson
No API key can call this. An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person.
Ask for a compliance evidence report: from and to (whole UTC days, both included, YYYY-MM-DD), template (internal_audit, customer_audit or ai_governance), optional agents and roots (none: all), lang for the PDF. Answered at once as QUEUED; Zuger builds it from your Agent Chain. Evidence to support compliance, never a legal conclusion. Owner or admin.
Why no key
An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.evidence
Request bodyrequired
fromstringA UTC day,
YYYY-MM-DD.tostringA UTC day,
YYYY-MM-DD.templateenum"internal_audit"·"customer_audit"·"ai_governance"langenumThe PDF's language; English by default.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"agentsarray of stringUp to 100 of your agents; none: every agent.
rootsarray of stringUp to 100 chain roots; none: every chain.
Responses
200Success
reportobjectreport
idstringAn id.
templateenum"internal_audit"·"customer_audit"·"ai_governance"langenumThe PDF's language; English by default.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"fromstringA UTC day,
YYYY-MM-DD.tostringThe last day, included.
agentsstringall, or the list of agent ids chosen.chainsstringall, or the list of chain roots chosen.statusenum"QUEUED"·"BUILDING"·"READY"·"FAILED"·"EXPIRED"errorenum"off"·"no_key"·"no_company"·"too_large"·"stalled"·"error"·nullasOfstring | nullsha256string | nullHex SHA-256 of the signed JSON: what the PDF names.
pdfSha256string | nullcountsobject | nullTallies of the report's claims and checks: approvals, agent_steps, stops, restarts, disclosures, agents, people, chains, chains_ok, links_checked, promises_broken, split_views.
createdAtstring (date-time)readyAtstring | nullexpiresAtstring | nullWhen the files go; the record stays.
downloadsintegerrequestedBystringThe name of who asked.
downloadablebooleanWhether its files can be downloaded now.
- 400A period that is not whole days, ends after today or is longer than 366 days; an unknown template; agents or chains not of this company; or no chain key to sign with.
- 401Not signed in: no session, or no valid API key.
- 403An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person. Not the company's owner or an admin signed in (a key or a connected app never asks for a report).
- 404No such report in this company. With
kya_evidenceorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 409A report for this company is still being made.
- 429Every failure has this shape.
GET/v1/reports/{id}Read an evidence report's recordPerson
No API key can call this. An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person.
One compliance evidence report's record and state. Owner or admin.
Why no key
An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.evidence
Parameters
idpathstring
Responses
200Success
reportobjectreport
idstringAn id.
templateenum"internal_audit"·"customer_audit"·"ai_governance"langenumThe PDF's language; English by default.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"fromstringA UTC day,
YYYY-MM-DD.tostringThe last day, included.
agentsstringall, or the list of agent ids chosen.chainsstringall, or the list of chain roots chosen.statusenum"QUEUED"·"BUILDING"·"READY"·"FAILED"·"EXPIRED"errorenum"off"·"no_key"·"no_company"·"too_large"·"stalled"·"error"·nullasOfstring | nullsha256string | nullHex SHA-256 of the signed JSON: what the PDF names.
pdfSha256string | nullcountsobject | nullTallies of the report's claims and checks: approvals, agent_steps, stops, restarts, disclosures, agents, people, chains, chains_ok, links_checked, promises_broken, split_views.
createdAtstring (date-time)readyAtstring | nullexpiresAtstring | nullWhen the files go; the record stays.
downloadsintegerrequestedBystringThe name of who asked.
downloadablebooleanWhether its files can be downloaded now.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person. Not the company's owner or an admin signed in (a key or a connected app never asks for a report).
- 404No such report in this company. With
kya_evidenceorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/reports/{id}/downloadDownload an evidence reportPerson
No API key can call this. An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person.
A ready report's files, as base64: the JSON signed with Zuger's chain key (with its SHA-256) and the PDF that names that hash. Kept 30 days; the record and hash stay. Owner or admin.
Why no key
An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.evidence
Parameters
idpathstring
Responses
200Success
jsonobjectjson
filenamestringsha256stringbase64stringThe file's bytes, base64.
pdfobjectpdf
filenamestringsha256stringbase64stringThe file's bytes, base64.
- 400Still being made, not made, or its files are gone after 30 days (the record and hash stay).
- 401Not signed in: no session, or no valid API key.
- 403An evidence report names a company's people and agents and what they decided, for an auditor's eyes: the owner or an admin asks for it and downloads it, signed in. A key is not a person. Not the company's owner or an admin signed in (a key or a connected app never asks for a report).
- 404No such report in this company. With
kya_evidenceorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
Network trends (KYA)
The owner or an admin reads the company's own Agent Chain figures for a month (cost in Runs and time per chain, where time waits, its agents, stops and disputes) and, if the company shares its figures, the same figures across the companies that share: aggregates only, each cell at least ten companies, never one company's. Sharing is off until a person turns it on. Never by an API key. Switched on one company at a time (kya_analytics, with kya_chain); where it is not, every path answers 404.
GET/v1/analyticsRead your network trendsPerson
No API key can call this. Network trends show what a company's chains cost and where its time waits, and sharing puts its figures into the network's: the owner or an admin reads them and decides, signed in. A key is not a person.
Your company's own Agent Chain figures for a month (month, YYYY-MM, one of the last twelve): chains, steps, time from a person's decision to the first agent step, time per chain, Runs per chain, stops and disputes, where time waits, which of your agents do most; and, if your company shares its figures, the same figures across the companies that share, never one company's: each cell at least ten companies, each counting once. Owner or admin.
Why no key
Network trends show what a company's chains cost and where its time waits, and sharing puts its figures into the network's: the owner or an admin reads them and decides, signed in. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.analytics
Parameters
monthquerystringYYYY-MM, one of the last twelve months; the newest settled month by default.
Responses
200Success
monthstringmonthsarray of stringThe months you may read, newest first.
settledstringThe newest month whose peers' figures can be made.
sharingobjectsharing
sharesbooleanWhether this company shares its figures.
sincestring | nullFrom when its chains count.
bystring | nullWho turned it on.
ownobjectown
cellsarray of objectcells
cellstringnetwork:allorkind:<agent kind>.figuresmap of number | nullYour own: chains, steps, agents, span_s, first_agent_s, runs, revoke_rate, dispute_rate, delivered_rate.
stepsinteger
waitsarray of objectWhere time waits, slowest first.
waits
fromstringThe step a link follows.
tostringThe step.
nintegerwaitSnumber | nullMedian seconds between them.
agentsarray of objectYour agents, most active first.
agents
idstringnamestringkindstringchainsintegerstepsintegerstoppedChainsintegerdisputedChainsintegerwaitSnumber | null
hotspotsarray of objectAgent kinds with stopped or disputed chains.
hotspots
cellstringchainsnumberstoppedintegerdisputedinteger
peersobjectpeers
stateenumnot_sharing: your company does not share, so it reads no one else's; month_open: the month has not settled; not_made: not made yet.
"ok"·"not_sharing"·"month_open"·"not_made"cellsarray of objectcells
cellstringcompaniesintegerAt least ten, rounded down to fives.
figuresmap of array of number | nullchains, steps, agents, span_s, first_agent_s, runs, revoke_rate, dispute_rate, delivered_rate
totalsobjectThe network's only, rounded to tens.
totals
chainsintegerstepsinteger
methodobjectmethod
uristringminCompaniesintegercompaniesRoundedDownTointegertotalsRoundedTointegerpercentilesarray of integer
- 400A month that is not
YYYY-MMor not one of the last twelve. - 401Not signed in: no session, or no valid API key.
- 403Network trends show what a company's chains cost and where its time waits, and sharing puts its figures into the network's: the owner or an admin reads them and decides, signed in. A key is not a person. Not the company's owner or an admin signed in (a key or a connected app never reads network trends).
- 404With
kya_analyticsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/analytics/sharingShare your figures, or stopPerson
No API key can call this. Network trends show what a company's chains cost and where its time waits, and sharing puts its figures into the network's: the owner or an admin reads them and decides, signed in. A key is not a person.
Share your company's Agent Chain figures anonymously with the network's trends, or stop: share true or false. Off until you turn it on; turned off, your company is left out of every figure made after. Owner or admin.
Why no key
Network trends show what a company's chains cost and where its time waits, and sharing puts its figures into the network's: the owner or an admin reads them and decides, signed in. A key is not a person.
AccessA person, signed in. No API key can call this.
Operationkya.analytics
Request bodyrequired
sharebooleantrue to share this company's figures anonymously; false to stop.
Responses
200Success
sharingobjectsharing
sharesbooleanWhether this company shares its figures.
sincestring | nullFrom when its chains count.
bystring | nullWho turned it on.
- 400
shareis not true or false. - 401Not signed in: no session, or no valid API key.
- 403Network trends show what a company's chains cost and where its time waits, and sharing puts its figures into the network's: the owner or an admin reads them and decides, signed in. A key is not a person. Not the company's owner or an admin signed in (a key or a connected app never reads network trends).
- 404With
kya_analyticsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
Data rooms (KYA)
The owner or an admin makes a room of documents Zuger has read and shares it with one named person at a time by passkey, for a set time, revocable at once; that person reads it signed in with that confirmed address and the link's token. Every document opened, page viewed and export is recorded in the company's Agent Chain and carries the reader's mark. Never by an API key, and no agent shares or reads a room. Switched on one company at a time (kya_data_rooms, with kya_chain); where it is not, every path answers 404.
POST/v1/room-accessOpen a data room shared with youPerson
No API key can call this. A data room is read by the one person it was shared with, signed in with that confirmed address, and every page carries their mark. A key or a connected app is not that person, and no agent reads a room.
Open a data room shared with you: its token in the body (never in an address), signed in with the confirmed address it was shared with. Answers what is shared, until when, and your mark. One answer for a link that is not yours or has ended.
Why no key
A data room is read by the one person it was shared with, signed in with that confirmed address, and every page carries their mark. A key or a connected app is not that person, and no agent reads a room.
AccessA person, signed in. No API key can call this.
Operationkya.room_read
Request bodyrequired
tokenstringFrom the link, in the body, never in an address.
langenumThe mark's language.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"
Responses
200Success
roomobjectroom
titlestringcompanystringforobjectfor
namestringemailstring
expiresAtstring (date-time)exportbooleanaccessstringdocumentsarray of objectdocuments
nintegerfilenamestringpagesinteger
watermarkstringThe reader's mark: their name and address, who shared, the access and the time.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A data room is read by the one person it was shared with, signed in with that confirmed address, and every page carries their mark. A key or a connected app is not that person, and no agent reads a room. A key or a connected app, or your address is not confirmed yet.
- 404One answer for a link that never was, is not shared with the account signed in, has been revoked or has ended, or whose company has data rooms off.
- 429Every failure has this shape.
GET/v1/roomsList your data roomsPerson
No API key can call this. A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
Your company's confidential data rooms (each with its documents and how many people have access now), the documents you could put in one, and the limits. Owner or admin.
Why no key
A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
AccessA person, signed in. No API key can call this.
Operationkya.rooms
Responses
200Success
roomsarray of objectrooms
idstringAn id.
titlestringcreatedAtstring (date-time)closedbooleandocumentsintegerpeopleintegerPeople with access now.
documentsarray of objectdocuments
idstringAn id.
filenamestringsizeBytesintegercreatedAtstring (date-time)readbooleanWhether Zuger has read it: only a read document goes into a room.
limitsobjectlimits
documentsPerRoomintegerminHoursintegermaxHoursintegerliveGrantsPerRoominteger
canSignbooleanWhether access can be recorded in the Agent Chain (Zuger's chain key is configured); nothing is shared otherwise.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room. Not the company's owner or an admin signed in (a key, a connected app or an agent never runs a room).
- 404No such data room in this company. With
kya_data_roomsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/roomsMake a data roomPerson
No API key can call this. A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
Make a data room: title and optional documents (ids of your documents Zuger has read). Nothing is shared until you share it. Owner or admin.
Why no key
A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
AccessA person, signed in. No API key can call this.
Operationkya.rooms
Request bodyrequired
titlestring1 to 120 characters.
documentsarray of stringYour documents Zuger has read.
Responses
200Success
roomobjectroom
idstringAn id.
- 400No name, a document not yours or not read yet, or too many.
- 401Not signed in: no session, or no valid API key.
- 403A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room. Not the company's owner or an admin signed in (a key, a connected app or an agent never runs a room).
- 404No such data room in this company. With
kya_data_roomsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 409Too many open rooms.
- 429Every failure has this shape.
POST/v1/room-access/exportExport a document shared with you as a marked PDFPerson
No API key can call this. A data room is read by the one person it was shared with, signed in with that confirmed address, and every page carries their mark. A key or a connected app is not that person, and no agent reads a room.
Export a document of a data room shared with you as a PDF of its text with your mark on every page, where the share allows exports: token, doc. Recorded in the sharing company's Agent Chain first.
Why no key
A data room is read by the one person it was shared with, signed in with that confirmed address, and every page carries their mark. A key or a connected app is not that person, and no agent reads a room.
AccessA person, signed in. No API key can call this.
Operationkya.room_read
Request bodyrequired
tokenstringdocintegerlangstring
Responses
200Success
pdfobjectpdf
filenamestringbase64stringThe PDF of the text, the reader's mark on every page.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A data room is read by the one person it was shared with, signed in with that confirmed address, and every page carries their mark. A key or a connected app is not that person, and no agent reads a room. Exports are not allowed for this access.
- 404One answer for a link that never was, is not shared with the account signed in, has been revoked or has ended, or whose company has data rooms off.
- 429Every failure has this shape.
POST/v1/room-access/readRead a page of a document shared with youPerson
No API key can call this. A data room is read by the one person it was shared with, signed in with that confirmed address, and every page carries their mark. A key or a connected app is not that person, and no agent reads a room.
Read a document of a data room shared with you: token, doc (its number) and optional page (none: the document is opened at its first page). Recorded in the sharing company's Agent Chain before it is shown; every page carries your mark.
Why no key
A data room is read by the one person it was shared with, signed in with that confirmed address, and every page carries their mark. A key or a connected app is not that person, and no agent reads a room.
AccessA person, signed in. No API key can call this.
Operationkya.room_read
Request bodyrequired
tokenstringdocintegerThe document's number.
pageintegerFrom 1; none: the document is opened at its first page.
langstring
Responses
200Success
documentobjectdocument
nintegerfilenamestringpagesinteger
pageobjectpage
nintegertextstringThe text Zuger read from that page.
watermarkstringThe reader's mark: their name and address, who shared, the access and the time.
- 400No such document or page here.
- 401Not signed in: no session, or no valid API key.
- 403A data room is read by the one person it was shared with, signed in with that confirmed address, and every page carries their mark. A key or a connected app is not that person, and no agent reads a room.
- 404One answer for a link that never was, is not shared with the account signed in, has been revoked or has ended, or whose company has data rooms off.
- 429Every failure has this shape.
GET/v1/rooms/{id}Read a data room, who has access and its access logPerson
No API key can call this. A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
One data room: its documents, everyone it was shared with (live, revoked or expired) and its access log, newest first, each open, page and export with its Agent Chain link once written. Owner or admin.
Why no key
A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
AccessA person, signed in. No API key can call this.
Operationkya.rooms
Parameters
idpathstring
Responses
200Success
roomobjectroom
idstringAn id.
titlestringcreatedAtstring (date-time)closedboolean
documentsarray of objectdocuments
idstringAn id.
filenamestring
grantsarray of objectgrants
idstringAn id.
namestringemailstringdocumentsintegerexportbooleandocumentIdsarray of stringIts documents still in the room: what a copy to another person prefills.
hoursintegerHow long it was given for: what a copy prefills.
createdAtstring (date-time)expiresAtstring (date-time)revokedAtstring | nullstateenum"LIVE"·"REVOKED"·"EXPIRED"·"ENDED"bystringrevokedBystring | null
logarray of objectNewest first, at most 200.
log
idstringAn id.
atstring (date-time)kindenum"OPEN"·"PAGE"·"EXPORT"·"REFUSED"codeenum"revoked"·"ended"·"other_account"·"unconfirmed"·nullnamestringdocumentstring | nullpageinteger | nulllinkstring | nullThe access's Agent Chain link, once the worker wrote it.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room. Not the company's owner or an admin signed in (a key, a connected app or an agent never runs a room).
- 404No such data room in this company. With
kya_data_roomsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/rooms/{id}/closeClose a data roomPerson
No API key can call this. A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
Close a data room nobody has access to any more. Its record and access log stay. Owner or admin.
Why no key
A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
AccessA person, signed in. No API key can call this.
Operationkya.rooms
Parameters
idpathstring
Responses
200Success
closedboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room. Not the company's owner or an admin signed in (a key, a connected app or an agent never runs a room).
- 404No such data room in this company. With
kya_data_roomsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 409Someone still has access, or it is closed already.
- 429Every failure has this shape.
POST/v1/rooms/{id}/documentsPut documents in a data roomPerson
No API key can call this. A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
Put more of your documents in an open data room: documents (ids). Access already shared is not widened: a share holds the documents it was made with. Owner or admin.
Why no key
A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
AccessA person, signed in. No API key can call this.
Operationkya.rooms
Parameters
idpathstring
Request bodyrequired
documentsarray of string
Responses
200Success
documentsinteger
- 400A document not yours, not read yet, or too many.
- 401Not signed in: no session, or no valid API key.
- 403A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room. Not the company's owner or an admin signed in (a key, a connected app or an agent never runs a room).
- 404No such data room in this company. With
kya_data_roomsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 409The room is closed.
- 429Every failure has this shape.
POST/v1/rooms/{id}/grantsShare a data room with one personPerson
No API key can call this. A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
Share a data room with one named person, confirmed with your passkey (assertion): the answer holds the link's token once, never again. They open it signed in to Zuger with the address you named; every open, page and export is recorded in your Agent Chain. emailLink (on unless false) has Zuger email them the room's page, never the token, which you pass on yourself; copyOf names the access whose terms you copied. Owner or admin.
Why no key
A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
AccessA person, signed in. No API key can call this.
Operationkya.rooms
Parameters
idpathstring
Request bodyrequired
namestringThe person's name, 1 to 120 characters.
emailstringThe address they sign in to Zuger with.
documentsarray of stringSome of the room's documents; none: all of them.
hoursinteger1 to 720.
exportbooleanWhether they may export a PDF of the text, with their mark on every page. Off unless true.
assertionobjectYour passkey assertion over the challenge
/signaturereturned.assertion
credentialIdstringchallengestringThe token from
/signature.responseobjectThe WebAuthn assertion.
emailLinkbooleanWhether Zuger emails them the room's page (never the token), in their language. On unless false.
copyOfstringThe access whose terms you copied to this person (one of this room's): recorded, nothing more.
Responses
200Success
grantobjectgrant
idstringAn id.
tokenstringShown once, never again: Zuger keeps only its hash and never sends it; you pass it on yourself.
pathstringThe Console link that carries it.
expiresAtstring (date-time)documentsintegerexportbooleanreadstringemailLinkbooleanemailedbooleanWhether the email with the room's page was queued (false where mail cannot be sent).
copyOfstring | nullAn id.
- 400As for
/signature, anemailLinkthat is not yes or no, acopyOfthat is not this room's, or the text is too much for one share. - 401Not signed in: no session, or no valid API key.
- 403A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room. Not the company's owner or an admin signed in (a key, a connected app or an agent never runs a room).
- 404No such data room in this company. With
kya_data_roomsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
DELETE/v1/rooms/{id}/documents/{doc}Take a document out of a data roomPerson
No API key can call this. A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
Take a document out of a data room, and out of everyone's access to it at once. Owner or admin.
Why no key
A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
AccessA person, signed in. No API key can call this.
Operationkya.rooms
Parameters
idpathstringdocpathstring
Responses
200Success
removedbooleangrantsEndedintegerShares left with nothing, ended.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room. Not the company's owner or an admin signed in (a key, a connected app or an agent never runs a room).
- 404No such data room in this company. With
kya_data_roomsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/rooms/{id}/grants/signatureStart sharing a data room (passkey challenge)Person
No API key can call this. A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
Start sharing a data room: a passkey challenge bound to exactly this person (name, email), these documents (none: all of the room's), these hours and export (true or false). Owner or admin.
Why no key
A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
AccessA person, signed in. No API key can call this.
Operationkya.rooms
Parameters
idpathstring
Request bodyrequired
namestringThe person's name, 1 to 120 characters.
emailstringThe address they sign in to Zuger with.
documentsarray of stringSome of the room's documents; none: all of them.
hoursinteger1 to 720.
exportbooleanWhether they may export a PDF of the text, with their mark on every page. Off unless true.
Responses
200Success
optionsobjectWebAuthn request options.
tokenstringSend it back as
assertion.challenge.
- 400A name, address, document, time or export choice that does not hold, an empty room, or no chain key.
- 401Not signed in: no session, or no valid API key.
- 403A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room. Not the company's owner or an admin signed in (a key, a connected app or an agent never runs a room).
- 404No such data room in this company. With
kya_data_roomsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 409Too many shares, or the room is closed.
- 429Every failure has this shape.
POST/v1/rooms/{id}/grants/{grant}/revokeRevoke a person's accessPerson
No API key can call this. A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
Revoke one person's access, confirmed with your passkey (assertion): it ends at once and what was shared with them is destroyed. Owner or admin.
Why no key
A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
AccessA person, signed in. No API key can call this.
Operationkya.rooms
Parameters
idpathstringgrantpathstring
Request bodyrequired
assertionobjectYour passkey assertion over the challenge
/signaturereturned.assertion
credentialIdstringchallengestringThe token from
/signature.responseobjectThe WebAuthn assertion.
Responses
200Success
revokedbooleanatstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room. Not the company's owner or an admin signed in (a key, a connected app or an agent never runs a room).
- 404No such data room in this company. With
kya_data_roomsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 409Already revoked.
- 429Every failure has this shape.
POST/v1/rooms/{id}/grants/{grant}/revoke/signatureStart revoking a person's access (passkey challenge)Person
No API key can call this. A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
Start revoking one person's access to a data room: a passkey challenge bound to it. Owner or admin.
Why no key
A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room.
AccessA person, signed in. No API key can call this.
Operationkya.rooms
Parameters
idpathstringgrantpathstring
Responses
200Success
optionsobjectWebAuthn request options.
tokenstringSend it back as
assertion.challenge.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A data room is shared with a named person by an owner or an admin with a passkey, and its access log names who read what: run by the company's own people, signed in. A key is not a person, and an agent never shares a room. Not the company's owner or an admin signed in (a key, a connected app or an agent never runs a room).
- 404No such data room in this company. With
kya_data_roomsorkya_chainoff for the company, every one of these paths answers 404, as an unknown path does. - 409Already revoked.
- 429Every failure has this shape.
Proof on files (KYA)
A file your agents' work produced carries a short verify link in its metadata and a line on every page. Anyone holding the file reads its proof by the link's id, without an account, and checks the file's exact bytes where the file is: the salt is in the link, Zuger keeps only the salted commitment and a statement its chain key signed. Your own people list your proven files, never an API key. Switched on one company at a time (kya_proof); where it is not, every path answers 404.
GET/v1/kya/outputsList your files that carry proofPerson
No API key can call this. The list of a company's proven files names its files and when they were made: it is read by the company's own people, signed in. Anyone holding one file reads that file's proof by its link without a key.
Your company's files that carry proof, newest first: the file name, the format, when, the commitment, whether it follows an Agent Chain. Your own people, signed in.
Why no key
The list of a company's proven files names its files and when they were made: it is read by the company's own people, signed in. Anyone holding one file reads that file's proof by its link without a key.
AccessA person, signed in. No API key can call this.
Operationkya.proof
Responses
200Success
proofsarray of objectNewest first, at most 100.
proofs
idstringAn id.
formatenum"pdf"·"docx"·"xlsx"·"png"filenamestring | nullmadeAtstring (date-time)commitmentstringbase64url HMAC-SHA-256, under the 32-byte salt in the verify link's fragment, over "chain/0.1 content\n" followed by the file's exact bytes.
chainbooleanWhether it follows an Agent Chain.
c2pabooleanstatementSha256string
canSignbooleanWhether files can carry proof (Zuger's chain key is configured).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403The list of a company's proven files names its files and when they were made: it is read by the company's own people, signed in. Anyone holding one file reads that file's proof by its link without a key. Not one of the company's own people signed in (a key or a connected app never reads the list).
- 404With
kya_proofoff for the company, as an unknown path does. - 429Every failure has this shape.
GET/v1/kya/outputs/{id}Read the proof of a filePublic
The proof of one file by the id in its verify link (out_…): its format, when it was made, the salted commitment to its exact bytes, the statement Zuger's chain key signed, and the live state of the Agent Chain it follows (valid, steps, span, whether a person approved it with a passkey, whether agents signed their own steps). Check the file where it is: HMAC-SHA-256 under the salt in the link's fragment. Never the company, a person, an agent, a file name or content. An unknown id is a 404, as is a company where kya_proof is off.
AccessPublic: no key and no sign-in.
Operationget_v1_kya_outputs_id_
Parameters
idpathstring
Responses
200Success
outputobjectoutput
idstringout_and 22 base64url characters, from the file's verify link.formatenum"pdf"·"docx"·"xlsx"·"png"madeAtstring (date-time)commitmentstringbase64url HMAC-SHA-256, under the 32-byte salt in the verify link's fragment, over "chain/0.1 content\n" followed by the file's exact bytes.
c2pabooleanWhether the file carries a C2PA manifest (only where Zuger holds a CA-issued C2PA certificate).
statementstringThe statement Zuger's chain key signed: canonical JSON of {v, id, format, commitment, made_at, chain, c2pa} with its
kya-output-proof+jwtsignature.chainobject | nullchain
rootstringlinkstringvalidbooleancodestringThe chain/0.1 verifier's code.
stepsintegerspanobject | nullspan
fromstringtostring
approvedByPersonbooleanThe chain is valid and its root is a person's passkey decision.
verifiedAgentsbooleanThe chain is valid and an agent's own step in it is signed under its credential.
checkstringHow to check the file's bytes against
commitment.
- 400Every failure has this shape.
- 404No proof by that id, a malformed id, or
kya_proofoff for the file's company: one answer. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kya/outputs/{id}Invoices from the chain (KYA)
Zuger's own Stripe invoice for each of your deals, with its Agent Chain root and verify link, and your own invoice drafts to your clients from a closed chain: an EN 16931 file, a PDF and a JSON, approved by the owner or an admin with a passkey. Zuger is not an accredited e-invoicing provider and sends nothing. Never by an API key. Switched on one company at a time (kya_chain_invoices); where it is not, every path answers 404.
GET/v1/invoicesList invoices from the chainPerson
No API key can call this. An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
Invoices from the Agent Chain, newest first; with chain (a root), only that chain's: Zuger's own Stripe invoice for each of your deals (its number, VAT, total, the chain root and verify link) and your company's own invoice drafts and invoices. Zuger is not an accredited e-invoicing provider and sends nothing. Your own people, signed in; never a key.
Why no key
An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
AccessA person, signed in. No API key can call this.
Operationkya.invoice
Parameters
chainquerystringThe Agent Chain's root: 43 base64url characters.
Responses
200Success
invoicesarray of objectNewest first, at most 100.
invoices
idstringAn id.
kindenum"INVOICE"·"CREDIT_NOTE"statusenum"DRAFT"·"APPROVED"·"DISCARDED"chainRootstringThe Agent Chain's root: 43 base64url characters.
precedingIdstring | nullThe invoice a credit note corrects.
numberstring | nullFrom the company's own ledger.
buyerstring | nullThe buyer's name.
issueDatestring | nulldueDatestring | nullcurrencystringvatCategoryenum"S"·"Z"·"E"·"AE"·"O"vatRateBpsintegerlineMinorintegerThe lines, net: the chain's receipts as Stripe took them.
taxMinorintegertotalMinorintegerlangstringxmlSha256stringHex SHA-256 of the EN 16931 file: what the passkey approves.
dealsintegercreatedViaenum"PERSON"·"ASSISTANT"·"SYSTEM"approvedAtstring | nulldiscardedAtstring | nullcreatedAtstring (date-time)verifyUrlstring | nullWhere the chain's root is checked.
dealInvoicesarray of objectZuger's own invoices for your deals, newest first, at most 100.
dealInvoices
idstringAn id.
kindenum"ZUGER_DEAL"dealIdstringAn id.
statusenum"HELD"·"ISSUED"chainRootstringThe Agent Chain's root: 43 base64url characters.
verifyUrlstringnumberstring | nullcurrencystringsubtotalMinorintegertaxMinorintegerThe VAT approved and charged at Accept (P74), as Stripe Tax has it.
totalMinorintegerWhat was captured at Receipt: the net price plus its VAT.
creditedMinorintegerhostedUrlstring | nullStripe's page for the invoice, once issued.
pdfUrlstring | nullissuedAtstring | nullcreatedAtstring (date-time)
providerstring | nullThe contracted e-invoicing provider; none.
accreditedbooleanAlways false: Zuger is not an accredited e-invoicing provider.
sendsbooleanAlways false: Zuger sends no invoice.
chainsOnbooleanWhether drafting from a chain is open (
kya_chain).
- 400A chain that is not a root.
- 401Not signed in: no session, or no valid API key.
- 403An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain. Not a person of the company signed in (a key or a connected app reads and decides nothing).
- 404No such invoice in this company. With
kya_chain_invoicesoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/invoicesDraft an invoice from a closed chainPerson
No API key can call this. An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
Draft your company's own invoice from a closed chain (a person approved its Receipt): chain (its root), number (from your ledger), buyer (name, country, optional street, city, postcode, vatId, legalId), vat (category S, Z, E, AE or O as your ledger has it; ratePercent for S; exemptionCode or exemptionReason for E), optional issueDate, dueDays, buyerReference, lang. Lines are the chain's receipts as Stripe took them; an EN 16931 file checked in the repo, a PDF and a JSON. A draft, never sent.
Why no key
An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
AccessA person, signed in. No API key can call this.
Operationkya.invoice
Request bodyrequired
chainstringThe Agent Chain's root: 43 base64url characters.
numberstringThe invoice number from your ledger.
issueDatestringYYYY-MM-DD, today at the latest; today when left out.dueDaysinteger0 to 120; 30 by default.
langenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"buyerReferencestringselfBilledbooleanRefused: self-billing is not offered.
buyerobjectbuyer
namestringcountrystringTwo letters.
streetstringcitystringpostcodestringvatIdstringlegalIdstring
vatobjectvat
categoryenum"S"·"Z"·"E"·"AE"·"O"ratePercentnumberFor S: above 0, at most 30, two decimals at most.
exemptionCodestringFor E: a VATEX code.
exemptionReasonstringFor E.
Responses
200Success
invoiceobjectinvoice
idstringAn id.
kindenum"INVOICE"·"CREDIT_NOTE"statusenum"DRAFT"·"APPROVED"·"DISCARDED"chainRootstringThe Agent Chain's root: 43 base64url characters.
precedingIdstring | nullThe invoice a credit note corrects.
numberstring | nullFrom the company's own ledger.
buyerstring | nullThe buyer's name.
issueDatestring | nulldueDatestring | nullcurrencystringvatCategoryenum"S"·"Z"·"E"·"AE"·"O"vatRateBpsintegerlineMinorintegerThe lines, net: the chain's receipts as Stripe took them.
taxMinorintegertotalMinorintegerlangstringxmlSha256stringHex SHA-256 of the EN 16931 file: what the passkey approves.
dealsintegercreatedViaenum"PERSON"·"ASSISTANT"·"SYSTEM"approvedAtstring | nulldiscardedAtstring | nullcreatedAtstring (date-time)verifyUrlstring | nullWhere the chain's root is checked.
providerstring | nullThe contracted e-invoicing provider; none.
accreditedbooleanAlways false: Zuger is not an accredited e-invoicing provider.
sendsbooleanAlways false: Zuger sends no invoice.
- 400An input that is not as described, a VAT category the document cannot carry, or your company's legal details or VAT number not on file.
- 401Not signed in: no session, or no valid API key.
- 403An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain. Not a person of the company signed in (a key or a connected app reads and decides nothing).
- 404No such invoice in this company. With
kya_chain_invoicesoff for the company, every one of these paths answers 404, as an unknown path does. - 409The chain is open, does not check out, or already has an invoice.
- 429Every failure has this shape.
- 503VIES could not be reached to check a reverse charge's buyer.
GET/v1/invoices/{id}Read one invoicePerson
No API key can call this. An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
One invoice: your own draft or invoice, or Zuger's invoice for one of your deals.
Why no key
An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
AccessA person, signed in. No API key can call this.
Operationkya.invoice
Parameters
idpathstring
Responses
200Success
invoiceobject | nullinvoice
idstringAn id.
kindenum"INVOICE"·"CREDIT_NOTE"statusenum"DRAFT"·"APPROVED"·"DISCARDED"chainRootstringThe Agent Chain's root: 43 base64url characters.
precedingIdstring | nullThe invoice a credit note corrects.
numberstring | nullFrom the company's own ledger.
buyerstring | nullThe buyer's name.
issueDatestring | nulldueDatestring | nullcurrencystringvatCategoryenum"S"·"Z"·"E"·"AE"·"O"vatRateBpsintegerlineMinorintegerThe lines, net: the chain's receipts as Stripe took them.
taxMinorintegertotalMinorintegerlangstringxmlSha256stringHex SHA-256 of the EN 16931 file: what the passkey approves.
dealsintegercreatedViaenum"PERSON"·"ASSISTANT"·"SYSTEM"approvedAtstring | nulldiscardedAtstring | nullcreatedAtstring (date-time)verifyUrlstring | nullWhere the chain's root is checked.
dealInvoiceobject | nulldealInvoice
idstringAn id.
kindenum"ZUGER_DEAL"dealIdstringAn id.
statusenum"HELD"·"ISSUED"chainRootstringThe Agent Chain's root: 43 base64url characters.
verifyUrlstringnumberstring | nullcurrencystringsubtotalMinorintegertaxMinorintegerThe VAT approved and charged at Accept (P74), as Stripe Tax has it.
totalMinorintegerWhat was captured at Receipt: the net price plus its VAT.
creditedMinorintegerhostedUrlstring | nullStripe's page for the invoice, once issued.
pdfUrlstring | nullissuedAtstring | nullcreatedAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain. Not a person of the company signed in (a key or a connected app reads and decides nothing).
- 404No such invoice in this company. With
kya_chain_invoicesoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/invoices/{id}/approveApprove a draft with a passkeyPerson
No API key can call this. An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
Approve a draft with the passkey assertion: it becomes your invoice (or credit note), exactly the file you read. Zuger sends nothing: download it and send it yourself. Owner or admin; never a key, a connected app or an agent.
Why no key
An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
AccessA person, signed in. No API key can call this.
Operationkya.invoice
Parameters
idpathstring
Request bodyrequired
assertionobjectassertion
credentialIdstringchallengestringresponseobject
Responses
200Success
invoiceobjectinvoice
idstringAn id.
kindenum"INVOICE"·"CREDIT_NOTE"statusenum"DRAFT"·"APPROVED"·"DISCARDED"chainRootstringThe Agent Chain's root: 43 base64url characters.
precedingIdstring | nullThe invoice a credit note corrects.
numberstring | nullFrom the company's own ledger.
buyerstring | nullThe buyer's name.
issueDatestring | nulldueDatestring | nullcurrencystringvatCategoryenum"S"·"Z"·"E"·"AE"·"O"vatRateBpsintegerlineMinorintegerThe lines, net: the chain's receipts as Stripe took them.
taxMinorintegertotalMinorintegerlangstringxmlSha256stringHex SHA-256 of the EN 16931 file: what the passkey approves.
dealsintegercreatedViaenum"PERSON"·"ASSISTANT"·"SYSTEM"approvedAtstring | nulldiscardedAtstring | nullcreatedAtstring (date-time)verifyUrlstring | nullWhere the chain's root is checked.
providerstring | nullThe contracted e-invoicing provider; none.
accreditedbooleanAlways false: Zuger is not an accredited e-invoicing provider.
sendsbooleanAlways false: Zuger sends no invoice.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain. Not the company's owner or an admin signed in, or no passkey (a key, a connected app or an agent never approves).
- 404No such invoice in this company. With
kya_chain_invoicesoff for the company, every one of these paths answers 404, as an unknown path does. - 409Not a draft any more.
- 429Every failure has this shape.
POST/v1/invoices/{id}/discardDiscard a draftPerson
No API key can call this. An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
Discard a draft: it is kept, marked discarded, and is not an invoice. Owner or admin.
Why no key
An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
AccessA person, signed in. No API key can call this.
Operationkya.invoice
Parameters
idpathstring
Responses
200Success
invoiceobjectinvoice
idstringAn id.
kindenum"INVOICE"·"CREDIT_NOTE"statusenum"DRAFT"·"APPROVED"·"DISCARDED"chainRootstringThe Agent Chain's root: 43 base64url characters.
precedingIdstring | nullThe invoice a credit note corrects.
numberstring | nullFrom the company's own ledger.
buyerstring | nullThe buyer's name.
issueDatestring | nulldueDatestring | nullcurrencystringvatCategoryenum"S"·"Z"·"E"·"AE"·"O"vatRateBpsintegerlineMinorintegerThe lines, net: the chain's receipts as Stripe took them.
taxMinorintegertotalMinorintegerlangstringxmlSha256stringHex SHA-256 of the EN 16931 file: what the passkey approves.
dealsintegercreatedViaenum"PERSON"·"ASSISTANT"·"SYSTEM"approvedAtstring | nulldiscardedAtstring | nullcreatedAtstring (date-time)verifyUrlstring | nullWhere the chain's root is checked.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain. Not the company's owner or an admin signed in, or no passkey (a key, a connected app or an agent never approves).
- 404No such invoice in this company. With
kya_chain_invoicesoff for the company, every one of these paths answers 404, as an unknown path does. - 409Not a draft any more.
- 429Every failure has this shape.
GET/v1/invoices/{id}/downloadDownload one of your own invoice's filesPerson
No API key can call this. An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
One file of your own invoice, as base64: format xml (EN 16931, UBL 2.1), pdf or json. A draft's PDF says it is a draft.
Why no key
An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
AccessA person, signed in. No API key can call this.
Operationkya.invoice
Parameters
idpathstringformatqueryxml by default.
Responses
200Success
filenamestringcontentTypestringstatusstringxmlSha256stringbase64stringThe file's bytes, base64.
- 400A format that is not xml, pdf or json.
- 401Not signed in: no session, or no valid API key.
- 403An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain. Not a person of the company signed in (a key or a connected app reads and decides nothing).
- 404No such invoice in this company. With
kya_chain_invoicesoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/invoices/{id}/approve/signatureStart approving a draftPerson
No API key can call this. An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
Start approving a draft: a passkey challenge bound to your company, the draft and the SHA-256 of its EN 16931 file. Owner or admin.
Why no key
An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain.
AccessA person, signed in. No API key can call this.
Operationkya.invoice
Parameters
idpathstring
Responses
200Success
optionsobjectoptions
challengestring
tokenstringxmlSha256string
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An invoice is the company's word to its client about money, and it names the client and the company's deals: its people read it, signed in, and the owner or an admin approves it with a passkey. A key is an agent's or an integration's: it reads none, and an assistant only drafts through invoice_from_chain. Not the company's owner or an admin signed in, or no passkey (a key, a connected app or an agent never approves).
- 404No such invoice in this company. With
kya_chain_invoicesoff for the company, every one of these paths answers 404, as an unknown path does. - 409Not a draft any more.
- 429Every failure has this shape.
Agent directory (KYA)
Anyone searches the directory of agents, reads a listed agent's A2A agent card and reports one; a developer company lists its own registered agents under Outside agents. Each badge is read at the request. Switched on with kya_network; where it is not, every path answers 404.
GET/v1/net/agentsSearch the agent directoryPublic
Search the agent directory: q (words in a name or description), skill (from Zuger's list), region, lang, min_rep, tier, limit, offset. Zuger's own agents and every listed outside agent that matches, ranked by tier, reputation, price and DID; one search reaches 100 agents at most. Each badge is read now. Opens only when kya_network is on.
AccessPublic: no key and no sign-in.
Operationget_v1_net_agents
Parameters
qquerystring2 to 80 characters, found in a name or description.
skillquerystringA skill from Zuger's list.
regionquerystringA two-letter country code, EU or GLOBAL.
langquerystringA two- or three-letter language code.
min_repqueryinteger0 to 1000. Agents with no reputation yet are left out when it is above 0.
tierquerylimitqueryinteger1 to 50; 20 by default.
offsetqueryintegerFrom 0; offset + limit is at most 100.
Responses
200Success
agentsarray of objectagents
didstringThe agent's DID: an outside agent's opaque
did:web:zuger.ai:ext:<registrant>:<agent>, or a Zuger agent kind'sdid:web:zuger.ai:agents:<kind>.namestringdescriptionstringThe operator's words; for a Zuger agent, its role.
zugerAgentbooleanOne of Zuger's own agents, labelled "Zuger agent". Ranked by its tier like everyone, with no other boost.
kindstringZuger's own agents only: the agent kind.
tierenumEvery outside agent is Registered until Verified (KYB) exists.
"zuger"·"verified"·"registered"badgeobjectRead at this request.
badge
stateenum"verified"·"attested"·"registered"labelstringThe badge's English words.
detailsstring
skillsarray of stringlanguagesarray of stringregionsarray of stringpriceobject | nullA price per job, as the operator states it.
price
currencystringISO 4217.
minorintegerIn the currency's minor units.
slaobject | nullsla
firstResponseSecondsintegercompletionHoursinteger
reputationobject | nullZuger agents: method v1 where it is on. Outside agents: none yet.
reputation
scoreinteger0 to 1000.
methodUristring (uri)
endpointsobject | nullNull for Zuger's own agents: they work inside a Zuger company.
endpoints
a2aarray of objecta2a
urlstring (uri)protocolBindingenum"JSONRPC"·"GRPC"·"HTTP+JSON"
mcpstring | nullhandshakestring | nullWhere kya-handshake/0.1's HELLO goes.
dealsobject | nulldeals
buyersenumZuger settles a deal only with a Zuger company as the buyer (P8).
"zuger_companies"sellerReadybooleanThe operator can be paid through Stripe Connect from a country deals are open to.
listedAtstring | nullcardHashstring | nullSHA-256 (hex) of the card without its signatures, by RFC 8785.
offsetintegerlimitintegertotalintegerHow many matched, 100 at most.
morebooleanrankingarray of stringThe order: tier, reputation, price (in one currency, never converted), DID.
skillsarray of stringZuger's list of skills.
checkedAtstring (date-time)
- 400A filter out of its range, an unknown skill, or a page past the 100th agent.
- 404With
kya_networkoff, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/net/agentsPOST/v1/net/reportsReport an agent in the directoryPublic
Report an agent in the directory: its did, a reason (illegal, impersonation, fraud, malware, privacy, other), your explanation, goodFaith: true, and a contactEmail only if you want an answer. Kept for Zuger to look at; the same answer for any DID.
AccessPublic: no key and no sign-in.
Operationpost_v1_net_reports
Request bodyrequired
didstringThe agent's DID.
reasonenum"illegal"·"impersonation"·"fraud"·"malware"·"privacy"·"other"explanationstringWhat is wrong, in your words: at most 2,000 characters.
contactEmailstring (email)Only if you want an answer.
goodFaithbooleanYou make the report in good faith and it is accurate: must be true.
Responses
201Success
receivedbooleanidstringAn id.
receivedAtstring (date-time)
- 400No DID, an unknown reason, no explanation or a long one, an address that is not one, or good faith not confirmed.
- 404With
kya_networkoff, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/net/reports \
-H "Content-Type: application/json" \
-d '{"did": "…", "reason": "illegal", "explanation": "…", "goodFaith": true}'GET/v1/net/agents/{did}Read one agent in the directoryPublic
One agent in the directory by its DID, with its A2A agent card as its operator signed it. An agent that is not listed, or no longer shown (its domain proof lapsed, its key changed, it was removed or frozen), is the same 404 as one that never was.
AccessPublic: no key and no sign-in.
Operationget_v1_net_agents_did_
Parameters
didpathstring
Responses
200Success
agentobjectAn agent in the directory.
agent
didstringThe agent's DID: an outside agent's opaque
did:web:zuger.ai:ext:<registrant>:<agent>, or a Zuger agent kind'sdid:web:zuger.ai:agents:<kind>.namestringdescriptionstringThe operator's words; for a Zuger agent, its role.
zugerAgentbooleanOne of Zuger's own agents, labelled "Zuger agent". Ranked by its tier like everyone, with no other boost.
kindstringZuger's own agents only: the agent kind.
tierenumEvery outside agent is Registered until Verified (KYB) exists.
"zuger"·"verified"·"registered"badgeobjectRead at this request.
badge
stateenum"verified"·"attested"·"registered"labelstringThe badge's English words.
detailsstring
skillsarray of stringlanguagesarray of stringregionsarray of stringpriceobject | nullA price per job, as the operator states it.
price
currencystringISO 4217.
minorintegerIn the currency's minor units.
slaobject | nullsla
firstResponseSecondsintegercompletionHoursinteger
reputationobject | nullZuger agents: method v1 where it is on. Outside agents: none yet.
reputation
scoreinteger0 to 1000.
methodUristring (uri)
endpointsobject | nullNull for Zuger's own agents: they work inside a Zuger company.
endpoints
a2aarray of objecta2a
urlstring (uri)protocolBindingenum"JSONRPC"·"GRPC"·"HTTP+JSON"
mcpstring | nullhandshakestring | nullWhere kya-handshake/0.1's HELLO goes.
dealsobject | nulldeals
buyersenumZuger settles a deal only with a Zuger company as the buyer (P8).
"zuger_companies"sellerReadybooleanThe operator can be paid through Stripe Connect from a country deals are open to.
listedAtstring | nullcardHashstring | nullSHA-256 (hex) of the card without its signatures, by RFC 8785.
cardobject | nullThe A2A 1.0 agent card as its operator signed it; null for Zuger's own agents.
checkedAtstring (date-time)
- 400Every failure has this shape.
- 404No agent by that DID is listed, or no longer shown. With
kya_networkoff, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/net/agents/{did}Agent money
Your company's Stripe money capabilities and Stripe Treasury read: your agents read your Stripe balance and Treasury financial accounts, read-only, from Zuger's Stripe sync (money_treasury_read). Your agent money limits, and what your agents prepared to pay, move, convert or add as a payee: agents prepare, a person approves each draft with a passkey, nothing moves on an agent's say-so, never by an API key (money_executor). What Zuger sells to agents (money_seller_mpp): the owner orders a Run top-up or a Zuger Store term, and an agent pays Zuger for it over the Machine Payments Protocol with a shared payment token at the order's own address. Nothing here moves your company's money. Each is switched on one company at a time; where it is not, its paths answer 404.
GET/v1/money/capabilitiesRead your Stripe money capabilitiesconnections:read
Your company's Stripe money capabilities (ADR 0009): each one's state, why it cannot be turned on where it cannot (outside the countries Stripe offers it in, no Stripe connection, a connection to reconnect, a grant that is not Stripe's read-only one), who it is for, and when Stripe's availability pages were read. Read-only: nothing here moves money.
AccessAn API key with the scope connections:read, or a person signed in.
Operationconnections.read
Responses
200Success
readAtstringThe day Stripe's availability pages were read,
YYYY-MM-DD.stripeConnectedbooleanWhether the company has a Stripe connection.
lastTreasuryReadenumHow the last Treasury read went.
"read"·"country"·"no_country"·"refused"·"failed"·nullcapabilitiesarray of objectcapabilities
idenumThe capability.
"treasury_read"availablebooleanWhether it can be turned on now.
onbooleanWhether it is on: your agents read it from the next Stripe sync.
reasonenumWhy it cannot be turned on: outside the countries Stripe offers it in, no Stripe connection, a connection to reconnect, or a grant that is not Stripe's read-only one.
"country"·"not_connected"·"reconnect"·"grant"·nullforWhomstringWho it is for, as Stripe offers it ("US businesses").
countrystring | nullThe country Zuger judged by: your Stripe account's, else your company's own; null when neither is known.
countryFromStripebooleanWhether Stripe reported that country; until it has, the sync checks it before reading anything.
doesstringWhat it lets your agents do.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
connections:readscope. - 404With
money_treasury_readoff for the company, both paths answer 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/money/capabilities \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/money/draftsList what your agents preparedPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
What your agents prepared to pay, move, convert or add as a payee, and where each stands: blocked by Bernina (with her codes), waiting for approval, approved, carried out, failed or expired. A draft is approved in Approvals with a passkey, like every money approval.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Responses
200Success
draftsarray of objectdrafts
idstringAn id.
agentIdstringAn id.
approvalIdstring | nullIts MONEY_OUT approval; null when Bernina blocked it before it was shown.
kindenum"send_money"·"transfer_money"·"convert_currency"·"setup_recipient"·"spend_request"amountMinorintegerIn minor units; 0 for adding a payee.
currencystringtoCurrencystring | nullA conversion's currency bought.
counterpartystringWho is paid, as your agent named them.
stateenum"BLOCKED"·"PENDING_APPROVAL"·"APPROVED"·"REJECTED"·"EXPIRED"·"EXECUTING"·"SUCCEEDED"·"FAILED"blockCodesarray of stringproviderApprovalobject | nullStripe's own approval, where Stripe asked for one: the second step on the same card (PR 4). Zuger never answers it.
providerApproval
statusenum"requires_review"·"approved"·"unknown"·"succeeded"·"rejected"·"expired"·"canceled"·"failed"urlstring | nullStripe's own address for it (dashboard.stripe.com).
expiresAtstring | null
createdAtstring (date-time)updatedAtstring (date-time)
providerbooleanWhether this deployment can carry out an approved draft at all (false in this build: nothing moves).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not a person signed in in this company (a key, a connected app or an agent never can).
- 404With
money_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/money/exportExport the agent money record as CSVPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
The agent money record of a period as CSV (from, to: whole UTC days, both included, at most 366 days; the last 90 days by default): one row a step from the audit trail, with the Run, the agent and its KYA identity, the amount, the counterparty, the cited records, the approver and the method, and the step's Agent Chain root and link. Returned as { filename, csv }. The owner or an admin.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Parameters
fromquerystringThe first day, UTC (default: 89 days before
to).toquerystringThe last day, UTC, included (default: today).
Responses
200Success
filenamestringmimestringtext/csv.
rowsintegerfromstring (date)tostring (date)csvstringRFC 4180 CSV, UTF-8 with a byte-order mark; a cell a spreadsheet would read as a formula is neutralised.
- 400Not whole days,
fromafterto, more than 366 days, or more steps than one export holds. - 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner or an admin, or a key, a connected app or an agent.
- 404With
money_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/money/limitsRead your agent money limitsPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Your agent money limits: per currency, for the whole company and for any one agent, a day (24 hours) and 30 days, in minor units. Checked before any provider's own limits. Your own people, signed in; never a key.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Responses
200Success
limitsarray of objectlimits
agentIdstring | nullAn id.
currencystringdailyMinorintegerthirtyDayMinorintegerupdatedAtstring (date-time)
agentsarray of objectagents
idstringAn id.
kindstringThe agent's kind.
namestring
canChangebooleanWhether you may change them (the owner).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not a person signed in in this company (a key, a connected app or an agent never can).
- 404With
money_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
PUT/v1/money/limitsSet the agent money limitsPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Set the agent money limits, whole (a limit left out is removed), with the owner's passkey assertion made for exactly them. A currency with no company limit is refused to every agent, never open.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Request bodyrequired
limitsarray of objectlimits
agentIdstring | nullThe agent this limit is for; null for the whole company.
currencystringISO 4217, three capital letters.
dailyMinorintegerThe most in a day (24 hours), in minor units.
thirtyDayMinorintegerThe most in 30 days, in minor units; at least the daily limit.
assertionobjectThe passkey assertion bound to exactly these limits.
assertion
credentialIdstringThe passkey's credential id.
challengestringThe
tokenfrom the signature call.responseobjectThe browser's WebAuthn assertion response.
Responses
200Success
limitsarray of objectlimits
agentIdstring | nullAn id.
currencystringdailyMinorintegerthirtyDayMinorintegerupdatedAtstring (date-time)
agentsarray of objectagents
idstringAn id.
kindstringThe agent's kind.
namestring
canChangebooleanWhether you may change them (the owner).
- 400A limit that is not a whole number of minor units from zero up, a 30-day limit below the daily one, a currency that is not three capital letters, or the same agent and currency twice.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner, or a key, a connected app or an agent.
- 404An agent that is not this company's. With
money_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/money/link-spendRead agent purchases through LinkPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Agent purchases through Link: whether they can be had (US and Canada customers; shown with the reason where not), whether they are on, the thresholds above which your passkey is needed as well as your approval in Link, Link's payment consent, and each purchase your agents prepared with where it stands. Your own people, signed in; never a key.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Responses
200Success
readAtstringThe day Stripe's availability pages were read.
capabilityobjectcapability
idenum"link_spend"availablebooleanreadybooleanreasonenum"country"·"not_set_up"·"executor_off"·"link_not_connected"·"not_enabled"·"no_consent"·"consent_ended"·nullforWhomstringcountrystring | null
settingsobjectsettings
enabledbooleanthresholdsmap of integerYour thresholds per currency, minor units.
defaultsmap of integerThe defaults: 100 EUR and 100 USD.
consentobject | nullconsent
statusenum"ACTIVE"·"DISCONNECTED"·"REVOKED"scopesarray of stringconnectedAtstring | nullendedAtstring | nullendedReasonstring | null
executorbooleanWhether this deployment can carry out a purchase at all (false in this build: nothing reaches Link).
purchasesarray of objectpurchases
idstringThe purchase; also the idempotency key of its Link spend request.
agentIdstringAn id.
parentIdstring | nullThe purchase this one replaces, where Link asked for a new request.
purposeenum"mpp_data"·"infra_topup"·"formation_fee"·"zuger_store"sellerstringWho sells it, as your agent named them.
amountMinorintegerIn minor units: what Link was asked for, else what the agent proposed.
currencystringstateenum"BLOCKED"·"VERIFY_FIRST"·"PASSKEY_PENDING"·"REJECTED"·"READY"·"AT_LINK"·"AFTER_ACTION"·"SUCCEEDED"·"FAILED"·"DENIED"·"EXPIRED"·"CANCELED"·"REPLACED"linkStatusenum"created"·"pending_approval"·"requires_action"·"approved"·"submitted"·"succeeded"·"failed"·"denied"·"expired"·"canceled"·nullpasskeybooleanWhether your passkey was needed as well (above the threshold, P67).
thresholdMinorinteger | nullThe threshold it was measured against; null: a currency with no threshold, so always a passkey.
approvalIdstring | nullIts MONEY_OUT approval, above the threshold.
approveInLinkstring | nullLink's own approval address while Link waits for you ("Approve in Link").
approvalExpiresAtstring | nullLink's 30-minute approval window ends.
nextActionobject | nullnextAction
typestringresolutionenum"auto_resume"·"create_new_spend_request"·"create_new_spend_request_after_completion"urlstring | nullmessagestring | nullLink's own words, shown as Link wrote them.
verifyobject | nullverify
statusstringLink's verification requirement.
urlstring | null
blockCodesarray of stringcodestring | nullWhy it ended, as a code.
createdAtstring (date-time)updatedAtstring (date-time)
canChangebooleancanRaisebooleanWhether you may turn them on or raise a threshold (the owner).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not a person signed in in this company (a key, a connected app or an agent never can).
- 404With
money_link_spendormoney_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/money/overviewYour agent money on one pagePerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Your agent money on one page: every payment, transfer, conversion, payee and Link purchase your agents prepared, grouped as waiting, approved, carried out and ended (failed, blocked, declined, expired, cancelled), with who approved each and how (a passkey; then Stripe or Link where they asked), Bernina's codes and the Agent Chain link of the decision; and each money limit with what is used of it now. Your own people, signed in; never a key.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Responses
200Success
recordsarray of objectrecords
idstringThe draft's or the purchase's id.
typeenum"treasury"·"link"kindenum"send_money"·"transfer_money"·"convert_currency"·"setup_recipient"·"spend_request"groupenumWaiting for a person; approved and on its way; carried out; ended without moving money.
"waiting"·"approved"·"done"·"failed"statestringThe draft's or purchase's own state.
agentobject | nullagent
idstringAn id.
kindstringnamestring
amountMinorintegerIn minor units.
currencystringtoCurrencystring | nullA conversion's currency bought.
counterpartystringWho is paid, or who sells, as your agent named them.
approvalIdstring | nullThe MONEY_OUT approval in your inbox, where there is one.
approvalobject | nullapproval
bystring | nullThe person's name; null for an approval in Link.
methodenum"passkey"·"passkey_stripe"·"passkey_link"·"link"atstring | null
approveInLinkstring | nullLink's own approval page (https on link.com), while Link waits for you.
providerApprovalobject | nullStripe's own approval, where Stripe asked for one.
providerApproval
statusstringurlstring | nulldashboard.stripe.com only.
expiresAtstring | null
codesarray of stringrunIdstring | nullAn id.
createdAtstring (date-time)updatedAtstring (date-time)chainobject | nullThe step's link in the Zuger Agent Chain, where the chain holds one (a person's passkey decision and the final outcome).
chain
rootstringThe chain's root hash.
linkstringThis link's hash.
purchasesbooleanWhether Link purchases are on for the company (and listed here).
providerbooleanWhether this deployment can carry out an approved draft at all (false in this build).
canExportbooleanWhether you may export (the owner or an admin).
limitsarray of objectlimits
agentIdstring | nullAn id.
agentNamestring | nullcurrencystringdailyMinorintegerthirtyDayMinorintegerusedDayMinorintegerUsed in the last 24 hours.
usedThirtyMinorintegerUsed in the last 30 days.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not a person signed in in this company (a key, a connected app or an agent never can).
- 404With
money_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/money/treasury-keyWhether your Stripe key for agent money is givenPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Whether your Stripe key for agent money is given, and when (never the key: Zuger's servers cannot read it), with the public key the Console seals one to in your browser. Your own people, signed in; never a key.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Responses
200Success
setbooleanWhether a key is given.
setAtstring | nullkeyIdstring | nullAn id.
publicKeystring | nullzuger-money's public key, base64, to seal a key to; null when it is not set up.
bindingstringWhat the envelope is bound to (the company and Stripe Treasury).
canGivebooleanWhether you may give or replace the key (the owner, with zuger-money set up).
canRemovebooleanWhether you may remove it (the owner or an admin).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not a person signed in in this company (a key, a connected app or an agent never can).
- 404With
money_executorormoney_treasury_writeoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
PUT/v1/money/treasury-keyGive or replace the Stripe key, sealed in the browserPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Give or replace the Stripe Agent-tagged restricted key your approved agent payments are carried out with, sealed in your browser (envelope), with the owner's passkey assertion made for exactly it. Only zuger-money can open it.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Request bodyrequired
envelopeobjectThe key, sealed in the browser to zuger-money's public key (ECDH P-256, HKDF-SHA-256, AES-256-GCM). Anything shaped like a key is refused: Zuger's servers never read one.
envelope
vstringAlways zmk1.
epkstringThe browser's one-time P-256 public key, base64.
ivstringThe 12-byte nonce, base64.
ctstringAES-256-GCM ciphertext and tag, base64.
assertionobjectThe passkey assertion bound to exactly these limits.
assertion
credentialIdstringThe passkey's credential id.
challengestringThe
tokenfrom the signature call.responseobjectThe browser's WebAuthn assertion response.
Responses
200Success
setbooleanWhether a key is given.
setAtstring | nullkeyIdstring | nullAn id.
publicKeystring | nullzuger-money's public key, base64, to seal a key to; null when it is not set up.
bindingstringWhat the envelope is bound to (the company and Stripe Treasury).
canGivebooleanWhether you may give or replace the key (the owner, with zuger-money set up).
canRemovebooleanWhether you may remove it (the owner or an admin).
- 400Not a sealed envelope (a key sent as it is is refused), or zuger-money is not set up.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner (to give one) or an owner or admin (to remove one), or a key, a connected app or an agent.
- 404No key to remove. With
money_executorormoney_treasury_writeoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/money/treasury-readTurn Stripe Treasury read on or offPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Turn Stripe Treasury read on (on: true) or off (on: false): your agents read your Stripe balance and Treasury financial accounts from Zuger's next Stripe sync, read-only. Owner or admin, signed in.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Request bodyrequired
onbooleantrue to turn it on (only where it is available), false to turn it off (always allowed).
Responses
200Success
readAtstringThe day Stripe's availability pages were read,
YYYY-MM-DD.stripeConnectedbooleanWhether the company has a Stripe connection.
lastTreasuryReadenumHow the last Treasury read went.
"read"·"country"·"no_country"·"refused"·"failed"·nullcapabilitiesarray of objectcapabilities
idenumThe capability.
"treasury_read"availablebooleanWhether it can be turned on now.
onbooleanWhether it is on: your agents read it from the next Stripe sync.
reasonenumWhy it cannot be turned on: outside the countries Stripe offers it in, no Stripe connection, a connection to reconnect, or a grant that is not Stripe's read-only one.
"country"·"not_connected"·"reconnect"·"grant"·nullforWhomstringWho it is for, as Stripe offers it ("US businesses").
countrystring | nullThe country Zuger judged by: your Stripe account's, else your company's own; null when neither is known.
countryFromStripebooleanWhether Stripe reported that country; until it has, the sync checks it before reading anything.
doesstringWhat it lets your agents do.
- 400Not
on: trueoron: false, or not available (the reason is said). - 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Not the company's owner or an admin, signed in.
- 404With
money_treasury_readoff for the company, both paths answer 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/money/limits/signatureStart changing the limits with a passkeyPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Start changing the agent money limits: a passkey challenge bound to exactly the limits sent. The owner only.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Request bodyrequired
limitsarray of objectlimits
agentIdstring | nullThe agent this limit is for; null for the whole company.
currencystringISO 4217, three capital letters.
dailyMinorintegerThe most in a day (24 hours), in minor units.
thirtyDayMinorintegerThe most in 30 days, in minor units; at least the daily limit.
Responses
200Success
optionsobjectWebAuthn request options for
navigator.credentials.get, bound to exactly these limits.tokenstringThe challenge token, sent back as
assertion.challenge. Good for two minutes, once.
- 400A limit that is not a whole number of minor units from zero up, a 30-day limit below the daily one, a currency that is not three capital letters, or the same agent and currency twice.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner, or a key, a connected app or an agent.
- 404An agent that is not this company's. With
money_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/money/link-spend/callbackFinish Link's consent for agent paymentsPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Finish Link's consent for agent payments with the code and state Link sent back, within ten minutes, by the person who started it. Only Zuger's money executor keeps the token.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Request bodyrequired
codestringFrom Link.
statestringFrom Link.
Responses
200Success
readAtstringThe day Stripe's availability pages were read.
capabilityobjectcapability
idenum"link_spend"availablebooleanreadybooleanreasonenum"country"·"not_set_up"·"executor_off"·"link_not_connected"·"not_enabled"·"no_consent"·"consent_ended"·nullforWhomstringcountrystring | null
settingsobjectsettings
enabledbooleanthresholdsmap of integerYour thresholds per currency, minor units.
defaultsmap of integerThe defaults: 100 EUR and 100 USD.
consentobject | nullconsent
statusenum"ACTIVE"·"DISCONNECTED"·"REVOKED"scopesarray of stringconnectedAtstring | nullendedAtstring | nullendedReasonstring | null
executorbooleanWhether this deployment can carry out a purchase at all (false in this build: nothing reaches Link).
purchasesarray of objectpurchases
idstringThe purchase; also the idempotency key of its Link spend request.
agentIdstringAn id.
parentIdstring | nullThe purchase this one replaces, where Link asked for a new request.
purposeenum"mpp_data"·"infra_topup"·"formation_fee"·"zuger_store"sellerstringWho sells it, as your agent named them.
amountMinorintegerIn minor units: what Link was asked for, else what the agent proposed.
currencystringstateenum"BLOCKED"·"VERIFY_FIRST"·"PASSKEY_PENDING"·"REJECTED"·"READY"·"AT_LINK"·"AFTER_ACTION"·"SUCCEEDED"·"FAILED"·"DENIED"·"EXPIRED"·"CANCELED"·"REPLACED"linkStatusenum"created"·"pending_approval"·"requires_action"·"approved"·"submitted"·"succeeded"·"failed"·"denied"·"expired"·"canceled"·nullpasskeybooleanWhether your passkey was needed as well (above the threshold, P67).
thresholdMinorinteger | nullThe threshold it was measured against; null: a currency with no threshold, so always a passkey.
approvalIdstring | nullIts MONEY_OUT approval, above the threshold.
approveInLinkstring | nullLink's own approval address while Link waits for you ("Approve in Link").
approvalExpiresAtstring | nullLink's 30-minute approval window ends.
nextActionobject | nullnextAction
typestringresolutionenum"auto_resume"·"create_new_spend_request"·"create_new_spend_request_after_completion"urlstring | nullmessagestring | nullLink's own words, shown as Link wrote them.
verifyobject | nullverify
statusstringLink's verification requirement.
urlstring | null
blockCodesarray of stringcodestring | nullWhy it ended, as a code.
createdAtstring (date-time)updatedAtstring (date-time)
canChangebooleancanRaisebooleanWhether you may turn them on or raise a threshold (the owner).
- 400Expired or not Zuger's attempt, or no money executor on this deployment (nothing kept).
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner or an admin, or an admin raising what only the owner may, or a key, a connected app or an agent.
- 404With
money_link_spendormoney_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/money/link-spend/consentStart Link's consent for agent paymentsPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Start Link's separate consent for agent payments (payment_methods.agentic) at login.link.com, once agent purchases are on. Owner or admin, signed in.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Responses
200Success
urlstring (uri)login.link.com's consent address.
- 400A threshold that is not a whole number of minor units from zero up per three-letter currency; agent purchases not available for this company (with the reason); Link not connected first.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner or an admin, or an admin raising what only the owner may, or a key, a connected app or an agent.
- 404With
money_link_spendormoney_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/money/link-spend/disconnectEnd Link's consent for agent paymentsPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
End Link's consent for agent payments: revoked at Link and Zuger's copy deleted. Owner or admin, signed in.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Responses
200Success
readAtstringThe day Stripe's availability pages were read.
capabilityobjectcapability
idenum"link_spend"availablebooleanreadybooleanreasonenum"country"·"not_set_up"·"executor_off"·"link_not_connected"·"not_enabled"·"no_consent"·"consent_ended"·nullforWhomstringcountrystring | null
settingsobjectsettings
enabledbooleanthresholdsmap of integerYour thresholds per currency, minor units.
defaultsmap of integerThe defaults: 100 EUR and 100 USD.
consentobject | nullconsent
statusenum"ACTIVE"·"DISCONNECTED"·"REVOKED"scopesarray of stringconnectedAtstring | nullendedAtstring | nullendedReasonstring | null
executorbooleanWhether this deployment can carry out a purchase at all (false in this build: nothing reaches Link).
purchasesarray of objectpurchases
idstringThe purchase; also the idempotency key of its Link spend request.
agentIdstringAn id.
parentIdstring | nullThe purchase this one replaces, where Link asked for a new request.
purposeenum"mpp_data"·"infra_topup"·"formation_fee"·"zuger_store"sellerstringWho sells it, as your agent named them.
amountMinorintegerIn minor units: what Link was asked for, else what the agent proposed.
currencystringstateenum"BLOCKED"·"VERIFY_FIRST"·"PASSKEY_PENDING"·"REJECTED"·"READY"·"AT_LINK"·"AFTER_ACTION"·"SUCCEEDED"·"FAILED"·"DENIED"·"EXPIRED"·"CANCELED"·"REPLACED"linkStatusenum"created"·"pending_approval"·"requires_action"·"approved"·"submitted"·"succeeded"·"failed"·"denied"·"expired"·"canceled"·nullpasskeybooleanWhether your passkey was needed as well (above the threshold, P67).
thresholdMinorinteger | nullThe threshold it was measured against; null: a currency with no threshold, so always a passkey.
approvalIdstring | nullIts MONEY_OUT approval, above the threshold.
approveInLinkstring | nullLink's own approval address while Link waits for you ("Approve in Link").
approvalExpiresAtstring | nullLink's 30-minute approval window ends.
nextActionobject | nullnextAction
typestringresolutionenum"auto_resume"·"create_new_spend_request"·"create_new_spend_request_after_completion"urlstring | nullmessagestring | nullLink's own words, shown as Link wrote them.
verifyobject | nullverify
statusstringLink's verification requirement.
urlstring | null
blockCodesarray of stringcodestring | nullWhy it ended, as a code.
createdAtstring (date-time)updatedAtstring (date-time)
canChangebooleancanRaisebooleanWhether you may turn them on or raise a threshold (the owner).
- 400A threshold that is not a whole number of minor units from zero up per three-letter currency; agent purchases not available for this company (with the reason); Link not connected first.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner or an admin, or an admin raising what only the owner may, or a key, a connected app or an agent.
- 404With
money_link_spendormoney_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
PUT/v1/money/link-spend/settingsTurn agent purchases on or off and set thresholdsPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Set agent purchases on or off and their thresholds, with the passkey assertion made for exactly them.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Request bodyrequired
enabledbooleanOn or off.
thresholdsmap of integerPer currency, minor units: above it your passkey as well as Link's approval.
assertionobjectThe passkey assertion bound to exactly these settings.
assertion
credentialIdstringchallengestringresponseobjectThe browser's WebAuthn assertion response.
Responses
200Success
readAtstringThe day Stripe's availability pages were read.
capabilityobjectcapability
idenum"link_spend"availablebooleanreadybooleanreasonenum"country"·"not_set_up"·"executor_off"·"link_not_connected"·"not_enabled"·"no_consent"·"consent_ended"·nullforWhomstringcountrystring | null
settingsobjectsettings
enabledbooleanthresholdsmap of integerYour thresholds per currency, minor units.
defaultsmap of integerThe defaults: 100 EUR and 100 USD.
consentobject | nullconsent
statusenum"ACTIVE"·"DISCONNECTED"·"REVOKED"scopesarray of stringconnectedAtstring | nullendedAtstring | nullendedReasonstring | null
executorbooleanWhether this deployment can carry out a purchase at all (false in this build: nothing reaches Link).
purchasesarray of objectpurchases
idstringThe purchase; also the idempotency key of its Link spend request.
agentIdstringAn id.
parentIdstring | nullThe purchase this one replaces, where Link asked for a new request.
purposeenum"mpp_data"·"infra_topup"·"formation_fee"·"zuger_store"sellerstringWho sells it, as your agent named them.
amountMinorintegerIn minor units: what Link was asked for, else what the agent proposed.
currencystringstateenum"BLOCKED"·"VERIFY_FIRST"·"PASSKEY_PENDING"·"REJECTED"·"READY"·"AT_LINK"·"AFTER_ACTION"·"SUCCEEDED"·"FAILED"·"DENIED"·"EXPIRED"·"CANCELED"·"REPLACED"linkStatusenum"created"·"pending_approval"·"requires_action"·"approved"·"submitted"·"succeeded"·"failed"·"denied"·"expired"·"canceled"·nullpasskeybooleanWhether your passkey was needed as well (above the threshold, P67).
thresholdMinorinteger | nullThe threshold it was measured against; null: a currency with no threshold, so always a passkey.
approvalIdstring | nullIts MONEY_OUT approval, above the threshold.
approveInLinkstring | nullLink's own approval address while Link waits for you ("Approve in Link").
approvalExpiresAtstring | nullLink's 30-minute approval window ends.
nextActionobject | nullnextAction
typestringresolutionenum"auto_resume"·"create_new_spend_request"·"create_new_spend_request_after_completion"urlstring | nullmessagestring | nullLink's own words, shown as Link wrote them.
verifyobject | nullverify
statusstringLink's verification requirement.
urlstring | null
blockCodesarray of stringcodestring | nullWhy it ended, as a code.
createdAtstring (date-time)updatedAtstring (date-time)
canChangebooleancanRaisebooleanWhether you may turn them on or raise a threshold (the owner).
- 400A threshold that is not a whole number of minor units from zero up per three-letter currency; agent purchases not available for this company (with the reason); Link not connected first.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner or an admin, or an admin raising what only the owner may, or a key, a connected app or an agent.
- 404With
money_link_spendormoney_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/money/records/{id}One agent money record with its stepsPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
One agent money record, by its id or its approval's: its terms, the records it cites, why the agent prepared it, and each step from the audit trail (the draft, Bernina's two looks, the decision, Stripe's or Link's step, each attempt, the outcome) with its Agent Chain link where there is one.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Parameters
idpathstring
Responses
200Success
recordobjectrecord
idstringThe draft's or the purchase's id.
typeenum"treasury"·"link"kindenum"send_money"·"transfer_money"·"convert_currency"·"setup_recipient"·"spend_request"groupenumWaiting for a person; approved and on its way; carried out; ended without moving money.
"waiting"·"approved"·"done"·"failed"statestringThe draft's or purchase's own state.
agentobject | nullagent
idstringAn id.
kindstringnamestring
amountMinorintegerIn minor units.
currencystringtoCurrencystring | nullA conversion's currency bought.
counterpartystringWho is paid, or who sells, as your agent named them.
approvalIdstring | nullThe MONEY_OUT approval in your inbox, where there is one.
approvalobject | nullapproval
bystring | nullThe person's name; null for an approval in Link.
methodenum"passkey"·"passkey_stripe"·"passkey_link"·"link"atstring | null
approveInLinkstring | nullLink's own approval page (https on link.com), while Link waits for you.
providerApprovalobject | nullStripe's own approval, where Stripe asked for one.
providerApproval
statusstringurlstring | nulldashboard.stripe.com only.
expiresAtstring | null
codesarray of stringrunIdstring | nullAn id.
createdAtstring (date-time)updatedAtstring (date-time)chainobject | nullThe step's link in the Zuger Agent Chain, where the chain holds one (a person's passkey decision and the final outcome).
chain
rootstringThe chain's root hash.
linkstringThis link's hash.
artefactsarray of objectThe records it cites (pointers).
artefacts
kindstringidstringAn id.
reasonstring | nullWhy the agent prepared it.
kyaAgentIdstring | nullThe agent's KYA identity.
stepsarray of objectsteps
stepstringatstring (date-time)actorenum"person"·"agent"·"system"bystring | nulloutcomestring | nullcodesarray of stringchainobject | nullThe step's link in the Zuger Agent Chain, where the chain holds one (a person's passkey decision and the final outcome).
chain
rootstringThe chain's root hash.
linkstringThis link's hash.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not a person signed in in this company (a key, a connected app or an agent never can).
- 404No record by that id in this company. With
money_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/money/seller/ordersRead what this company ordered to be paid by an agentPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
What this company ordered to be paid by an agent over the Machine Payments Protocol: Run top-ups and Zuger Store terms, each with its price (net, VAT, total), where it stands, the buyer agent's identity as verified, and the address it is paid at. Your own people, signed in; never a key.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Responses
200Success
ordersarray of objectorders
idstringThe order (
mpo_…, 192 random bits): its address is the capability to pay it.kindenum"RUNS_TOPUP"·"STORE_LISTING"runsinteger | null50 or 200, for a top-up.
listingIdstring | nullThe Zuger Store listing by Zuger, for a term.
descriptionstringZuger's own words about the item.
netMinorintegerThe published price, minor units.
vatMinorintegerThe VAT your billing details decide.
totalMinorintegerWhat the agent pays.
currencystringstatusenum"OPEN"·"PAYING"·"PAID"·"FULFILLED"·"REFUNDING"·"REFUNDED"·"EXPIRED"·"CANCELLED"expiresAtstring (date-time)An unpaid order lapses then.
paidAtstring | nullfulfilledAtstring | nullservesUntilstring | nullA Store term ends then, by itself.
buyerobjectbuyer
kindenum"NONE"·"ZUGER_KYA"verifiedbooleanWhether the buyer agent's Zuger credential verified (KYA).
codestring | nullThe verifier's code.
subjectstring | nullThe agent's opaque DID, when it verified.
payAddressstring (uri)Where an agent pays it: an HTTP 402 challenge, then the shared payment token.
createdByTypeenum"USER"·"AGENT"createdAtstring (date-time)
unverifiedLimitobjectWhat an agent whose identity Zuger could not verify may pay, per currency.
unverifiedLimit
perPurchaseMinormap of integerperDayMinormap of integer
readybooleanWhether Zuger can take agent payments on this deployment (false in this build).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not a person signed in in this company (a key, a connected app or an agent never can), or not the owner for an order.
- 404With
money_seller_mppoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/money/seller/ordersOrder a Run top-up or a Zuger Store term to be paid by an agentPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Order a Run top-up (kind: runs_topup, runs 50 or 200) or one 30-day term of a Zuger Store listing by Zuger (kind: store_listing, listingId) to be paid by an agent with a shared payment token. The published price plus the VAT your billing details decide; never a plan. The owner, signed in.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Request bodyrequired
kindenum"runs_topup"·"store_listing"runsinteger50 or 200, for a top-up.
listingIdstringA priced agent or skill listing by Zuger, for a 30-day term.
Responses
200Success
orderobjectOne order Zuger sells over MPP.
order
idstringThe order (
mpo_…, 192 random bits): its address is the capability to pay it.kindenum"RUNS_TOPUP"·"STORE_LISTING"runsinteger | null50 or 200, for a top-up.
listingIdstring | nullThe Zuger Store listing by Zuger, for a term.
descriptionstringZuger's own words about the item.
netMinorintegerThe published price, minor units.
vatMinorintegerThe VAT your billing details decide.
totalMinorintegerWhat the agent pays.
currencystringstatusenum"OPEN"·"PAYING"·"PAID"·"FULFILLED"·"REFUNDING"·"REFUNDED"·"EXPIRED"·"CANCELLED"expiresAtstring (date-time)An unpaid order lapses then.
paidAtstring | nullfulfilledAtstring | nullservesUntilstring | nullA Store term ends then, by itself.
buyerobjectbuyer
kindenum"NONE"·"ZUGER_KYA"verifiedbooleanWhether the buyer agent's Zuger credential verified (KYA).
codestring | nullThe verifier's code.
subjectstring | nullThe agent's opaque DID, when it verified.
payAddressstring (uri)Where an agent pays it: an HTTP 402 challenge, then the shared payment token.
createdByTypeenum"USER"·"AGENT"createdAtstring (date-time)
- 400Not a top-up of 50 or 200 Runs or a listing by Zuger; the Free plan; hired already; no billing country (the VAT cannot be decided) or nothing at Stripe yet; below the smallest agent payment; too many orders waiting.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not a person signed in in this company (a key, a connected app or an agent never can), or not the owner for an order.
- 404With
money_seller_mppoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/money/treasury-key/removeRemove the Stripe keyPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Remove the Stripe key, with a passkey assertion made for removing it (the owner or an admin). Nothing can be carried out until a new one is given; revoke the key in Stripe too.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Request bodyrequired
assertionobjectThe passkey assertion bound to exactly these limits.
assertion
credentialIdstringThe passkey's credential id.
challengestringThe
tokenfrom the signature call.responseobjectThe browser's WebAuthn assertion response.
Responses
200Success
setbooleanWhether a key is given.
setAtstring | nullkeyIdstring | nullAn id.
publicKeystring | nullzuger-money's public key, base64, to seal a key to; null when it is not set up.
bindingstringWhat the envelope is bound to (the company and Stripe Treasury).
canGivebooleanWhether you may give or replace the key (the owner, with zuger-money set up).
canRemovebooleanWhether you may remove it (the owner or an admin).
- 400Not a sealed envelope (a key sent as it is is refused), or zuger-money is not set up.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner (to give one) or an owner or admin (to remove one), or a key, a connected app or an agent.
- 404No key to remove. With
money_executorormoney_treasury_writeoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/money/treasury-key/signatureStart giving, or removing, the Stripe key with a passkeyPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Start giving the Stripe key: a passkey challenge bound to exactly the sealed envelope sent (the owner only), or, with remove: true, to removing the key (the owner or an admin). A key sent as it is is refused.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Request body
envelopeobjectThe key, sealed in the browser to zuger-money's public key (ECDH P-256, HKDF-SHA-256, AES-256-GCM). Anything shaped like a key is refused: Zuger's servers never read one.
envelope
vstringAlways zmk1.
epkstringThe browser's one-time P-256 public key, base64.
ivstringThe 12-byte nonce, base64.
ctstringAES-256-GCM ciphertext and tag, base64.
removebooleanTrue to remove the key instead.
Responses
200Success
optionsobjectWebAuthn request options for
navigator.credentials.get, bound to exactly these limits.tokenstringThe challenge token, sent back as
assertion.challenge. Good for two minutes, once.
- 400Not a sealed envelope (a key sent as it is is refused), or zuger-money is not set up.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner (to give one) or an owner or admin (to remove one), or a key, a connected app or an agent.
- 404No key to remove. With
money_executorormoney_treasury_writeoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
GET/v1/mpp/orders/{id}Pay an order over the Machine Payments ProtocolPublic
Pay a Zuger order with a shared payment token over the Machine Payments Protocol (HTTP 402, method="stripe").
AccessPublic: no key and no sign-in.
Operationget_v1_mpp_orders_id_
Parameters
idpathstring
Responses
- 400Every failure has this shape.
- 402Payment required, or the credential refused (problem details under https://paymentauth.org/problems/).
- 403An agent whose identity Zuger could not verify, above the configured limit.
- 404With
money_seller_mppoff for the company, every one of these paths answers 404, as an unknown path does. - 409Paid or being paid with another credential; or what it bought could not be given and the payment was refunded.
- 410The order lapsed or ended.
- 429Every failure has this shape.
- 503Zuger cannot take agent payments yet, or Stripe did not answer (send the same credential again).
curl https://beta.zuger.ai/v1/mpp/orders/{id}POST/v1/mpp/orders/{id}Pay an order over the Machine Payments Protocol (POST)Public
Pay a Zuger order with a shared payment token over the Machine Payments Protocol (HTTP 402, method="stripe").
AccessPublic: no key and no sign-in.
Operationpost_v1_mpp_orders_id_
Parameters
idpathstring
Responses
- 400Every failure has this shape.
- 402As GET.
- 403As GET.
- 404With
money_seller_mppoff for the company, every one of these paths answers 404, as an unknown path does. - 409As GET.
- 410As GET.
- 429Every failure has this shape.
- 503As GET.
curl -X POST https://beta.zuger.ai/v1/mpp/orders/{id}POST/v1/money/link-spend/settings/signatureStart changing agent purchases with a passkeyPerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Start changing agent purchases (enabled, thresholds per currency in minor units): a passkey challenge bound to exactly them. The owner turns them on and raises a threshold; an admin may only turn them off or lower one.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Request bodyrequired
enabledbooleanOn or off.
thresholdsmap of integerPer currency, minor units: above it your passkey as well as Link's approval.
Responses
200Success
optionsobjectWebAuthn request options, bound to exactly these settings.
tokenstringSent back as
assertion.challenge. Two minutes, once.
- 400A threshold that is not a whole number of minor units from zero up per three-letter currency; agent purchases not available for this company (with the reason); Link not connected first.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner or an admin, or an admin raising what only the owner may, or a key, a connected app or an agent.
- 404With
money_link_spendormoney_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/money/link-spend/purchases/{id}/cancelCancel an unpaid agent purchasePerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Cancel an agent purchase that was not paid (at Link too, while Link allows it). Owner or admin, signed in.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Parameters
idpathstring
Responses
200Success
readAtstringThe day Stripe's availability pages were read.
capabilityobjectcapability
idenum"link_spend"availablebooleanreadybooleanreasonenum"country"·"not_set_up"·"executor_off"·"link_not_connected"·"not_enabled"·"no_consent"·"consent_ended"·nullforWhomstringcountrystring | null
settingsobjectsettings
enabledbooleanthresholdsmap of integerYour thresholds per currency, minor units.
defaultsmap of integerThe defaults: 100 EUR and 100 USD.
consentobject | nullconsent
statusenum"ACTIVE"·"DISCONNECTED"·"REVOKED"scopesarray of stringconnectedAtstring | nullendedAtstring | nullendedReasonstring | null
executorbooleanWhether this deployment can carry out a purchase at all (false in this build: nothing reaches Link).
purchasesarray of objectpurchases
idstringThe purchase; also the idempotency key of its Link spend request.
agentIdstringAn id.
parentIdstring | nullThe purchase this one replaces, where Link asked for a new request.
purposeenum"mpp_data"·"infra_topup"·"formation_fee"·"zuger_store"sellerstringWho sells it, as your agent named them.
amountMinorintegerIn minor units: what Link was asked for, else what the agent proposed.
currencystringstateenum"BLOCKED"·"VERIFY_FIRST"·"PASSKEY_PENDING"·"REJECTED"·"READY"·"AT_LINK"·"AFTER_ACTION"·"SUCCEEDED"·"FAILED"·"DENIED"·"EXPIRED"·"CANCELED"·"REPLACED"linkStatusenum"created"·"pending_approval"·"requires_action"·"approved"·"submitted"·"succeeded"·"failed"·"denied"·"expired"·"canceled"·nullpasskeybooleanWhether your passkey was needed as well (above the threshold, P67).
thresholdMinorinteger | nullThe threshold it was measured against; null: a currency with no threshold, so always a passkey.
approvalIdstring | nullIts MONEY_OUT approval, above the threshold.
approveInLinkstring | nullLink's own approval address while Link waits for you ("Approve in Link").
approvalExpiresAtstring | nullLink's 30-minute approval window ends.
nextActionobject | nullnextAction
typestringresolutionenum"auto_resume"·"create_new_spend_request"·"create_new_spend_request_after_completion"urlstring | nullmessagestring | nullLink's own words, shown as Link wrote them.
verifyobject | nullverify
statusstringLink's verification requirement.
urlstring | null
blockCodesarray of stringcodestring | nullWhy it ended, as a code.
createdAtstring (date-time)updatedAtstring (date-time)
canChangebooleancanRaisebooleanWhether you may turn them on or raise a threshold (the owner).
- 400Paid or ended already.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner or an admin, or an admin raising what only the owner may, or a key, a connected app or an agent.
- 404No purchase by that id here. With
money_link_spendormoney_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/money/link-spend/purchases/{id}/resumeSay Link's step is donePerson
No API key can call this. Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
Say you finished what Link asked for an agent purchase (added a payment method, contacted Link support): Zuger prepares it again. Owner or admin, signed in.
Why no key
Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay.
AccessA person, signed in. No API key can call this.
Operationmoney.agent
Parameters
idpathstring
Responses
200Success
readAtstringThe day Stripe's availability pages were read.
capabilityobjectcapability
idenum"link_spend"availablebooleanreadybooleanreasonenum"country"·"not_set_up"·"executor_off"·"link_not_connected"·"not_enabled"·"no_consent"·"consent_ended"·nullforWhomstringcountrystring | null
settingsobjectsettings
enabledbooleanthresholdsmap of integerYour thresholds per currency, minor units.
defaultsmap of integerThe defaults: 100 EUR and 100 USD.
consentobject | nullconsent
statusenum"ACTIVE"·"DISCONNECTED"·"REVOKED"scopesarray of stringconnectedAtstring | nullendedAtstring | nullendedReasonstring | null
executorbooleanWhether this deployment can carry out a purchase at all (false in this build: nothing reaches Link).
purchasesarray of objectpurchases
idstringThe purchase; also the idempotency key of its Link spend request.
agentIdstringAn id.
parentIdstring | nullThe purchase this one replaces, where Link asked for a new request.
purposeenum"mpp_data"·"infra_topup"·"formation_fee"·"zuger_store"sellerstringWho sells it, as your agent named them.
amountMinorintegerIn minor units: what Link was asked for, else what the agent proposed.
currencystringstateenum"BLOCKED"·"VERIFY_FIRST"·"PASSKEY_PENDING"·"REJECTED"·"READY"·"AT_LINK"·"AFTER_ACTION"·"SUCCEEDED"·"FAILED"·"DENIED"·"EXPIRED"·"CANCELED"·"REPLACED"linkStatusenum"created"·"pending_approval"·"requires_action"·"approved"·"submitted"·"succeeded"·"failed"·"denied"·"expired"·"canceled"·nullpasskeybooleanWhether your passkey was needed as well (above the threshold, P67).
thresholdMinorinteger | nullThe threshold it was measured against; null: a currency with no threshold, so always a passkey.
approvalIdstring | nullIts MONEY_OUT approval, above the threshold.
approveInLinkstring | nullLink's own approval address while Link waits for you ("Approve in Link").
approvalExpiresAtstring | nullLink's 30-minute approval window ends.
nextActionobject | nullnextAction
typestringresolutionenum"auto_resume"·"create_new_spend_request"·"create_new_spend_request_after_completion"urlstring | nullmessagestring | nullLink's own words, shown as Link wrote them.
verifyobject | nullverify
statusstringLink's verification requirement.
urlstring | null
blockCodesarray of stringcodestring | nullWhy it ended, as a code.
createdAtstring (date-time)updatedAtstring (date-time)
canChangebooleancanRaisebooleanWhether you may turn them on or raise a threshold (the owner).
- 400Not waiting for you.
- 401Not signed in: no session, or no valid API key.
- 403Agent money limits are the company's rules about its agents, set by its owner with a passkey; an agent is held to them and never reads or changes them. A key is an agent's or an integration's, so it can neither change the limits nor read what the agents prepared to pay. Not the owner or an admin, or an admin raising what only the owner may, or a key, a connected app or an agent.
- 404No purchase by that id here. With
money_link_spendormoney_executoroff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
Findings and Bernina
Reconciliation findings, the audit-ready sweep, and Bernina's summary.
GET/v1/findingsList audit-ready findingsfindings:read
AccessAn API key with the scope findings:read, or a person signed in.
Operationfindings.read
Responses
200Success
stateone ofstate
- object Audit-ready is not on this plan.
stateenum"OFF"
- object Säntis is still gathering the history a sweep needs.
stateenum"BUILDING_HISTORY"daysSoFarintegerdaysNeededinteger
- object
stateenum"READY"
findingsarray of objectThe newest 200.
findings
idstringAn id.
agentKindenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"checkenum"ledger_vs_bank"·"invoice_vs_source"·"duplicate_detection"·"vendor_anomaly"·"doc_consistency"·"filing_vs_ledger"·"agent_drift"severityenum"info"·"review"·"urgent"claimstringWhat it found.
evidenceobjectWhat it rests on.
proposedActionstring | nullcreatedAtstring (date-time)verdictenumA person's verdict, if any.
"confirmed"·"dismissed"·"corrected"·nullrunIdstring | nullAn id.
entityIdstring | nullAn id.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
findings:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/findings \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/bernina/securityRead Bernina's settingsPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
labelenum"Bernina"enabledbooleanmodeenum"observe"·"enforce"checkpointsarray of enumegressAllowlistarray of stringThe hosts a Run may reach.
notestring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
GET/v1/bernina/summaryRead Bernina's countersruns:read
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Responses
200Success
runsInspectedintegerRuns she checked, ever.
runsInspected30dinteger…in the last 30 days.
itemsRedactedintegerblocksintegerescalationsintegerescalations30dintegerreviewsWaitingintegerBernina reviews waiting on a person.
lastAtstring | nullenabledbooleanmodeenum"observe"·"enforce"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/bernina/summary \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/findings/sweepStart an audit-ready sweepruns:write
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.sweep
Responses
201Queued: Säntis sweeps the period and puts what it finds in your approvals.
queuedenumtrueperiodstringThe month swept,
YYYY-MM.notestring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/findings/sweep \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/findings/{id}/verdictGive a verdict on a findingPerson
Why no key
A verdict on a finding is a person's reading of two artefacts, and it is the dataset. A key has read neither.
AccessA person, signed in. No API key can call this.
Operationfindings.verdict
Parameters
idpathstring
Request bodyrequired
verdictenum"confirmed"·"dismissed"·"corrected"notestring
Responses
200Success
idstringThe verdict.
findingIdstringAn id.
verdictenum"confirmed"·"dismissed"·"corrected"atstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A verdict on a finding is a person's reading of two artefacts, and it is the dataset. A key has read neither.
- 404No such finding.
- 429Every failure has this shape.
Memory
What every agent of the company remembers.
GET/v1/memoryRead company memorymemory:read
AccessAn API key with the scope memory:read, or a person signed in.
Operationmemory.read
Responses
200Success
memoryarray of MemoryItemWhat every agent of the company remembers, newest first.
memory
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
memory:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/memory \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/memoryRemember somethingmemory:write
AccessAn API key with the scope memory:write, or a person signed in.
Operationmemory.write
Request bodyrequired
contentstring1 to 2,000 characters, kept as a preference every agent reads.
minLength1· maxLength2000
Responses
201Success
idstringAn id.
createdAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
memory:writescope. - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/memory \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"content": "…"}'DELETE/v1/memory/{id}Forget a memorymemory:write
AccessAn API key with the scope memory:write, or a person signed in.
Operationmemory.forget
Parameters
idpathstring
Responses
200Success
forgottenstringAn id.
notestring"Every agent stops seeing this immediately."
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
memory:writescope. - 404No such memory.
- 429Every failure has this shape.
curl -X DELETE https://beta.zuger.ai/v1/memory/{id} \
-H "Authorization: Bearer $ZUGER_KEY"Routines
Briefs on a schedule: an agent, what to do, and when.
GET/v1/routinesList routinesroutines:read
AccessAn API key with the scope routines:read, or a person signed in.
Operationroutines.read
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
routines:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/routines \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/routinesCreate a routineroutines:write
A routine: an agent, what to do, and when (every day, week or month at a time).
schedule is required in practice: a routine without one is refused (400).
AccessAn API key with the scope routines:write, or a person signed in.
Operationroutines.write
Request bodyrequired
agentenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"namestring2 to 80 characters.
minLength2· maxLength80instructionstringWhat to do each time, 4 to 2,000 characters.
minLength4· maxLength2000scheduleRoutineScheduleWhen a routine runs, in its time zone (packages/accounts/src/schedule.ts).
minutemay be left out on input (0).schedule
timezonestringAn IANA time zone;
Europe/Tallinnwhen left out or not one.
Responses
200Success
idstringAn id.
namestringwhenstringThe schedule in words.
timezonestringnextRunAtstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
routines:writescope. An owner or an admin. An API key passes as the person who made it: never with more than the role they held when they made it, nor more than they hold now (a creator made a member, or gone from the company, takes the key down with them). Pro and up (the 403 carriesofferApprovalId); at most 25 routines. - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/routines \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"agent": "CHIEF_OF_STAFF", "name": "…", "instruction": "…"}'PATCH/v1/routines/{id}Change, pause or resume a routineroutines:write
AccessAn API key with the scope routines:write, or a person signed in.
Operationroutines.write
Parameters
idpathstring
Request body
pausedbooleanPause or resume. Sent alone, nothing else changes.
namestring2 to 80 characters.
instructionstring4 to 2,000 characters.
scheduleRoutineScheduleWhen a routine runs, in its time zone (packages/accounts/src/schedule.ts).
minutemay be left out on input (0).schedule
timezonestringAn IANA time zone.
Responses
200Success
one of
- object Paused or resumed.
idstringAn id.
pausedboolean
- object Changed.
idstringAn id.
whenstring | nulltimezonestringpausedbooleannextRunAtstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
routines:writescope. An owner or an admin, to pause and resume too. An API key passes as the person who made it: never with more than the role they held when they made it, nor more than they hold now (a creator made a member, or gone from the company, takes the key down with them). - 404No such routine.
- 429Every failure has this shape.
curl -X PATCH https://beta.zuger.ai/v1/routines/{id} \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"paused": true, "name": "…", "instruction": "…"}'DELETE/v1/routines/{id}Delete a routineroutines:write
AccessAn API key with the scope routines:write, or a person signed in.
Operationroutines.write
Parameters
idpathstring
Responses
200Success
deletedstringAn id.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
routines:writescope. An owner or an admin. An API key passes as the person who made it: never with more than the role they held when they made it, nor more than they hold now (a creator made a member, or gone from the company, takes the key down with them). - 404No such routine.
- 429Every failure has this shape.
curl -X DELETE https://beta.zuger.ai/v1/routines/{id} \
-H "Authorization: Bearer $ZUGER_KEY"Documents
Files uploaded for agents to read.
GET/v1/documentsList uploaded filesPerson
No API key can call this. It needs a person, signed in.
The files people have given the agents, newest first: name, type, size, and the Run that read each.
AccessA person, signed in. No API key can call this.
Operationdocuments.read
Responses
200Success
documentsarray of objectThe newest 200.
documents
idstringAn id.
filenamestringmimeTypestringsizeBytesintegerrunIdstring | nullThe Run that wrote it, if an agent did.
createdAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
POST/v1/documentsUpload a file for agents to readPerson
No API key can call this. It needs a person, signed in.
Give the agents a file: PDF, PNG, JPEG, WebP, GIF, or plain text, CSV, Markdown or JSON, up to 10 MB, as base64 in "data". The same file twice is the same document. Name it in a brief ("documents": [id]) and the agent reads it.
AccessA person, signed in. No API key can call this.
Operationdocuments.write
Request bodyrequired
filenamestringIts name; cleaned, and given the type's extension.
mimeTypeenumWhat it is; checked against its first bytes.
"application/pdf"·"image/png"·"image/jpeg"·"image/webp"·"image/gif"·"text/plain"·"text/csv"·"text/markdown"·"application/json"datastringThe file as base64 (a
data:URL prefix is allowed), up to 10 MB.
Responses
200Success
idstringAn id.
filenamestringmimeTypestringsizeBytesintegercreatedAtstring (date-time)alreadyHereenumThe same bytes were uploaded before: that document, answered again.
true
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Type
storage_limit, where storage limits are on for the company: this file would take its current files past the plan's limit. Nothing was kept; files already there stay readable.upgradeTonames the next plan, null on the largest. - 429Every failure has this shape.
GET/v1/storageRead how much your files take and what your plan allowsPerson
No API key can call this. It needs a person, signed in.
Bytes of current files, shared across the subscription's companies, and the plan's limit. 404 while storage limits are off for the company.
Bytes of current files, shared across the subscription's companies. Old versions kept for recovery do not count. Over the limit, new files are refused (storage_limit); files already there stay readable and nothing is deleted.
AccessA person, signed in. No API key can call this.
Operationdocuments.read
Responses
200Success
usedBytesintegerBytes of current files.
limitBytesinteger | nullThe plan's limit in bytes; null on a subscription from before v2026-10 until it renews.
planstringThe plan, by its database code.
planNamestringIts name.
upgradeTostring | nullThe next plan, by its database code; null on the largest.
upgradeToNamestring | nullIts name.
upgradeToBytesinteger | nullIts limit in bytes.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 404With
storage_limitsoff for the company, this path answers 404, as an unknown path does. - 429Every failure has this shape.
DELETE/v1/documents/{id}Remove a filePerson
No API key can call this. It needs a person, signed in.
Remove an uploaded file and its bytes. What an agent already wrote from it stays on its Run.
AccessA person, signed in. No API key can call this.
Operationdocuments.write
Parameters
idpathstring
Responses
200Success
removedenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 404No such file.
- 429Every failure has this shape.
GET/v1/documents/{id}/contentDownload a filePerson
No API key can call this. It needs a person, signed in.
One uploaded file, as base64, to open or save.
AccessA person, signed in. No API key can call this.
Operationdocuments.read
Parameters
idpathstring
Responses
200Success
idstringAn id.
filenamestringmimeTypestringsizeBytesintegerdatastringThe bytes, as base64.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 404No such file.
- 429Every failure has this shape.
Connections
Read-only connections to the company's tools and bank, and uploaded statements.
GET/v1/connectionsList connected toolsconnections:read
AccessAn API key with the scope connections:read, or a person signed in.
Operationconnections.read
Responses
200Success
connectionsarray of ConnectionOldest first.
connections
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
connections:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/connections \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/connectorsList the sync connectorsPublic
Every connector is read-only by type.
AccessPublic: no key and no sign-in.
Operationget_v1_connectors
Responses
200Success
connectorsarray of objectconnectors
idstringnamestringproviderstringcategoryenum"ACCOUNTING"·"PAYMENTS"·"BANK_FEED"·"WORKSPACE"·"DOCUMENTS"residencyenum"EU"·"GLOBAL"readOnlyenumAlways true.
trueauthModeenum"OAUTH"·"API_KEY"·"AGGREGATOR_LINK"·"CLIENT_ASSERTION"statusenum"LIVE"·"CONTRACT_PENDING"regionsarray of stringscopesarray of objectscopes
scopestringwhystringprepareOnlybooleanAn unsigned draft in the vendor's own draft state, never sent.
readybooleanWhether Connect can work on this deployment (its configuration is there).
- 400Every failure has this shape.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/connectorsPOST/v1/example-dataLoad a month of example dataPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Load a month of example transactions, invoices, contacts, messages, deals, issues, payouts and documents. Only for a company with nothing connected; marked as example on every read.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Responses
200Success
loadedenumtrueconnectionIdstringAn id.
transactionsintegerinvoicesintegercontactsintegermessagesintegerdealsintegerissuesintegerpayoutsintegerdocumentsintegernotestringWhat happened, in a sentence for a person.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Only the owner or an admin can load example data.
- 429Every failure has this shape.
DELETE/v1/example-dataRemove the example dataPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Remove the example data, every row of it.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Responses
200Success
removedbooleanfalse where none was loaded.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Only the owner or an admin can remove example data.
- 429Every failure has this shape.
GET/v1/statementsList uploaded statementsconnections:read
The statements uploaded so far: files, rows, the span of dates.
AccessAn API key with the scope connections:read, or a person signed in.
Operationconnections.read
Responses
200Success
uploadedbooleanWhether any statement was uploaded.
transactionsintegerRows from statements.
fromstring | nullThe first booking date.
tostring | nullThe last booking date.
lastUploadAtstring | nullfilesarray of objectNewest upload first.
files
filenamestringrowsintegerfromstring | nulltostring | nulluploadedAtstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
connections:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/statements \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/statementsUpload a bank statementPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Upload a bank statement as CSV text: the rows become transactions the agents read. Columns are found by name; the same file twice adds nothing.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Request bodyrequired
filenamestringThe file's name (default statement.csv).
textstringThe CSV, as text: 10 to 800,000 characters. Columns are found by name, in English, German or French.
currencystringThe currency, where the file has no column for it.
Responses
200Success
addedintegerRows added.
alreadyThereintegerRows already uploaded before.
skippedintegerRows whose date or amount could not be read.
fromstring | nullThe first booking date.
tostring | nullThe last booking date.
columnsobjectWhich column was read as what.
columns
datestringamountstringdescriptionstringcounterpartystringreferencestringcurrencystring
filenamestring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Only the owner or an admin can upload a statement.
- 429Every failure has this shape.
DELETE/v1/statementsRemove every uploaded statementPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Remove every uploaded statement and every transaction that came from one.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Responses
200Success
removedbooleanfalse where there was nothing to remove.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Only the owner or an admin can remove statements.
- 429Every failure has this shape.
POST/v1/connections/callbackFinish connecting a toolPerson
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Request bodyrequired
statestringThe
statethe provider sent back.codestringThe authorization code the provider sent back.
realmIdstringQuickBooks only: the company it chose.
Responses
200Success
connectionIdstringAn id.
providerstringreturnTostringWhere in the Console to go now.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Begun by someone else or for another company, connections are not configured here, or the plan's cap is reached.
- 429Every failure has this shape.
GET/v1/connections/catalogList the tools Zuger can connectPublic
AccessPublic: no key and no sign-in.
Operationget_v1_connections_catalog
Responses
200Success
providersarray of objectproviders
providerstringThe tool, as
POST /v1/connections/{provider}/starttakes it.labelstringtierenum1·2readsarray of stringWhat each read scope is for.
writesarray of stringWhat each write scope is for (each use needs approval).
- 400Every failure has this shape.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/connections/catalogGET/v1/connections/linkRead your Link financial insights connectionconnections:read
Your company's Link financial insights (ADR 0009): whether it can be connected (US customers only; shown with the reason where not), the grant's state, the scopes Link granted, the accounts and cards shared (last four digits) with their balances, the last read and the retention. Read-only: nothing here moves money.
AccessAn API key with the scope connections:read, or a person signed in.
Operationconnections.read
Responses
200Success
readAtstringThe day Stripe's availability pages were read,
YYYY-MM-DD.capabilityobjectcapability
idenum"link_insights"availablebooleanWhether Link can be connected now.
connectedbooleanWhether a grant is live and read.
reasonenumWhy not: outside the countries Link offers it in (US customers), Link not set up on this deployment, or Link stopped honouring the grant.
"country"·"not_set_up"·"disconnected"·nullforWhomstringWho it is for, as Stripe offers it ("US customers").
countrystring | nullThe company's country, as Zuger judged by it.
scopesAskedarray of stringretentionChoicesarray of integergrantobject | nullgrant
statusenum"ACTIVE"·"DISCONNECTED"·"REVOKED"grantedScopesarray of stringgrantedActionsarray of stringconnectedAtstring | nulllastSyncAtstring | nulllastSyncOutcomeenum"read"·"partial"·"pending"·"not_verified"·"disconnected"·"failed"·"skipped"·nullendedAtstring | nullendedReasonenum"unauthorized"·"disconnected_by_person"·"no_financial_scope"·nullretentionDaysintegerDays Zuger keeps what it derived from Link.
sourcesarray of objectsources
typeenum"bank_account"·"card"·"other"namestring | nullThe account's name as Link gave it.
last4string | nullThe last four digits; never a full number.
connectionStatusstring | nulltransactionsStatusstring | nullbalancesStatusstring | nullbalanceobject | nullbalance
typeenum"cash"·"credit"·"other"currencystringcurrentMinorintegerMinor units.
availableMinorinteger | nullMinor units.
asOfstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
connections:readscope. - 404With
money_link_insightsoff for the company, every Link path answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/connections/link \
-H "Authorization: Bearer $ZUGER_KEY"DELETE/v1/connections/{id}Disconnect a toolPerson
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Parameters
idpathstring
Responses
200Success
disconnectedstringAn id.
notestringWhat happened, in a sentence for a person.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Only the owner or an admin can disconnect a tool.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
GET/v1/connectors/comingList the vendor connectors coming for this companyconnections:read
Vendor MCP connectors (ADR 0005) whose flag is on for this company: what each reads, that it is read-only, and that it is coming. Empty while every conn_<name> flag is off, as it is for every company today.
Vendor MCP connectors (ADR 0005) whose flag is on for this company, each read-only and still coming. Empty while every connector flag is off, as it is for every company today.
AccessAn API key with the scope connections:read, or a person signed in.
Operationconnections.read
Responses
200Success
connectorsarray of objectconnectors
idstringnamestringproviderstringcategoryenum"ACCOUNTING"·"PAYMENTS"·"BANK_FEED"·"WORKSPACE"·"DOCUMENTS"transportenum"MCP"lifecycleenum"coming"·"beta"·"live"statusenum"LIVE"·"CONTRACT_PENDING"readOnlyenumAlways true.
trueregionChoicebooleanWhether the connect screen asks where the workspace is hosted (Intercom).
regionsarray of stringresidencyenum"EU"·"GLOBAL"scopesarray of objectscopes
scopestringwhystringprepareOnlybooleanAlways false.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
connections:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/connectors/coming \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/connections/bank/callbackFinish linking a bank accountPerson
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Request bodyrequired
adapterstringThe aggregator, as the start answered it.
referencestringThe link's reference, as the aggregator sent it back.
Responses
200Success
connectionIdstringAn id.
providerenum"BANK_AGGREGATOR"adapterstring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. The link was not started by this company, or the plan has no room for another bank account.
- 429Every failure has this shape.
GET/v1/connections/bank/institutionsList banks to linkconnections:read
AccessAn API key with the scope connections:read, or a person signed in.
Operationconnections.read
Parameters
countryquerystringA two-letter country code; default the first legal entity's country, else EE.
Responses
200Success
adapterstringThe open-banking aggregator that covers the country.
countrystringThe country, as a two-letter code.
institutionsarray of objectinstitutions
idstringPass it to
POST /v1/connections/bank/start.namestring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
connections:readscope. - 429Every failure has this shape.
- 502The aggregator could not be reached.
curl https://beta.zuger.ai/v1/connections/bank/institutions \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/connections/bank/startStart linking a bank accountPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
The person logs into their bank on the aggregator's hosted page, never here. Read-only.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Request bodyrequired
institutionIdstringThe bank, from
GET /v1/connections/bank/institutions.entityIdstringThe legal entity the account belongs to; default the first.
returnTostringWhere in the Console to return afterwards.
Responses
200Success
urlstring (uri)The aggregator's hosted link.
referencestringadapterstringreturnTostring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. The plan has no room for another bank account.
- 409Zuger has paused bank links for now (
paused_by_zuger). - 429Every failure has this shape.
POST/v1/connections/link/callbackFinish connecting LinkPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Finish connecting Link with the code and state Link sent back, within ten minutes, by the person who started it. The tokens are kept sealed where only the connector opens them.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Request bodyrequired
codestringThe code Link sent back. Single use, exchanged at once.
statestringThe state Link sent back, as Zuger signed it.
Responses
200Success
readAtstringThe day Stripe's availability pages were read,
YYYY-MM-DD.capabilityobjectcapability
idenum"link_insights"availablebooleanWhether Link can be connected now.
connectedbooleanWhether a grant is live and read.
reasonenumWhy not: outside the countries Link offers it in (US customers), Link not set up on this deployment, or Link stopped honouring the grant.
"country"·"not_set_up"·"disconnected"·nullforWhomstringWho it is for, as Stripe offers it ("US customers").
countrystring | nullThe company's country, as Zuger judged by it.
scopesAskedarray of stringretentionChoicesarray of integergrantobject | nullgrant
statusenum"ACTIVE"·"DISCONNECTED"·"REVOKED"grantedScopesarray of stringgrantedActionsarray of stringconnectedAtstring | nulllastSyncAtstring | nulllastSyncOutcomeenum"read"·"partial"·"pending"·"not_verified"·"disconnected"·"failed"·"skipped"·nullendedAtstring | nullendedReasonenum"unauthorized"·"disconnected_by_person"·"no_financial_scope"·nullretentionDaysintegerDays Zuger keeps what it derived from Link.
sourcesarray of objectsources
typeenum"bank_account"·"card"·"other"namestring | nullThe account's name as Link gave it.
last4string | nullThe last four digits; never a full number.
connectionStatusstring | nulltransactionsStatusstring | nullbalancesStatusstring | nullbalanceobject | nullbalance
typeenum"cash"·"credit"·"other"currencystringcurrentMinorintegerMinor units.
availableMinorinteger | nullMinor units.
asOfstring | null
- 400The attempt expired (ten minutes), was not Zuger's, or Link shared no financial data.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Started by someone else or for another company, or not the owner or an admin, signed in.
- 404With
money_link_insightsoff for the company, every Link path answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/connections/link/connectStart connecting LinkPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Start connecting Link: the consent address at login.link.com (PKCE S256, a signed state, ten minutes) for read-only financial insights. Owner or admin, signed in.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Responses
200Success
urlstring (uri)Link's consent page at login.link.com, with PKCE (S256) and a signed state; valid ten minutes.
- 400Not available: outside the countries Link offers it in, or Link is not set up on this deployment (the reason is said).
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Not the company's owner or an admin, signed in (never a key or a connected app).
- 404With
money_link_insightsoff for the company, every Link path answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/connections/link/disconnectDisconnect Link and revoke its accessPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Disconnect Link: the grant is revoked at Link and every copy Zuger kept (tokens, accounts, balances, findings) is deleted. Owner or admin, signed in.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Responses
200Success
readAtstringThe day Stripe's availability pages were read,
YYYY-MM-DD.capabilityobjectcapability
idenum"link_insights"availablebooleanWhether Link can be connected now.
connectedbooleanWhether a grant is live and read.
reasonenumWhy not: outside the countries Link offers it in (US customers), Link not set up on this deployment, or Link stopped honouring the grant.
"country"·"not_set_up"·"disconnected"·nullforWhomstringWho it is for, as Stripe offers it ("US customers").
countrystring | nullThe company's country, as Zuger judged by it.
scopesAskedarray of stringretentionChoicesarray of integergrantobject | nullgrant
statusenum"ACTIVE"·"DISCONNECTED"·"REVOKED"grantedScopesarray of stringgrantedActionsarray of stringconnectedAtstring | nulllastSyncAtstring | nulllastSyncOutcomeenum"read"·"partial"·"pending"·"not_verified"·"disconnected"·"failed"·"skipped"·nullendedAtstring | nullendedReasonenum"unauthorized"·"disconnected_by_person"·"no_financial_scope"·nullretentionDaysintegerDays Zuger keeps what it derived from Link.
sourcesarray of objectsources
typeenum"bank_account"·"card"·"other"namestring | nullThe account's name as Link gave it.
last4string | nullThe last four digits; never a full number.
connectionStatusstring | nulltransactionsStatusstring | nullbalancesStatusstring | nullbalanceobject | nullbalance
typeenum"cash"·"credit"·"other"currencystringcurrentMinorintegerMinor units.
availableMinorinteger | nullMinor units.
asOfstring | null
- 400Link is not connected.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Not the company's owner or an admin, signed in (never a key or a connected app).
- 404With
money_link_insightsoff for the company, every Link path answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/connections/link/retentionChoose how long Link findings are keptPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
How long Zuger keeps what it derived from Link: 30, 90, 180 or 365 days. Owner or admin, signed in.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Request bodyrequired
daysenumDays Zuger keeps what it derived from Link.
30·90·180·365
Responses
200Success
readAtstringThe day Stripe's availability pages were read,
YYYY-MM-DD.capabilityobjectcapability
idenum"link_insights"availablebooleanWhether Link can be connected now.
connectedbooleanWhether a grant is live and read.
reasonenumWhy not: outside the countries Link offers it in (US customers), Link not set up on this deployment, or Link stopped honouring the grant.
"country"·"not_set_up"·"disconnected"·nullforWhomstringWho it is for, as Stripe offers it ("US customers").
countrystring | nullThe company's country, as Zuger judged by it.
scopesAskedarray of stringretentionChoicesarray of integergrantobject | nullgrant
statusenum"ACTIVE"·"DISCONNECTED"·"REVOKED"grantedScopesarray of stringgrantedActionsarray of stringconnectedAtstring | nulllastSyncAtstring | nulllastSyncOutcomeenum"read"·"partial"·"pending"·"not_verified"·"disconnected"·"failed"·"skipped"·nullendedAtstring | nullendedReasonenum"unauthorized"·"disconnected_by_person"·"no_financial_scope"·nullretentionDaysintegerDays Zuger keeps what it derived from Link.
sourcesarray of objectsources
typeenum"bank_account"·"card"·"other"namestring | nullThe account's name as Link gave it.
last4string | nullThe last four digits; never a full number.
connectionStatusstring | nulltransactionsStatusstring | nullbalancesStatusstring | nullbalanceobject | nullbalance
typeenum"cash"·"credit"·"other"currencystringcurrentMinorintegerMinor units.
availableMinorinteger | nullMinor units.
asOfstring | null
- 400Not one of 30, 90, 180 or 365, or Link was never connected.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Not the company's owner or an admin, signed in (never a key or a connected app).
- 404With
money_link_insightsoff for the company, every Link path answers 404, as an unknown path does. - 429Every failure has this shape.
PATCH/v1/connections/{id}/entityAssign a connected tool to a companyPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Assign a connected tool to one of the companies, or to none.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Parameters
idpathstring
Request body
entityIdstring | nullThe legal entity, or null for none.
Responses
200Success
idstringThe connection.
entityIdstring | nullAn id.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Only the owner or an admin can do this.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/connections/{id}/syncSync a connected tool nowPerson
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Parameters
idpathstring
Request body
fullbooleantrue: read everything again, not only what changed.
Responses
201Success
queuedenumtrueconnectionIdstringAn id.
fullboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. It is past what the plan covers, so it does not sync.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/connections/{provider}/startStart connecting a toolPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Answers the provider's consent page. After it, the provider sends the person back with a code for POST /v1/connections/callback.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Parameters
providerpathstring
Request body
returnTostringWhere in the Console to return afterwards (a path on this site; default
/connections).
Responses
200Success
urlstring (uri)The provider's consent page.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Connections are not configured here, the plan's connected-tools cap is reached, or the tool needs a flag that is off.
- 404Nothing by that id in this company.
- 409Zuger has paused this tool for now (
paused_by_zuger). - 429Every failure has this shape.
Webhooks and API keys
Where the company's events are sent, and the keys that call this API.
GET/v1/api-keysList API keysPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationapikeys.read
Responses
200Success
keysarray of objectNewest first, revoked ones too.
keys
idstringAn id.
namestringprefixstringThe start of the key, enough to recognise it.
scopesarray of stringlastUsedAtstring | nullcreatedAtstring (date-time)revokedAtstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
POST/v1/api-keysMake an API keyPerson
No API key can call this. It needs a person, signed in.
Twenty live keys per company at most. With no scopes asked for, the key gets every :read scope.
AccessA person, signed in. No API key can call this.
Operationapikeys.write
Request bodyrequired
namestringIts name: 2 to 60 characters.
scopesarray of stringThe scopes it holds; unknown ones are dropped.
Responses
201Success
idstringAn id.
namestringprefixstringscopesarray of stringcreatedAtstring (date-time)tokenstringThe key itself (
zk_live_…). Shown here once, and never again.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin can make a key, and their email address must be confirmed.
- 429Every failure has this shape.
GET/v1/webhooksList webhook addresseswebhooks:read
The addresses this company's events are sent to, and the kinds of event there are.
AccessAn API key with the scope webhooks:read, or a person signed in.
Operationwebhooks.read
Responses
200Success
eventsarray of enumThe kinds of event an address can hear.
endpointsarray of WebhookEndpointOldest first.
endpoints
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
webhooks:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/webhooks \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/webhooksAdd a webhook addresswebhooks:write
Add a public https address. The signing secret is in this response and nowhere else, ever.
Ten addresses per company at most. Deliveries are signed with the secret in this answer (x-zuger-signature); see the webhooks in this document.
AccessAn API key with the scope webhooks:write, or a person signed in.
Operationwebhooks.write
Request bodyrequired
urlstring (uri)A public https address: no private, loopback or link-local address, no credentials in it.
eventsarray of enumThe events to send; unknown names are dropped. Empty or left out: every event.
Responses
201Success
idstringThe address's id.
urlstring (uri)The public https address events are POSTed to.
eventsarray of enumThe events it hears. Empty: every event.
activebooleanWhether deliveries go to it. Switched off by itself after twenty failed deliveries in a row.
failuresintegerDeliveries that failed in a row (every attempt). Reset by a delivery that arrives, or by switching it back on.
lastDeliveryAtstring | nullWhen a delivery was last tried to its end.
lastStatusinteger | nullThe HTTP status the last delivery got; 0 where nothing answered.
createdAtstring (date-time)secretstringThe signing secret. Shown here once, and never again.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
webhooks:writescope. Only the owner or an admin can change where events are sent, with a confirmed email address. An API key passes as the person who made it: never with more than the role they held when they made it, nor more than they hold now (a creator made a member, or gone from the company, takes the key down with them). A key's address is its creator's. - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/webhooks \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "…"}'DELETE/v1/api-keys/{id}Revoke an API keyPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationapikeys.write
Parameters
idpathstring
Responses
200Success
revokedstringThe key revoked.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin can revoke a key.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
PATCH/v1/webhooks/{id}Change a webhook addresswebhooks:write
Switch an address on or off, or change which events it hears.
AccessAn API key with the scope webhooks:write, or a person signed in.
Operationwebhooks.write
Parameters
idpathstring
Request body
activebooleanSwitch it on or off. Switching on resets its failures.
eventsarray of enumThe events it hears; unknown names are dropped. Empty: every event.
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
webhooks:writescope. Only the owner or an admin can change where events are sent. An API key passes as the person who made it: never with more than the role they held when they made it, nor more than they hold now (a creator made a member, or gone from the company, takes the key down with them). - 404Nothing by that id in this company.
- 429Every failure has this shape.
curl -X PATCH https://beta.zuger.ai/v1/webhooks/{id} \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"active": true, "events": []}'DELETE/v1/webhooks/{id}Remove a webhook addresswebhooks:write
AccessAn API key with the scope webhooks:write, or a person signed in.
Operationwebhooks.write
Parameters
idpathstring
Responses
200Success
removedstringThe address removed.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
webhooks:writescope. Only the owner or an admin can change where events are sent. An API key passes as the person who made it: never with more than the role they held when they made it, nor more than they hold now (a creator made a member, or gone from the company, takes the key down with them). - 404Nothing by that id in this company.
- 429Every failure has this shape.
curl -X DELETE https://beta.zuger.ai/v1/webhooks/{id} \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/webhooks/{id}/pingSend a test event to a webhook addresswebhooks:write
Send a signed ping to one address, to see that it arrives.
Queues one signed ping to that address, whatever events it hears.
AccessAn API key with the scope webhooks:write, or a person signed in.
Operationwebhooks.write
Parameters
idpathstring
Responses
200Success
sentenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
webhooks:writescope. Only the owner or an admin can change where events are sent. An API key passes as the person who made it: never with more than the role they held when they made it, nor more than they hold now (a creator made a member, or gone from the company, takes the key down with them). - 404Nothing by that id in this company.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/webhooks/{id}/ping \
-H "Authorization: Bearer $ZUGER_KEY"Audit log
The hash-chained audit log.
GET/v1/audit/exportExport the audit logaudit:read
The hash-chained audit log, oldest first. Max and Ultra; owner or admin.
AccessAn API key with the scope audit:read, or a person signed in.
Operationaudit.read
Responses
200The hash-chained audit log: recompute the chain to verify it.
companyIdstringAn id.
exportedAtstring (date-time)eventsarray of objectOldest first, up to 20,000.
events
seqintegerIts place in the chain; no gaps.
createdAtstring (date-time)actorTypestringUSER,AGENT,SYSTEMorSTAFF.actorIdstring | nullactionstringsubjectTypestringsubjectIdstring | nullpayloadobject | nullWhat the event records.
prevHashstring | nullhashstringSeals this event together with
prevHash.
completebooleanFalse when the 20,000 cap cut it.
notestring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
audit:readscope. An owner or an admin, on Max or Ultra. An API key passes as the person who made it: never with more than the role they held when they made it, nor more than they hold now (a creator made a member, or gone from the company, takes the key down with them). - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/audit/export \
-H "Authorization: Bearer $ZUGER_KEY"MCP
The Model Context Protocol endpoint: one address for every assistant.
One address for every assistant. The tools, the sign-in and the setup are on the Zuger MCP page.
GET/mcpOpen an event stream (there is none)Public
No event stream: POST instead.
AccessPublic: no key and no sign-in.
Operationget_mcp
Responses
- 400Every failure has this shape.
- 405There is no event stream to open: POST instead.
- 429Every failure has this shape.
curl https://beta.zuger.ai/mcpPOST/mcpSend one MCP JSON-RPC messageAPI key
The Model Context Protocol endpoint: one JSON-RPC message per POST. Tools: brief, read runs and approvals, routines, memory. Nothing that decides.
The tools, each with the scope an API key needs for it (checked per call):
list_agents(agents:read): List agentsbrief_agent(runs:write): Brief an agentinvoice_from_chain(runs:write): Draft an invoice from a closed chainlist_runs(runs:read): List runsget_run(runs:read): Get a runlist_approvals(approvals:read): What is waiting on a personget_approval(approvals:read): Get an approvalwhats_waiting(approvals:read): What needs melist_routines(routines:read): List routinescreate_routine(routines:write): Create a routinepause_routine(routines:write): Pause or resume a routinelist_memory(memory:read): Read company memoryremember(memory:write): Remember somethinglist_findings(findings:read): Audit-ready findingsexport_audit(audit:read): Export the audit log
AccessAn API key, whose scopes are checked for each tool, or a person signed in.
Operationmcp.call
Request bodyrequired
jsonrpcenum"2.0"idstring | integer | nullLeft out for a notification, which has no answer.
methodstringinitialize,ping,tools/list,tools/call,resources/list,resources/templates/list,resources/read,prompts/list,prompts/get,completion/complete,logging/setLevel, or anotifications/….paramsobjectThe method's parameters, as the Model Context Protocol (2025-06-18) defines them.
Responses
200Success
jsonrpcenum"2.0"idstring | integer | nullresultobjectThe method's result.
errorobjecterror
codeintegerJSON-RPC's: -32700 parse, -32600 invalid request, -32601 no such method, -32602 invalid params, -32603 internal.
messagestringdataanyMore about it.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Refused for this caller.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/mcp \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"jsonrpc": "2.0", "method": "…"}'DELETE/mcpEnd an MCP session (there is none)API key
Nothing to end: the server keeps no session.
AccessAn API key, whose scopes are checked for each tool, or a person signed in.
Operationmcp.call
Responses
200Nothing to end: the server keeps no session.
okenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Refused for this caller.
- 429Every failure has this shape.
curl -X DELETE https://beta.zuger.ai/mcp \
-H "Authorization: Bearer $ZUGER_KEY"Pilatus: filings Coming online
Pilatus's statutory calendar and filing packs. Pilatus prepares; a person files.
GET/v1/pilatus/calendarRead Pilatus's statutory calendarruns:read
Pilatus’s statutory calendar: each entity’s obligations in the jurisdictions switched on for you (Estonia, Switzerland and the UAE; the United States, Delaware, with US formation on) with their period, due date, status and the rule’s legal sources, the duties that follow a change, the rules files’ versions and counts, the weekly Statutory calendar check with its weight (3 Runs), and the Atlas-ready packs where US formation is on. Every date is prepared for you to check with your adviser; a rule marked needsReview is not verified.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Responses
200Each entity's obligations, the standing duties, every rule with its sources, and the weekly check.
onShiftbooleanPilatus is on shift.
todaystring (date)The company's day.
rulesVersionstringThe rules files' version.
checkobjectcheck
namestringThe weekly Statutory calendar check's name.
runsintegerWhat one weekly Statutory calendar check weighs, in Runs, said before it runs.
scheduleany ofschedule
- null
whenstring | nullThe schedule in words ("Every Monday at 06:00").
timezonestring | nullThe routine's time zone.
pausedboolean | nullWhether the routine is paused; null where there is none yet.
nextRunAtstring | nullWhen it runs next.
lastobject | nullThe last one, if any.
last
runIdstringThe Run.
statusstringIts status.
atstring (date-time)When it started.
entitiesarray of PilatusEntityentities
jurisdictionsarray of enumThe jurisdictions switched on for the company, from the rules files.
summaryobjectWhat the rules files hold, counted from them.
summary
jurisdictionsarray of stringrulesintegertoConfirmintegerversionsmap of string
rulesarray of objectrules
idstringjurisdictionenum"EE"·"CH"·"AE"·"US"titlestringneedsReviewbooleanlastReviewedstring (date)sourcesarray of AgentsLegalSourcesources
formationsarray of ApprovalFormationPackThe Atlas-ready packs, where US formation is on (
pilatus_atlas_formation).formations
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Pilatus is not switched on for this company (agent_pilatus). - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/pilatus/calendar \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/filings/{id}/doneRecord that you filed an obligationPerson
No API key can call this. An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
Say you filed an obligation yourself, with an optional note (a reference number). A record of what you did, not an act: Zuger files nothing. Owner or admin.
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Request body
notestringA reference number or note; one line, 500 characters at most.
Responses
200Success
idstringThe obligation.
statusenum"FILED"filedAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things. Only the owner or an admin. Pilatus is not switched on for this company (
agent_pilatus). - 404No such obligation.
- 409Already filed, marked not applicable, or changed meanwhile.
- 429Every failure has this shape.
POST/v1/filings/{id}/not-applicableMark an obligation as not applicablePerson
No API key can call this. An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
Say an obligation does not apply to this entity, before anything was prepared for it. Owner or admin.
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Responses
200Success
idstringThe obligation.
statusenum"DISMISSED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things. Only the owner or an admin. Pilatus is not switched on for this company (
agent_pilatus). - 404No such obligation.
- 409Something was already prepared for it, or it changed meanwhile.
- 429Every failure has this shape.
POST/v1/pilatus/formations/{id}/exportExport an Atlas-ready pack as a PDF or Word filePerson
No API key can call this. It needs a person, signed in.
The Atlas-ready pack as a file (format: pdf or docx), in the language it was written in, given back as base64. Not kept: made again each time.
AccessA person, signed in. No API key can call this.
Operationdocuments.read
Parameters
idpathstring
Request body
formatenumpdf by default.
"pdf"·"docx"
Responses
200Success
filenamestringmimeTypestringdatastringThe file, base64.
- 400Choose PDF or Word.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. US formation with Pilatus is not switched on for this company (
pilatus_atlas_formation). - 404No such pack.
- 429Every failure has this shape.
POST/v1/pilatus/formations/{id}/formedRecord a company you formed in Stripe AtlasPerson
No API key can call this. An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
Record a company you formed in Stripe Atlas yourself (formedOn, entityType C_CORP or LLC, optional legalName): it joins your account through the usual entity path and your plan’s company limit, as a Delaware entity, and its Delaware and US calendar starts. A record of what you did: Zuger formed, filed and paid nothing. Owner or admin, after the pack was handed to you.
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Request bodyrequired
formedOnstring (date)The day Stripe Atlas says it was formed; not in the future.
entityTypeenum"C_CORP"·"LLC"legalNamestringThe name it was formed under, if not the pack's.
Responses
200Success
idstringThe pack.
statusenum"FORMED"entityobjectentity
idstringAn id.
legalNamestringjurisdictionstring
obligationsintegerObligations made for its calendar now.
- 400A date, not in the future; a type of C_CORP or LLC.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things. Only the owner or an admin. Or your plan runs no more companies (below Ultra, one), said with the upgrade. US formation with Pilatus is not switched on for this company (
pilatus_atlas_formation). - 404No such pack.
- 409Not yet taken in your approvals, already recorded, or changed meanwhile.
- 429Every failure has this shape.
Titlis: contracts Coming online
Titlis's contract reviews, the playbook and contract dates. Not legal advice; Titlis never signs or sends.
GET/v1/titlis/contractsList Titlis's reviewed contractsruns:read
Titlis’s contracts: each reviewed contract’s key terms (figures, never its words), its findings against your playbook (blocked, to change, fine), its dates (the last day to give notice, renewal, end) and their status; your playbook and its version; the files a review can read; and the weights: a contract review 5 Runs, the weekly Contract deadlines check 3. Not legal advice; Titlis never signs or sends.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Responses
200Success
onShiftbooleantodaystring (date)The company's day.
reviewobjectreview
namestringrunsintegerA contract review weighs 5 Runs.
checkobjectcheck
namestringThe weekly Contract deadlines check's name.
runsintegerWhat one weekly Contract deadlines check weighs, in Runs, said before it runs.
scheduleany ofschedule
- null
whenstring | nullThe schedule in words ("Every Monday at 06:00").
timezonestring | nullThe routine's time zone.
pausedboolean | nullWhether the routine is paused; null where there is none yet.
nextRunAtstring | nullWhen it runs next.
lastobject | nullThe last one, if any.
last
runIdstringThe Run.
statusstringIts status.
atstring (date-time)When it started.
contractsarray of TitlisContractThe most urgent notice first; at most 100.
contracts
playbookTitlisPlaybookplaybook
documentsarray of objectUploaded files a review can read; never their names.
documents
idstringAn id.
kindstringmimeTypestringsizeBytesintegercreatedAtstring (date-time)reviewedbooleancontractIdstring | nullAn id.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Titlis is not switched on for this company (agent_titlis). - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/titlis/contracts \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/titlis/playbookRead the contract playbookPerson
No API key can call this. It needs a person, signed in.
Your playbook: what you accept per kind of clause (liability cap, notice, renewal, term, governing law, payment terms, intellectual property, confidentiality, termination), whether a breach flags or blocks, where each rule comes from, and its version (0: Zuger’s defaults).
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Titlis is not switched on for this company (
agent_titlis). - 429Every failure has this shape.
PATCH/v1/titlis/playbookSave the contract playbookPerson
No API key can call this. It needs a person, signed in.
Save your playbook (owner or admin): the positions, each checked, as a new version. reset: true puts Zuger’s defaults back. Reviews made before keep the version they cite.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request body
positionsarray of objectThe positions to change (each known, once; a figure within its bounds, countries two letters). Positions not given keep the default.
positions
idenum"liability_cap"·"notice"·"renewal"·"term"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"onbooleanseverityenum"flag"·"block"sourcestring | nullOne line, 160 characters at most.
valueany ofThe position's figure (months, days or years, by position), the countries for governing_law, or null for ip.
value
- number
- array of string
- null
resetbooleantrueputs Zuger's defaults back, as a new version.
Responses
200Success
versionintegerThe new version.
positionsarray of TitlisPositionpositions
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Titlis is not switched on for this company (
agent_titlis). - 409The playbook changed meanwhile.
- 429Every failure has this shape.
POST/v1/titlis/reviewsAsk Titlis to review a contractruns:write
Ask Titlis to review a contract you uploaded (documentId) against your playbook: a fixed 5 Runs, shown before it starts. The review, its redlines and its dates wait in your approvals; nothing is signed or sent.
A brief like any other: 429 briefs_busy while Zuger is busy with your earlier requests.
AccessAn API key with the scope runs:write, or a person signed in.
Operationruns.brief
Request bodyrequired
documentIdstringA contract file uploaded to this company (not a synced Notion or Drive title).
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:writescope. Titlis is not switched on for this company (agent_titlis). - 404No such file.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/titlis/reviews \
-H "Authorization: Bearer $ZUGER_KEY" \
-H "Content-Type: application/json" \
-d '{"documentId": "…"}'POST/v1/contract-dates/{id}/doneRecord that you acted on a contract datePerson
No API key can call this. An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
Say you acted on a contract date yourself (gave notice, let it renew, closed it). A record of what you did, not an act: Zuger sends and signs nothing. Owner or admin.
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Responses
200Success
idstringThe contract date.
statusenum"DONE"doneAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things. Only the owner or an admin. Titlis is not switched on for this company (
agent_titlis). - 404No such contract date.
- 409Already done, marked not applicable, or changed meanwhile.
- 429Every failure has this shape.
POST/v1/contract-dates/{id}/not-applicableMark a contract date as not applicablePerson
No API key can call this. An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
Say a contract date does not apply, before anyone acted on it. Owner or admin.
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Responses
200Success
idstringThe contract date.
statusenum"DISMISSED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things. Only the owner or an admin. Titlis is not switched on for this company (
agent_titlis). - 404No such contract date.
- 409Someone already acted on it, or it changed meanwhile.
- 429Every failure has this shape.
Gotthard: engineering Coming online
Gotthard's triage, reproduction steps, review comments and changelogs for the company's own GitHub and Linear.
GET/v1/gotthard/engineeringRead Gotthard's engineering tools settingsPerson
No API key can call this. It needs a person, signed in.
Settings → Engineering tools: for GitHub and Linear, whether this deployment can connect Gotthard’s permission, the connection that holds it (or the read-only one it would take the place of), what the permission allows and why, the company’s switch, daily cap and language for each, today’s posts and what waits; and the weekly Engineering digest with its weight (3 Runs). Connect with POST /v1/gotthard/connect/GITHUB or /LINEAR.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Each channel's connection, switch, cap and language, and the weekly digest; { "available": false } where Gotthard is not switched on.
any of
- object Where the agent is not switched on for the company.
availableenumfalse
- object
availableenumtruepostingbooleanPosting is switched on for this deployment.
onShiftbooleancompanyLocaleenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"channelsarray of objectchannels
channelenum"GITHUB"·"LINEAR"labelstringreadybooleanThis deployment can connect Gotthard's permission.
connectionobject | nullThe connection holding Gotthard's permission.
connection
idstringAn id.
accountstring | nullstatusstringconnectedAtstring (date-time)lastUsedAtstring | null
readOnlyobject | nullThe read-only connection it would take the place of.
readOnly
idstringAn id.
accountstring | null
grantarray of objectWhat the permission allows and why.
grant
scopestringusestringwhystring
installUrlstring | nullThe GitHub App's install page.
pausedbooleanThe company's switch for this channel.
pausedAtstring | nulldailyCapinteger | nullcapDefaultintegercapMaxintegerlocaleenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"·nulltodayintegerPosted today.
waitingintegerApproved and waiting to be posted.
digestobjectdigest
namestringThe weekly Engineering digest's name.
runsintegerWhat one weekly Engineering digest weighs, in Runs, said before it runs.
scheduleany ofschedule
- null
whenstring | nullThe schedule in words ("Every Monday at 06:00").
timezonestring | nullThe routine's time zone.
pausedboolean | nullWhether the routine is paused; null where there is none yet.
nextRunAtstring | nullWhen it runs next.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
GET/v1/gotthard/queueList Gotthard's engineering queueruns:read
The Engineering queue: triage, reproduction steps, review comments and changelogs waiting for your approval, approved and to be posted, posted (with their links), and what stopped and why. Nothing is posted without your passkey approval, and Gotthard never merges, pushes, approves, closes or deletes.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Responses
200Success
postingbooleanPosting is switched on for this deployment.
draftsarray of GotthardActionWaiting for your approval.
drafts
toPostarray of GotthardActionApproved and to be posted.
toPost
postedarray of GotthardActionPosted, newest first; 50 at most.
posted
stoppedarray of GotthardActionRefused, failed, withdrawn or not approved; 30 at most.
stopped
digestobjectdigest
namestringrunsinteger
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Gotthard is not switched on for this company (agent_gotthard). - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/gotthard/queue \
-H "Authorization: Bearer $ZUGER_KEY"PATCH/v1/gotthard/channels/{channel}Set a Gotthard channel's switch, cap or languagePerson
No API key can call this. It needs a person, signed in.
Switch a channel (GITHUB or LINEAR) off or on, set its daily cap, or the language Gotthard writes in there (owner or admin). Off is the company’s kill switch for that channel: findings approved and waiting on it are withdrawn and nothing is posted there until it is switched back on.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
channelpathstring
Request body
pausedbooleanOff is the company's kill switch: findings waiting on it are withdrawn.
dailyCapinteger | null1 to 50; null for the default (20).
localeenumThe language Gotthard writes in there; null for the company's.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"·null
Responses
200Success
channelenum"GITHUB"·"LINEAR"pausedbooleandailyCapinteger | nulllocalestring | nullwithdrawnintegerFindings withdrawn by switching it off.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Gotthard is not switched on for this company (
agent_gotthard). - 404No such channel.
- 429Every failure has this shape.
POST/v1/gotthard/connect/{provider}Connect GitHub or Linear with Gotthard's permissionPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Connect GitHub (Zuger’s GitHub App: Issues and Pull requests read & write, Contents and Metadata read; never code) or Linear (read, issues:create, comments:create) with the permission Gotthard posts through, owner or admin, where agent_gotthard is on. Returns the provider’s consent page; nothing is posted without a passkey approval of each comment, issue or label.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Parameters
providerpathstring
Request body
returnTostringWhere the Console goes back to afterwards (a Console path);
/connectionsby default.
Responses
200Success
urlstring (uri)The provider's consent page.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Only the owner or an admin. Gotthard is not switched on for this company (
agent_gotthard). Or the plan's connected-tools cap is reached. - 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/gotthard/actions/{id}/cancelWithdraw an approved finding before it is postedPerson
No API key can call this. An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
Withdraw a finding you approved before it is posted (the person who approved it, the owner or an admin). It is then never posted.
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Responses
200Success
idstringAn id.
statusenum"CANCELLED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things. Only the person who approved it, the owner or an admin.
- 404No such finding.
- 409It is being posted now, is not waiting, or changed meanwhile.
- 429Every failure has this shape.
Matterhorn: social Coming online
Matterhorn's posts and public replies on the company's own X and LinkedIn accounts.
GET/v1/matterhorn/queueList Matterhorn's social queueruns:read
The Social queue: posts and public replies waiting for your approval, approved and scheduled (with their time), published (with their links and numbers), and what stopped and why. Nothing is published without your passkey approval.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Responses
200Success
publishingbooleanPublishing is switched on for this deployment.
draftsarray of MatterhornPostWaiting for your approval.
drafts
scheduledarray of MatterhornPostApproved, by their time.
scheduled
publishedarray of MatterhornPostPublished, newest first; 50 at most.
published
stoppedarray of MatterhornPostRefused, failed, withdrawn or not approved; 30 at most.
stopped
reportobjectreport
namestringrunsinteger
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Matterhorn is not switched on for this company (agent_matterhorn). - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/matterhorn/queue \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/matterhorn/socialRead Matterhorn's social accounts settingsPerson
No API key can call this. It needs a person, signed in.
Settings → Social accounts: for X and LinkedIn, whether this deployment can connect it, the company’s own account and its status, the company’s switch and daily cap, today’s posts and what is scheduled; the brand voice Matterhorn writes in; and the weekly Social report with its weight (3 Runs). Connect with POST /v1/connections/X/start or /LINKEDIN/start.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Each channel's account, switch and cap, the brand voice and the weekly report; { "available": false } where Matterhorn is not switched on.
any of
- object Where the agent is not switched on for the company.
availableenumfalse
- object
availableenumtruepublishingbooleanPublishing is switched on for this deployment.
onShiftbooleantimezonestringThe company's zone.
channelsarray of objectchannels
channelenum"X"·"LINKEDIN"labelstringreadybooleanThis deployment can connect it.
connectionobject | nullconnection
idstringAn id.
accountstring | nullstatusstringconnectedAtstring (date-time)lastUsedAtstring | null
pausedbooleanThe company's switch for this channel.
pausedAtstring | nulldailyCapinteger | nullcapDefaultintegercapMaxintegerlimitsobjectThe platform's length limits.
limits
POSTintegerREPLYinteger
todayintegerPublished today.
scheduledintegerApproved and waiting.
voiceMatterhornVoicevoice
reportobjectreport
namestringThe weekly Social report's name.
runsintegerWhat one weekly Social report weighs, in Runs, said before it runs.
scheduleany ofschedule
- null
whenstring | nullThe schedule in words ("Every Monday at 06:00").
timezonestring | nullThe routine's time zone.
pausedboolean | nullWhether the routine is paused; null where there is none yet.
nextRunAtstring | nullWhen it runs next.
lastobject | nullThe last one, if any.
last
runIdstringThe Run.
statusstringIts status.
atstring (date-time)When it started.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
PATCH/v1/matterhorn/voiceSave the brand voicePerson
No API key can call this. It needs a person, signed in.
Save the brand voice (owner or admin): how the company sounds, the language and register it posts in, its own terms, and the words it never uses. A new version; Matterhorn is held to it and never edits it.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request body
voicestringHow the company sounds; 1,200 characters at most.
localeenumThe language it posts in.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"registerenum"formal"·"informal"glossaryarray of any ofIts own terms: a term, or
{ term, translations }.glossary
- string
- object
termstringkeepbooleanKept exactly as written in every language.
translationsmap of stringBy language.
avoidarray of stringWords it never uses: 40 at most, 60 characters each.
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Matterhorn is not switched on for this company (
agent_matterhorn). - 429Every failure has this shape.
PATCH/v1/matterhorn/channels/{channel}Set a Matterhorn channel's switch or daily capPerson
No API key can call this. It needs a person, signed in.
Switch a channel (X or LINKEDIN) off or on, or set its daily cap (owner or admin). Off is the company’s kill switch for that channel: posts approved and waiting on it are withdrawn and nothing is published there until it is switched back on.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
channelpathstring
Request body
pausedbooleanOff is the company's kill switch: posts approved and waiting on it are withdrawn.
dailyCapinteger | null1 to 20 on X, 1 to 10 on LinkedIn; null for the default (5 on X, 2 on LinkedIn).
Responses
200Success
channelenum"X"·"LINKEDIN"pausedbooleandailyCapinteger | nullwithdrawnintegerPosts withdrawn by switching it off.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Matterhorn is not switched on for this company (
agent_matterhorn). - 404No such channel.
- 429Every failure has this shape.
POST/v1/matterhorn/posts/{id}/cancelWithdraw an approved post before it is publishedPerson
No API key can call this. An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
Withdraw a post you approved before it is published (the person who approved it, the owner or an admin). It is then never published.
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Responses
200Success
idstringAn id.
statusenum"CANCELLED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things. Only the person who approved it, the owner or an admin.
- 404No such post.
- 409It is being published now, is not scheduled, or changed meanwhile.
- 429Every failure has this shape.
Zermatt: people Coming online
Zermatt's roles, candidates, interviews and contract packs. Zermatt never decides about a candidate.
POST/v1/zermatt/candidatesAdd a candidatePerson
No API key can call this. It needs a person, signed in.
Add a candidate the company was given: name, email, the language they read, country, time zone, how they came (UPLOAD, MANUAL, REFERRAL) and their CV uploaded to the company (cvDocumentId, Sealed). Never found on the web. Kept until the company’s retention runs out.
AccessA person, signed in. No API key can call this.
Operationdocuments.write
Request bodyrequired
roleIdstringThe role they applied for.
namestringAs they gave it; 2 to 120 characters.
emailstring (email)localeenumThe language they read; English by default.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"countrystringTwo letters.
timezonestringAn IANA time zone, like Europe/Zurich.
sourceenumUPLOADby default."UPLOAD"·"MANUAL"·"REFERRAL"cvDocumentIdstringTheir CV, uploaded to this company.
Responses
200Success
idstringThe candidate.
retainUntilstring (date-time)Kept until then, under the company's retention.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Zermatt is not switched on for this company (
agent_zermatt). - 429Every failure has this shape.
GET/v1/zermatt/peopleRead Zermatt's People pagePerson
No API key can call this. It needs a person, signed in.
The People page: roles as the company wrote them, candidates it gave Zermatt (each stage set by a person), interviews, contract packs, the hiring settings (working hours, interview length, retention) and the weekly Hiring pipeline with its weight (3 Runs). Zermatt never decides about a candidate.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
onShiftbooleantimezonestringThe company's zone.
calendarConnectedbooleanGoogle Workspace or Microsoft 365 is connected (busy times are read).
sendingDomainstring | nullThe sending domain's status.
rolesarray of object50 at most, newest first.
roles
idstringAn id.
titlestringcountrystringkindenum"EMPLOYEE"·"CONTRACTOR"statusenum"OPEN"·"PAUSED"·"CLOSED"locationstring | nullinterviewMinutesintegerdocumentIdstring | nullAn id.
createdAtstring (date-time)countsmap of integerCandidates by stage.
candidatesarray of object300 at most, newest first.
candidates
idstringAn id.
roleIdstringAn id.
namestring | nullNull once erased.
emailstring | nullNull once erased.
localestringcountrystring | nulltimezonestring | nullstageenum"NEW"·"SHORTLISTED"·"INTERVIEWING"·"ON_HOLD"·"NOT_PROGRESSED"·"HIRED"·"WITHDRAWN"stageAtstring | nullsourceenum"UPLOAD"·"MANUAL"·"REFERRAL"cvbooleannotesintegerstopContactbooleanretainUntilstring (date-time)erasedbooleancreatedAtstring (date-time)assessmentobject | nullThe latest assessment.
assessment
fitenum"STRONG"·"PARTIAL"·"UNCLEAR"proposedbooleanstatusenum"PROPOSED"·"TAKEN"·"DECLINED"approvalIdstring | nullAn id.
atstring (date-time)
interviewsarray of objectFrom two weeks ago on.
interviews
idstringAn id.
candidateIdstringAn id.
candidatestringroleIdstringAn id.
approvalIdstringAn id.
startsAtstring (date-time)endsAtstring (date-time)timezonestringcompanyTimezonestringformatstringVIDEO,PHONEorONSITE.statusenum"PROPOSED"·"INVITED"·"SENT"·"CANCELLED"·"REFUSED"busyCheckedboolean
packsarray of objectContract packs, 30 at most.
packs
idstringAn id.
approvalIdstringAn id.
candidateIdstring | nullAn id.
roleIdstring | nullAn id.
countrystringkindenum"EMPLOYEE"·"CONTRACTOR"titlestringneedsReviewbooleanreviewFlagsintegerHow many points are for counsel.
statusenum"PROPOSED"·"APPROVED"·"DECLINED"titlisDocumentIdstring | nullAn id.
titlisQueuedAtstring | nulltemplateVersionstringcreatedAtstring (date-time)candidatestring | null
settingsobjectsettings
workingDaysarray of integer1 (Monday) to 7.
dayStartstringHH:MM
dayEndstringHH:MM
interviewMinutesintegerretentionDaysintegersavedbooleanretentionBoundsobjectretentionBounds
minintegermaxinteger
pipelineobjectpipeline
namestringThe weekly Hiring pipeline's name.
runsintegerWhat one weekly Hiring pipeline weighs, in Runs, said before it runs.
scheduleany ofschedule
- null
whenstring | nullThe schedule in words ("Every Monday at 06:00").
timezonestring | nullThe routine's time zone.
pausedboolean | nullWhether the routine is paused; null where there is none yet.
nextRunAtstring | nullWhen it runs next.
countriesarray of stringCountries contract packs are made for.
templatesarray of objecttemplates
idstringcountrystringkindstringtitlestringversionstringneedsReviewboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Zermatt is not switched on for this company (
agent_zermatt). - 429Every failure has this shape.
POST/v1/zermatt/rolesAdd a rolePerson
No API key can call this. It needs a person, signed in.
Add a role (owner or admin): its title, job description (or an uploaded file, documentId), country, EMPLOYEE or CONTRACTOR, place and interview length.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request bodyrequired
titlestring2 to 140 characters.
descriptionstringThe job description; 12,000 characters at most.
countrystringTwo letters, like CH, EE or AE.
kindenumEMPLOYEEby default."EMPLOYEE"·"CONTRACTOR"locationstring200 characters at most.
interviewMinutesinteger15 to 240; 45 by default.
documentIdstringAn uploaded job description, instead of or beside the typed one.
Responses
200Success
idstringThe role.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Zermatt is not switched on for this company (
agent_zermatt). - 429Every failure has this shape.
PATCH/v1/zermatt/settingsSave the hiring settingsPerson
No API key can call this. It needs a person, signed in.
The hiring settings (owner or admin): interview days (1 Monday … 7 Sunday) and hours in the company’s zone, interview length, and how many days a candidate is kept after the last change (30 to 730).
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request body
workingDaysarray of integerInterview days, 1 (Monday) to 7; at least one.
dayStartstringHH:MM, before dayEnd.
dayEndstringHH:MM.
interviewMinutesinteger15 to 240.
retentionDaysintegerHow long candidates are kept: 30 to 730 days. A shorter one applies to everyone at once.
Responses
200Success
workingDaysarray of integerdayStartstringdayEndstringinterviewMinutesintegerretentionDaysinteger
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Zermatt is not switched on for this company (
agent_zermatt). - 429Every failure has this shape.
PATCH/v1/zermatt/roles/{id}Open, pause or close a rolePerson
No API key can call this. It needs a person, signed in.
Open, pause or close a role (owner or admin).
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Request bodyrequired
statusenum"OPEN"·"PAUSED"·"CLOSED"
Responses
200Success
idstringAn id.
statusenum"OPEN"·"PAUSED"·"CLOSED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Zermatt is not switched on for this company (
agent_zermatt). - 404No such role.
- 429Every failure has this shape.
POST/v1/zermatt/candidates/{id}/eraseErase a candidatePerson
No API key can call this. It needs a person, signed in.
Erase a candidate now (owner or admin): notes, assessments and CV deleted, name and address gone, anything waiting withdrawn.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Responses
200Success
idstringAn id.
erasedenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin.
- 404No such candidate.
- 409The candidate was already erased.
- 429Every failure has this shape.
POST/v1/zermatt/candidates/{id}/notesAdd a note about a candidatePerson
No API key can call this. It needs a person, signed in.
Write a note about a candidate (NOTE, SCREENING or INTERVIEW): an artefact Zermatt’s assessments may cite.
AccessA person, signed in. No API key can call this.
Operationdocuments.write
Parameters
idpathstring
Request bodyrequired
bodystring3 to 4,000 characters.
kindenumNOTEby default."NOTE"·"SCREENING"·"INTERVIEW"
Responses
200Success
idstringThe note.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Zermatt is not switched on for this company (
agent_zermatt). - 404No such candidate.
- 409The candidate was erased.
- 429Every failure has this shape.
POST/v1/zermatt/candidates/{id}/stageSet a candidate's stagePerson
No API key can call this. It needs a person, signed in.
Move a candidate to a stage, as your decision, recorded as yours (SHORTLISTED, INTERVIEWING, ON_HOLD, NOT_PROGRESSED, HIRED, WITHDRAWN). Zermatt never moves anyone.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Request bodyrequired
stageenumSet by a person, recorded as theirs. Out of the process, a waiting invitation is withdrawn.
"SHORTLISTED"·"INTERVIEWING"·"ON_HOLD"·"NOT_PROGRESSED"·"HIRED"·"WITHDRAWN"
Responses
200Success
idstringAn id.
stagestring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Zermatt is not switched on for this company (
agent_zermatt). - 404No such candidate.
- 409The candidate was erased.
- 429Every failure has this shape.
POST/v1/zermatt/candidates/{id}/stopStop contacting a candidatePerson
No API key can call this. It needs a person, signed in.
The candidate asked not to be contacted: nothing is ever sent to them again, and whatever waits for them is withdrawn.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Responses
200Success
idstringAn id.
stopContactenumtruewithdrawnintegerInvitations withdrawn.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Zermatt is not switched on for this company (
agent_zermatt). - 404No such candidate.
- 409The candidate was erased.
- 429Every failure has this shape.
POST/v1/zermatt/interviews/{id}/cancelWithdraw an interview invitation before it is sentPerson
No API key can call this. An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
Withdraw an interview invitation before it is sent. A sent one is changed by writing to the candidate yourself.
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Responses
200Success
idstringAn id.
statusenum"CANCELLED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
- 404No such interview.
- 409It was already sent, is being sent, or is no longer waiting.
- 429Every failure has this shape.
GET/v1/zermatt/interviews/{id}/icsDownload an interview's calendar invitePerson
No API key can call this. It needs a person, signed in.
An interview’s calendar invite (the same .ics the candidate gets), as the file itself (text/calendar, a download named interview.ics), for you to add to your own calendar. Zermatt writes into no calendar.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Parameters
idpathstring
Responses
text/calendar.- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Zermatt is not switched on for this company (
agent_zermatt). - 404No such interview, or no invitation was made for it.
- 429Every failure has this shape.
Kesch: collections Coming online
Kesch's collections queue, replies from debtors, and the debtor portal.
GET/v1/portalRead the debtor portal settingsPerson
No API key can call this. It needs a person, signed in.
The debtor portal: whether it is on, its subdomain with the CNAME to publish and its status at Cloudflare, its colour and logo, and the last 30 days of visits, payments after a visit and plans proposed.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200The portal's subdomain, look and analytics; { "available": false } where the debtor portal is not switched on.
any of
- object Where the agent is not switched on for the company.
availableenumfalse
- object
availableenumtruehostnamesConfiguredbooleanCustom hostnames (Cloudflare for SaaS) are set up on this deployment.
cnameTargetstring | nullWhat the subdomain's CNAME points to.
sendingVerifiedbooleansendingDomainstring | nullportalKeschPortalSettingsportal
analyticsobjectThe last 30 days.
analytics
daysintegervisitsintegerpayClicksintegerpaidAfterVisitintegerpaymentsReportedintegerplansProposedintegerdisputesintegerstopsintegerbillingobjectbilling
sessionsintegerrunsChargedintegercarriedintegerSessions not yet charged.
sessionsPerRuninteger
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
PATCH/v1/collections/settingsSet what Kesch's letters may sayPerson
No API key can call this. It needs a person, signed in.
What Kesch’s letters may say beyond the fixed words, off by default: B2B late-payment compensation and the interest rate, a sentence about legal steps per stage; and the hand-off threshold. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request body
lateCompensationbooleanB2B late-payment compensation in the letters.
interestPctnumber | nullStatutory interest, a percentage a year from 0 to 30; null clears it.
legalStagesarray of enumThe stages whose letter may carry the one legal sentence.
thresholdMinorinteger | nullThe hand-off threshold, more than 0; null clears it.
thresholdCurrencystringThree letters, with
thresholdMinor.
Responses
200Success
changedarray of stringThe settings changed.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Kesch is not switched on for this company (
agent_kesch). - 429Every failure has this shape.
PATCH/v1/contacts/{id}Set a contact's sending detailsPerson
No API key can call this. It needs a person, signed in.
A contact’s sending details: never contact again (stop), country, time zone, consumer.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Request body
stopbooleanNever contact again: whatever waits to go to them is refused.
countrystring | nullTwo letters; empty clears it.
timezonestring | nullAn IANA time zone; empty clears it.
consumerbooleanA consumer: Zuger sends to businesses only.
Responses
200Success
idstringThe contact.
stopbooleanSaid back when
stopwas sent.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 404No such contact.
- 429Every failure has this shape.
GET/v1/kesch/callsRead Kesch’s callsruns:read
Kesch’s calls: the settings, the add-on and this month’s minutes, whether calls can start here, the countries (read only, from the allow-list), the last batches Kesch proposed (each approved with a passkey) and the last calls with their results.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Responses
200Success
settingsobjectsettings
enabledbooleanhoursFromstringHH:MM in the debtor’s own time zone.
hoursTostringnumberstring | nullThe company’s own number, E.164.
numberVerifiedbooleanlocalesarray of enum
addonobjectaddon
activebooleanonSalebooleanThe add-on’s price is set up at Stripe (the owner’s step).
priceMinorintegerEUR cents a month.
currencystringincludedMinuteUnitsintegerweightsmap of integerUnits a minute takes, by line class.
overageMinorintegerusedUnitsintegeroverageMinutesinteger
readyobjectready
providersbooleanratesbooleanEvery provider rate a call needs is read and inside the 75% margin.
countriesbooleanAt least one country is enabled after counsel’s sign-off.
consumersboolean
countriesarray of objectcountries
codestringnamestringenabledbooleancounselSignedOffboolean
languagesarray of enumbatchesarray of objectbatches
idstringAn id.
statusenum"PROPOSED"·"APPROVED"·"REJECTED"·"EXPIRED"·"CANCELLED"·"DONE"approvalIdstring | nullAn id.
sizeintegercreatedAtstring (date-time)decidedAtstring | nullretryboolean
callsarray of objectThe last 50.
calls
idstringAn id.
batchIdstringAn id.
chaseIdstringAn id.
invoiceIdstringAn id.
contactIdstringAn id.
countrystringISO 3166-1 alpha-2.
localeenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"consumerbooleandestinationClassenum"STANDARD"·"EXPENSIVE_MOBILE"statusenum"PLANNED"·"QUEUED"·"DIALING"·"IN_PROGRESS"·"COMPLETED"·"VOICEMAIL"·"NO_ANSWER"·"BUSY"·"FAILED"·"REFUSED"·"CANCELLED"outcomeenum"promise_to_pay"·"dispute"·"hardship"·"already_paid"·"stop_contact"·"other"·"objection"·"voicemail"·"handoff"·nullattemptintegerscheduledForstring | nulldialedAtstring | nullendedAtstring | nulldurationSecinteger | nullrefusedReasonstring | nullWhy the rules refused it the moment before dialling, as a code.
failureCodestring | nullreplyIdstring | nullAn id.
purgedbooleanThe retention ended: the recording, the transcript and the number are gone.
createdAtstring (date-time)hasRecordingbooleancanRetryboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. - 404With
kesch_calls(oragent_kesch) off for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kesch/calls \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/kesch/queueList Kesch's collections queueruns:read
Kesch’s queue: the overdue accounts handed to Kesch, ranked by amount, age and behaviour, with the ones at risk, the chase stage and the next step; and the Collections sweep with its weight (5 Runs).
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Responses
200Success
onShiftbooleansweepobjectsweep
namestringrunsintegerThe Collections sweep weighs 5 Runs.
readyBystringThe time its batch is back by ("08:00").
whenstring | nulltimezonestring | nullpausedboolean | nullnextRunAtstring | nulllastobject | nulllast
runIdstringThe Run.
statusstringIts status.
atstring (date-time)When it started.
repliesIncludedbooleanA sweep in the last 72 hours includes a reply's draft; otherwise a reply's draft weighs 1 Run.
settingsobjectsettings
lateCompensationbooleaninterestPctnumber | nulllegalStagesarray of enumthresholdobject | nullThe hand-off threshold.
threshold
minorintegerAn amount in the currency's minor unit (cents).
currencystring
accountsarray of KeschAccountAt risk first, then by score.
accounts
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Kesch is not switched on for this company (agent_kesch). - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kesch/queue \
-H "Authorization: Bearer $ZUGER_KEY"PATCH/v1/portal/brandSet the portal's colour and footerPerson
No API key can call this. It needs a person, signed in.
The portal’s colour (#RRGGBB) and whether its footer says “Powered by Zuger”. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request body
colourstring | null#RRGGBB; empty or null clears it.
poweredBybooleanThe footer says "Powered by Zuger".
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. The debtor portal is not switched on for this company.
- 429Every failure has this shape.
POST/v1/portal/hostnameAdd the portal's subdomainPerson
No API key can call this. It needs a person, signed in.
Add the portal’s subdomain (pay.example.com) as a custom hostname. Answers the CNAME to publish. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request bodyrequired
hostnamestringThe subdomain, like pay.example.com.
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. The debtor portal is not switched on for this company.
- 409The company already has a subdomain, or the hostname is in use.
- 429Every failure has this shape.
- 502Cloudflare could not be reached.
- 503Custom hostnames are not set up on this deployment.
DELETE/v1/portal/hostnameRemove the portal's subdomainPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Responses
200Success
removedenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin.
- 404There is no subdomain to remove.
- 429Every failure has this shape.
POST/v1/portal/logoUpload the portal's logoPerson
No API key can call this. It needs a person, signed in.
The portal’s logo: a PNG, JPEG or WebP of at most 256 KB, as base64. Its type is decided from the file’s first bytes; mimeType is accepted and not used. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request bodyrequired
mimeTypestringAccepted and not used: the type is decided from the file's first bytes (PNG, JPEG or WebP; never SVG), whatever this says.
datastringThe file as base64 (a data: URL prefix is allowed); 256 KB at most.
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. The debtor portal is not switched on for this company.
- 429Every failure has this shape.
DELETE/v1/portal/logoRemove the portal's logoPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin.
- 404There is no logo to remove.
- 429Every failure has this shape.
GET/v1/receivables/agingRead accounts-receivable agingPerson
No API key can call this. It needs a person, signed in.
AR aging over the synced receivables: buckets by days overdue and a total per debtor, per currency.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
asOfstringWhen it was worked out.
totalsarray of objectPer currency, never converted.
totals
currencystringtotalDueMinorintegerAn amount in the currency's minor unit (cents).
overdueMinorintegerAn amount in the currency's minor unit (cents).
bucketsobjectAmounts due by days overdue, in minor units.
buckets
currentintegerd1_30integerd31_60integerd61_90integerd90_plusinteger
debtorsarray of objectPer debtor and currency, the largest overdue first.
debtors
keystringcontactSourceIdstring | nullcontactNamestring | nullcurrencystringtotalDueMinorintegerAn amount in the currency's minor unit (cents).
overdueMinorintegerAn amount in the currency's minor unit (cents).
invoicesintegeroldestDaysOverdueintegerbucketsobjectAmounts due by days overdue, in minor units.
buckets
currentintegerd1_30integerd31_60integerd61_90integerd90_plusinteger
invoicesarray of objectinvoices
idstringAn id.
numberstring | nulldaysOverdueintegerbucketenum"current"·"d1_30"·"d31_60"·"d61_90"·"d90_plus"amountDueMinorintegerAn amount in the currency's minor unit (cents).
currencystring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. AR aging is not switched on for this company (
invoice_chase). - 429Every failure has this shape.
POST/v1/chases/{id}/repliesRecord a debtor's replyPerson
No API key can call this. It needs a person, signed in.
Record a debtor’s reply on a chase: the words pasted, or what it was (promise_to_pay, dispute, hardship, already_paid, stop_contact, other). Kesch acts on it and drafts the next step for your approval; nothing is sent without a Release.
AccessA person, signed in. No API key can call this.
Operationcollections.write
Parameters
idpathstring
Request body
textstringThe reply as pasted; 4,000 characters at most.
replyClassenumWhat it was; a marked class wins over the reading of the words.
"promise_to_pay"·"dispute"·"hardship"·"already_paid"·"stop_contact"·"other"promisedBystring (date)For a promise to pay: the date they will pay by.
sourceenumOnly a person records a reply for now.
"MANUAL"
Responses
201Success
idstringThe reply.
replyClassenum"promise_to_pay"·"dispute"·"hardship"·"already_paid"·"stop_contact"·"other"confidencenumberclassifiedByenum"PERSON"·"KESCH"detectedLocalestring | nullpromisedBystring | nullnextStepstringnextByenum"kesch"·"saentis"·"you"runsintegerWhat its draft weighs: 0 when a sweep of the last 72 hours includes it, else 1.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Kesch (or the invoice chase) is not switched on for this company.
- 404No such chase.
- 409The chase is closed.
- 429Every failure has this shape.
POST/v1/chases/{id}/resumeResume a paused chasePerson
No API key can call this. It needs a person, signed in.
Take a paused chase of Kesch’s up again (a dispute resolved): it goes on from the stage it was at.
AccessA person, signed in. No API key can call this.
Operationcollections.write
Parameters
idpathstring
Responses
200Success
idstringAn id.
stagestring | nullThe stage it goes on from.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Kesch is not switched on for this company (
agent_kesch). - 404No such chase.
- 409Not paused, or changed meanwhile.
- 429Every failure has this shape.
POST/v1/kesch/calls/numberVerify your company’s own numberPerson
No API key can call this. It needs a person, signed in.
The company’s own number as the caller ID of every call: the phone line calls it and the person types the code it answers with. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request bodyrequired
numberstringE.164, like +41441234567.
Responses
200Success
numberstringcodestringThe code to type when the phone line calls the number.
- 400Not a number with its country code.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin.
- 404With
kesch_calls(oragent_kesch) off for the company, every one of these paths answers 404, as an unknown path does. - 409Calls are not set up on this deployment.
- 429Every failure has this shape.
PATCH/v1/kesch/calls/settingsChange Settings → Kesch callsPerson
No API key can call this. It needs a person, signed in.
Settings → Kesch calls: on or off (needs the company’s own number verified), the calling hours (inside each country’s), the languages. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request bodyrequired
enabledbooleanhoursFromstringHH:MM.
hoursTostringHH:MM.
localesarray of enumAt least one; all eight for all.
Responses
200Success
changedarray of string
- 400Hours that are not a start before an end, or no language.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin.
- 404With
kesch_calls(oragent_kesch) off for the company, every one of these paths answers 404, as an unknown path does. - 409Switching on before the company’s own number is verified.
- 429Every failure has this shape.
GET/v1/kesch/calls/{id}Read one callruns:read
One call of Kesch’s: its result, the transcript, a hand-off’s summary and what the phone line reported.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
idpathstring
Responses
200Success
idstringAn id.
batchIdstringAn id.
chaseIdstringAn id.
invoiceIdstringAn id.
contactIdstringAn id.
countrystringISO 3166-1 alpha-2.
localeenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"consumerbooleandestinationClassenum"STANDARD"·"EXPENSIVE_MOBILE"statusenum"PLANNED"·"QUEUED"·"DIALING"·"IN_PROGRESS"·"COMPLETED"·"VOICEMAIL"·"NO_ANSWER"·"BUSY"·"FAILED"·"REFUSED"·"CANCELLED"outcomeenum"promise_to_pay"·"dispute"·"hardship"·"already_paid"·"stop_contact"·"other"·"objection"·"voicemail"·"handoff"·nullattemptintegerscheduledForstring | nulldialedAtstring | nullendedAtstring | nulldurationSecinteger | nullrefusedReasonstring | nullWhy the rules refused it the moment before dialling, as a code.
failureCodestring | nullreplyIdstring | nullAn id.
purgedbooleanThe retention ended: the recording, the transcript and the number are gone.
createdAtstring (date-time)hasRecordingbooleancanRetrybooleantranscriptstring | nullWhat Kesch said and what was heard, line by line.
summarystring | nullA hand-off’s summary for a person.
retentionUntilstring | nulleventsarray of objectevents
kindstringatstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. - 404No such call in this company. With
kesch_calls(oragent_kesch) off for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kesch/calls/{id} \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/portal/hostname/checkCheck the portal's subdomain at CloudflarePerson
No API key can call this. It needs a person, signed in.
Ask Cloudflare where the subdomain and its certificate are now.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Responses
200Success
hostnamestring | nullThe portal's subdomain.
statusstringThe hostname's status at Cloudflare (
none,pending,active, …).sslStatusstring | nullIts certificate's status.
activebooleanThe hostname and its certificate are active: the portal answers.
recordsarray of objectWhat to publish in DNS.
records
typeenum"CNAME"·"TXT"namestringvaluestringpurposeenum"route"·"ownership"·"certificate"
urlstring | nullThe portal, once active.
brandColourstring | null#RRGGBB
logoobject | nulllogo
typestring | nullIts media type.
versionstring | nullA short hash of it.
poweredBybooleanThe footer says "Powered by Zuger".
lastCheckedAtstring | nullactiveAtstring | nullerrorsarray of stringWhat Cloudflare says is wrong, if anything.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. The debtor portal is not switched on for this company.
- 404No subdomain added yet.
- 429Every failure has this shape.
- 502Cloudflare could not be reached.
- 503Custom hostnames are not set up on this deployment.
PATCH/v1/kesch/calls/contacts/{id}Set a debtor’s number for callsPerson
No API key can call this. It needs a person, signed in.
A debtor’s number for Kesch’s calls, the kind of line, whether they asked not to be called at work, and the date the company recorded their prior consent to an automated call. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Request bodyrequired
phonestring | nullE.164.
phoneTypeenum"MOBILE"·"LANDLINE"·"WORK"·"UNKNOWN"·nullcallsAtWorkRefusedbooleancallConsentAtstring | nullWhen the company recorded the debtor’s prior consent to an automated call.
Responses
200Success
changedarray of string
- 400A number without its country code, a line kind not one of the four, or a consent date in the future.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin.
- 404No such contact. With
kesch_calls(oragent_kesch) off for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/kesch/calls/number/checkCheck your number’s verificationPerson
No API key can call this. It needs a person, signed in.
Whether the company’s own number is verified as a caller ID now. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Responses
200Success
verifiedboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin.
- 404With
kesch_calls(oragent_kesch) off for the company, every one of these paths answers 404, as an unknown path does. - 409No number yet, or calls are not set up on this deployment.
- 429Every failure has this shape.
GET/v1/kesch/calls/{id}/recordingPlay a call’s recordingruns:read
A call’s recording, as base64, to play in the Console. Each play is in the audit log.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
idpathstring
Responses
200Success
contentTypestringdatastringThe recording’s bytes, base64.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Not in this company. - 404This call has no recording. With
kesch_calls(oragent_kesch) off for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/kesch/calls/{id}/recording \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/kesch/calls/{id}/retryCall again after a missed callPerson
No API key can call this. It needs a person, signed in.
Call again after a call reached nobody: Kesch proposes it as a batch of one, which a person approves with a passkey before anyone is called.
AccessA person, signed in. No API key can call this.
Operationcollections.write
Parameters
idpathstring
Responses
200Success
idstringAn id.
proposedboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 404No such call in this company. With
kesch_calls(oragent_kesch) off for the company, every one of these paths answers 404, as an unknown path does. - 409The call reached someone, was purged, or is already proposed again.
- 429Every failure has this shape.
Moléson: customer support Coming online
Moléson's conversations with the company's customers, its sources and its channels.
GET/v1/molesonRead the customer support settingsPerson
No API key can call this. It needs a person, signed in.
Settings → Customer support: the sources Moléson answers from (uploads, Notion pages, Drive files, pages of your own website) and how each was read; each channel’s switches (on, your off switch, auto) and whether it is built; the intents auto may answer (FAQ, order status, opening hours, shipping); the web widget’s snippet, allowed origins, name and colour; your own WhatsApp number; and the weight (1 Run for up to 30 turns of a conversation).
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Sources, channels, the widget and the weights; { "available": false } where Moléson is not switched on.
any of
- object Where the agent is not switched on for the company.
availableenumfalse
- object
availableenumtrueonShiftbooleansendingbooleanSending replies is switched on for this deployment.
flagsobjectWhich of Moléson's parts are switched on for the company.
flags
widgetbooleanwhatsappbooleanautobooleanbillingTabboolean
weightsobjectweights
turnsPerRunintegerTurns of a conversation one Run covers (30).
runsinteger
autoIntentsarray of stringThe intents auto may answer.
intentsarray of enumwidgetobjectwidget
keystringThe widget's public key.
originsarray of stringnamestring | nullcolourstring | nullpoweredBybooleanurlstringsnippetstringThe script tag to put on your site.
channelsarray of objectchannels
channelenum"WIDGET"·"WHATSAPP"·"TELEGRAM"·"INSTAGRAM"·"MESSENGER"·"EMAIL"labelstringbuiltbooleanflagbooleanenabledbooleanpausedbooleanpausedAtstring | nullautobooleannotBuiltstringWhy a channel is not built.
whatsappobjectwhatsapp
connectablebooleannumberobject | nullnumber
displaystringverifiedNamestring | nullstatusstringtemplatesobjectThe reply template's review status, by language.
sourcesarray of objectsources
idstringAn id.
kindenum"UPLOAD"·"NOTION"·"DRIVE"·"WEBSITE"refstring | nullThe address, for a website source.
titlestring | nullurlstring | nullstatusenum"PENDING"·"INDEXED"·"FAILED"chunksintegerpagesintegererrorstring | nulllastFetchedAtstring | null
pickobjectWhat can be chosen as a source.
pick
uploadsarray of objectuploads
idstringAn id.
titlestring
notionarray of object | nullnotion
idstringtitlestring | null
drivearray of object | nulldrive
idstringtitlestring | null
domainsarray of stringYour verified domains.
websiteDomainstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
PATCH/v1/molesonChange the customer support settingsPerson
No API key can call this. It needs a person, signed in.
Change Customer support (owner or admin): the intents auto may answer (a subset of faq, order_status, hours, shipping; never money or legal), the origins the widget works on (https, no path), its name, colour and “Powered by Zuger”, and your website’s domain (one of your verified domains) for the website source.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request body
autoIntentsarray of enumWhat auto may answer alone; never money or legal.
widgetOriginsarray of stringhttps origins (no path) the widget works on; 20 at most.
widgetNamestring | null60 characters at most.
widgetColourstring | null#RRGGBB.
widgetPoweredBybooleanwebsiteDomainstring | nullOne of your verified domains, for the website source.
Responses
200Success
autoIntentsarray of stringwidgetOriginsarray of stringwidgetNamestring | nullwidgetColourstring | nullwidgetPoweredBybooleanwebsiteDomainstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Moléson is not switched on for this company (
agent_moleson). - 429Every failure has this shape.
GET/v1/moleson/conversationsList customer conversationsruns:read
The Support inbox: your customers’ conversations (?status=OPEN|ESCALATED|RESOLVED|CLOSED), newest first, each with its channel, language, turns, the last message, drafts waiting and why one is with a person.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
statusqueryOnly conversations in this state; anything else lists all.
Responses
200Success
sendingbooleanconversationsarray of objectNewest activity first; 100 at most.
conversations
idstringAn id.
channelenum"WIDGET"·"WHATSAPP"·"TELEGRAM"·"INSTAGRAM"·"MESSENGER"·"EMAIL"statusenum"OPEN"·"ESCALATED"·"RESOLVED"·"CLOSED"localestring | nullturnsintegerrunsChargedintegerupdatedAtstring (date-time)createdAtstring (date-time)contactobjectcontact
idstringThe customer.
namestring | nulllinkedbooleanLinked to one of your contacts.
lastobject | nulllast
textstringIts first 160 characters.
authorstringatstring (date-time)
draftsintegerDrafts waiting for approval.
escalationstring | nullWhy it is with a person.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Moléson is not switched on for this company (agent_moleson). - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/moleson/conversations \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/moleson/sourcesChoose a source for MolésonPerson
No API key can call this. It needs a person, signed in.
Choose a source for Moléson (owner or admin): an upload ({ kind: UPLOAD, ref: document id }), a Notion page or a Drive file shared with Zuger ({ kind: NOTION | DRIVE, ref: its id }), or a path of your own website ({ kind: WEBSITE, ref: https address on your verified domain }). Its text is read, stored Sealed and indexed, and read again when it changes.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request bodyrequired
kindenum"UPLOAD"·"NOTION"·"DRIVE"·"WEBSITE"refstringA document id, a Notion page or Drive file id, or an https address on your website's domain; 600 characters at most.
Responses
200Success
idstringThe source.
kindenum"UPLOAD"·"NOTION"·"DRIVE"·"WEBSITE"statusstringPENDINGuntil it is read.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Moléson is not switched on for this company (
agent_moleson). - 404No such file, Notion page or Drive file.
- 429Every failure has this shape.
DELETE/v1/moleson/whatsappDisconnect your WhatsApp numberPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Disconnect your WhatsApp number: its token is dropped and replies waiting to go on it are withdrawn.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Responses
200Success
disconnectedenumtruewithdrawnintegerReplies waiting to go on it, withdrawn.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Only the owner or an admin.
- 404No WhatsApp number is connected.
- 429Every failure has this shape.
PATCH/v1/moleson/channels/{channel}Set a customer support channel's switchesPerson
No API key can call this. It needs a person, signed in.
A channel’s switches (WIDGET, WHATSAPP; TELEGRAM, INSTAGRAM, MESSENGER and EMAIL are not built and cannot be switched on), owner or admin: on, your off switch (paused: what waits to be sent there is withdrawn and nothing is sent until it is back), and auto (ADR 0002).
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
channelpathstring
Request body
enabledbooleanOn at all. A channel that is not built cannot be switched on.
pausedbooleanThe company's off switch: what waits to go there is withdrawn.
autobooleanAuto mode (ADR 0002), where
moleson_autois on.
Responses
200Success
channelenum"WIDGET"·"WHATSAPP"·"TELEGRAM"·"INSTAGRAM"·"MESSENGER"·"EMAIL"enabledbooleanpausedbooleanautobooleanwithdrawnintegerReplies withdrawn.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Moléson is not switched on for this company (
agent_moleson). Or the channel, or auto, is not switched on for this company. - 404No such channel.
- 429Every failure has this shape.
GET/v1/moleson/conversations/{id}Read a customer conversationruns:read
One conversation: every message as written (the customer’s, Moléson’s drafts and replies with what each rests on, a person’s), and why it is with a person.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
idpathstring
Responses
200Success
idstringAn id.
channelenum"WIDGET"·"WHATSAPP"·"TELEGRAM"·"INSTAGRAM"·"MESSENGER"·"EMAIL"statusenum"OPEN"·"ESCALATED"·"RESOLVED"·"CLOSED"localestring | nullturnsintegerrunsChargedintegerturnsPerRunintegeroriginstring | nullThe site it came from, for the widget.
escalationobject | nullescalation
atstring (date-time)reasonstring | nullsummarystring | nulllocalestring | null
contactobjectcontact
idstringAn id.
namestring | nulllinkedbooleancontactIdstring | nullAn id.
linkedBystring | nullstoppedbooleanThe customer asked not to be written to again.
messagesarray of MolesonMessageOldest first; 300 at most.
messages
sendingboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Moléson is not switched on for this company (agent_moleson). - 404No such conversation.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/moleson/conversations/{id} \
-H "Authorization: Bearer $ZUGER_KEY"DELETE/v1/moleson/sources/{id}Remove a sourcePerson
No API key can call this. It needs a person, signed in.
Deselect a source: its stored text and index are deleted now.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Responses
200Success
idstringAn id.
statusenum"REMOVED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin.
- 404No such source.
- 429Every failure has this shape.
GET/v1/moleson/whatsapp/callbackFinish connecting a WhatsApp numberPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Where Meta sends you back: the number is connected (its token sealed), Zuger’s app subscribed to its messages, and your reply template submitted in eight languages. Then Settings → Customer support.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Parameters
codequerystringMeta's code.
statequerystringThe state the connect step made.
Responses
- 302Back to the Console's Settings → Customer support, with
?whatsapp=connected,expired,failed,takenor Meta's outcome. - 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Only the owner or an admin.
- 429Every failure has this shape.
POST/v1/moleson/whatsapp/connectConnect your own WhatsApp numberPerson
No API key can call this. Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
Connect your own WhatsApp number through Meta’s Embedded Signup (owner or admin, where moleson_whatsapp is on and Zuger is a Meta Tech Provider): returns Meta’s consent page.
Why no key
Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted.
AccessA person, signed in. No API key can call this.
Operationconnections.write
Responses
200Success
urlstring (uri)Meta's Embedded Signup page.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting a tool grants access to it. That decision belongs to a person who can see what is being granted. Only the owner or an admin. Moléson or its WhatsApp is not switched on for this company, or this deployment cannot connect a company's number yet.
- 429Every failure has this shape.
POST/v1/moleson/contacts/{id}/linkLink a customer to one of your contactsPerson
No API key can call this. It needs a person, signed in.
Link a customer to one of your contacts (owner or admin), so Moléson can read their order status and hand a payment question to Kesch; null unlinks. Never done from what a customer typed.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Request bodyrequired
contactIdstring | nullThe contact; null or empty unlinks.
Responses
200Success
idstringThe customer.
contactIdstring | nullAn id.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Only the owner or an admin. Moléson is not switched on for this company (
agent_moleson). - 404No such customer, or no such contact.
- 429Every failure has this shape.
GET/v1/moleson/contacts/{id}/timelineRead a customer's timelineruns:read
One timeline per customer: everything said to them by Moléson, a person, and (where linked to a contact) Kesch, oldest first, and the hand-offs between agents.
AccessAn API key with the scope runs:read, or a person signed in.
Operationruns.read
Parameters
idpathstring
Responses
200Success
contactobjectcontact
idstringAn id.
namestring | nullchannelenum"WIDGET"·"WHATSAPP"·"TELEGRAM"·"INSTAGRAM"·"MESSENGER"·"EMAIL"linkedbooleanlocalestring | null
eventsarray of any ofOldest first: messages, hand-offs and, where linked to a contact, Kesch's letters.
events
- object
atstring (date-time)kindenum"message"channelstringconversationIdstringAn id.
authorstringstatusstringtextstringmodestring | null
- object
atstring (date-time)kindenum"handoff"fromstringThe agent it came from.
tostringThe agent it went to.
reasonstring | nullconversationIdstring | nullAn id.
- object
atstring (date-time)kindenum"letter"authorstring | nullThe agent that drafted it.
statusstringtextstringThe letter's subject.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
runs:readscope. Moléson is not switched on for this company (agent_moleson). - 404No such customer.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/moleson/contacts/{id}/timeline \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/moleson/conversations/{id}/hand-backHand a conversation back to MolésonPerson
No API key can call this. It needs a person, signed in.
Hand a conversation that is with a person back to Moléson: it answers the customer’s next message.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Responses
200Success
idstringAn id.
statusenum"OPEN"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Moléson is not switched on for this company (
agent_moleson). - 404No such conversation.
- 429Every failure has this shape.
POST/v1/moleson/conversations/{id}/replyReply to a customer yourselfPerson
No API key can call this. An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
Reply to the customer yourself: your words, sent on the channel they wrote from after Bernina checks them. Never by a key.
Why no key
An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things.
AccessA person, signed in. No API key can call this.
Operationapprovals.decide
Parameters
idpathstring
Request bodyrequired
textstringYour words; 4,000 characters at most.
Responses
200Success
idstringThe message.
statusenum"RELEASED"sendingbooleanSending is switched on for this deployment.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An approval is resolved with a passkey, by a person, within two minutes of being asked. A key in a CI environment is none of those things. Moléson is not switched on for this company (
agent_moleson). - 404No such conversation.
- 409The customer asked not to be written to again.
- 429Every failure has this shape.
POST/v1/moleson/conversations/{id}/resolveMark a conversation resolvedPerson
No API key can call this. It needs a person, signed in.
Mark a conversation resolved. The customer’s next message starts a new one.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Responses
200Success
idstringAn id.
statusenum"RESOLVED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Moléson is not switched on for this company (
agent_moleson). - 404No such conversation.
- 429Every failure has this shape.
Zuger Store
Agents, skills and packs to hire, and selling your own.
GET/v1/marketplaceBrowse the Zuger Storemarketplace:read
AccessAn API key with the scope marketplace:read, or a person signed in.
Operationmarketplace.read
Responses
200Success
listingsarray of StoreListingPacks, agents and skills, newest first in each kind.
listings
hiresarray of StoreHireWhat this company hired and has not let go of.
hires
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
marketplace:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/marketplace \
-H "Authorization: Bearer $ZUGER_KEY"GET/v1/payoutsRead whether this company can be paid for what it sellsmarketplace:read
Whether this company can be paid for what it sells, and the share it keeps.
AccessAn API key with the scope marketplace:read, or a person signed in.
Operationmarketplace.read
Responses
200Success
availablebooleanStripe is configured on this deployment.
feePercentnumberZuger's commission, in percent.
sellerKeepsPercentnumberWhat the seller keeps, in percent.
heldbooleanZuger has put the seller on hold: its listings are off the shelf and nothing is paid out.
startedbooleanStripe's onboarding was begun.
readybooleanStripe has the details and transfers are active: priced listings can be sold.
payoutsEnabledbooleanStripe pays out to the seller's bank.
dueintegerHow many details Stripe still asks for.
countrystring | nullThe seller account's country.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
marketplace:readscope. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/payouts \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/marketplace/listingsPublish a listing on the Zuger StorePerson
Why no key
Publishing a listing is customer-facing. A person publishes it.
AccessA person, signed in. No API key can call this.
Operationmarketplace.write
Request bodyrequired
kindenum"SKILL"·"AGENT"·"PACK"namestring2 to 80 characters.
blurbstringWhat it does: 10 to 400 characters.
itemIdsarray of stringA pack: two to eight of your own live agents and skills.
priceMinorintegerCents a month: 0 (free, the default) or 100 to 100,000.
minimum0· maximum100000agentKindstringAn agent listing: the kind of agent it goes on shift as.
currencyenumListings are priced in euro.
"EUR"
Responses
201Success
idstringAn id.
kindenum"SKILL"·"AGENT"·"PACK"namestringstatusenum"LISTED"·"PAUSED"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Publishing a listing is customer-facing. A person publishes it. Only the owner or an admin can publish, the email address is not confirmed, the seller is on hold, or a priced listing needs payouts set up first.
- 409Zuger has paused the Store for now (
paused_by_zuger). - 429Every failure has this shape.
POST/v1/payouts/dashboardOpen the seller's Stripe dashboardPerson
No API key can call this. Publishing a listing is customer-facing. A person publishes it.
A one-time link into the seller's Stripe Express dashboard. Owner only.
Why no key
Publishing a listing is customer-facing. A person publishes it.
AccessA person, signed in. No API key can call this.
Operationmarketplace.write
Responses
200Success
urlstring (uri)A one-time link into the seller's Stripe Express dashboard.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Publishing a listing is customer-facing. A person publishes it. Only the owner can change what the company pays.
- 429Every failure has this shape.
POST/v1/payouts/startSet up payouts for sellingPerson
No API key can call this. Publishing a listing is customer-facing. A person publishes it.
A one-time link to Stripe's own onboarding for sellers. Owner only.
Why no key
Publishing a listing is customer-facing. A person publishes it.
AccessA person, signed in. No API key can call this.
Operationmarketplace.write
Request body
countrystringThe seller's country, two letters (EE, DE…). Needed the first time.
Responses
200Success
urlstring (uri)Stripe's own onboarding page, once.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Publishing a listing is customer-facing. A person publishes it. Only the owner, with a confirmed email address; or Stripe is not configured here.
- 429Every failure has this shape.
DELETE/v1/marketplace/listings/{id}Take a listing downPerson
No API key can call this. Publishing a listing is customer-facing. A person publishes it.
Hires others already made of it are theirs to keep or let go.
Why no key
Publishing a listing is customer-facing. A person publishes it.
AccessA person, signed in. No API key can call this.
Operationmarketplace.write
Parameters
idpathstring
Responses
200Success
unlistedstringAn id.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Publishing a listing is customer-facing. A person publishes it. Only the owner or an admin can do this, or it is part of a live pack of yours.
- 404Not one of your live listings.
- 409Zuger has paused the Store for now (
paused_by_zuger). - 429Every failure has this shape.
POST/v1/marketplace/{id}/hireHire from the Zuger StorePerson
No API key can call this. Hiring from the Zuger Store can cost money. A person does it, or an agent does it inside a run where the gate sees it — never a key.
A free listing starts at once. A priced one is its own monthly charge to the card on file; the bank may ask the person to confirm it.
Why no key
Hiring from the Zuger Store can cost money. A person does it, or an agent does it inside a run where the gate sees it — never a key.
AccessA person, signed in. No API key can call this.
Operationmarketplace.hire
Parameters
idpathstring
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Hiring from the Zuger Store can cost money. A person does it, or an agent does it inside a run where the gate sees it — never a key. The seller is on hold, the plan has no room, or a payment it needs was refused.
- 404Nothing by that id in this company.
- 409Zuger has paused the Store for now (
paused_by_zuger). - 429Every failure has this shape.
DELETE/v1/marketplace/{id}/hireLet a hire goPerson
No API key can call this. Hiring from the Zuger Store can cost money. A person does it, or an agent does it inside a run where the gate sees it — never a key.
Its charge stops at once. An agent it put on shift is paused; its threads and memory stay.
Why no key
Hiring from the Zuger Store can cost money. A person does it, or an agent does it inside a run where the gate sees it — never a key.
AccessA person, signed in. No API key can call this.
Operationmarketplace.hire
Parameters
idpathstring
Responses
200Success
releasedstringThe listing.
pausedstring | nullThe kind of agent paused, if one was.
notestringWhat happened, in a sentence for a person.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Hiring from the Zuger Store can cost money. A person does it, or an agent does it inside a run where the gate sees it — never a key. A paid hire is the owner's to end, anything else the owner's or an admin's; an item that came with a pack goes with the pack.
- 404That is not hired.
- 429Every failure has this shape.
GET/v1/marketplace/{id}/reviewsRead a listing's reviewsmarketplace:read
What people who hired a listing said about it, with its stars.
AccessAn API key with the scope marketplace:read, or a person signed in.
Operationmarketplace.read
Parameters
idpathstring
Responses
200Success
listingIdstringAn id.
namestringratingStoreRatingStars from people whose company hired the listing (hidden reviews not counted).
rating
canModeratebooleanZuger only.
canReviewbooleanYour company hired it and does not sell it.
canCommentbooleanYour company hired it, or sells it.
reviewsarray of StoreReviewNewest first, fifty at most.
reviews
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
marketplace:readscope. - 404Nothing by that id in this company.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/marketplace/{id}/reviews \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/marketplace/{id}/reviewsReview a listingPerson
No API key can call this. A review is one person saying how it went. A key is not a person, and has hired nothing.
Leave or change your own stars and review. Only for a listing your company hired.
One review per person: sending again changes it.
Why no key
A review is one person saying how it went. A key is not a person, and has hired nothing.
AccessA person, signed in. No API key can call this.
Operationmarketplace.review
Parameters
idpathstring
Request bodyrequired
starsintegerOne to five stars.
minimum1· maximum5commentstringUp to 1,000 characters.
Responses
200Success
idstringAn id.
starsintegercommentstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A review is one person saying how it went. A key is not a person, and has hired nothing. Only someone whose company hired it, who is not in the selling company, with a confirmed email address.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
DELETE/v1/marketplace/{id}/reviewsRemove your reviewPerson
Why no key
A review is one person saying how it went. A key is not a person, and has hired nothing.
AccessA person, signed in. No API key can call this.
Operationmarketplace.review
Parameters
idpathstring
Responses
200Success
removedenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A review is one person saying how it went. A key is not a person, and has hired nothing.
- 404You have not reviewed it.
- 429Every failure has this shape.
GET/v1/marketplace/listings/{id}/verificationRead whether your agent listing is Verifiedmarketplace:read
Whether one of your own agent listings is Verified, why not, and the Verified fee as set.
Verified is live: a seller on hold, a lapsed Stripe check, changed words or a lapsed year take it away at once. The gold tick (sellerVerified on the shelf) still means only that Stripe checked the seller.
AccessAn API key with the scope marketplace:read, or a person signed in.
Operationmarketplace.read
Parameters
idpathstring
Responses
200Success
listingIdstringAn id.
manifestSha256stringSHA-256 of the listing's manifest, 64 hex.
verifiedbooleanwhyenumWhy the listing is or is not Verified now, the first reason.
"verified"·"zuger_own"·"not_applied"·"seller_held"·"kyb_lapsed"·"manifest_changed"·"expired"·"credential_invalid"validUntilstring | nullscanenumBernina's last scan of the listing as it is now.
"PASS"·"BLOCK"·nullsellerVerifiedbooleanStripe has checked the seller (the gold tick).
feeobjectThe Verified fee as configured.
fee
setbooleanThe owner has set the fee. Until then nothing is charged and no listing can be Verified.
currencyenum"EUR"onceMinorinteger | nullThe first year, in cents, before VAT.
yearlyMinorinteger | nullEach renewal, in cents, before VAT.
verifiedForDaysintegerHow long one payment keeps a listing Verified.
- 400Not an agent listing of your own.
- 401Not signed in: no session, or no valid API key.
- 403An API key without the
marketplace:readscope. Not a person signed in. - 404No such listing of yours. With
kya_storeoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
curl https://beta.zuger.ai/v1/marketplace/listings/{id}/verification \
-H "Authorization: Bearer $ZUGER_KEY"POST/v1/marketplace/listings/{id}/verificationApply for Verified on your agent listingPerson
No API key can call this. Publishing a listing is customer-facing. A person publishes it.
Apply for Verified on your own agent listing: Stripe's business check, Bernina's scan, then the Verified fee. Owner only, a person signed in.
In this order, refused at the first that fails with nothing charged: the seller not on hold, Stripe's business check, Bernina's scan, the fee set by Zuger, the card on file. Then the fee is invoiced (once for the first year, yearly to renew) and the listing is Verified for a year.
Why no key
Publishing a listing is customer-facing. A person publishes it.
AccessA person, signed in. No API key can call this.
Operationmarketplace.write
Parameters
idpathstring
Responses
200Verified, or (needsAction) waiting for the bank to confirm the fee.
listingIdstringAn id.
verifiedbooleanvalidUntilstring (date-time)Verified until then.
needsActionbooleanThe bank wants the person to confirm the fee first.
clientSecretstringFor Stripe.js to confirm the invoice's payment in place.
publicKeystring | nullStripe's publishable key.
- 400Not an agent listing of your own, or Verified already until closer to its end.
- 401Not signed in: no session, or no valid API key.
- 403Publishing a listing is customer-facing. A person publishes it. Not the owner, not a person signed in, the seller is on hold, Stripe has not checked the business, Bernina's scan found something, the fee is not set yet, or no card is on file.
- 404No such listing of yours. With
kya_storeoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
POST/v1/marketplace/reviews/{id}/commentsComment under a reviewPerson
No API key can call this. A review is one person saying how it went. A key is not a person, and has hired nothing.
Comment under a review: for companies that hired the listing, and its seller.
Why no key
A review is one person saying how it went. A key is not a person, and has hired nothing.
AccessA person, signed in. No API key can call this.
Operationmarketplace.review
Parameters
idpathstring
Request bodyrequired
bodystring2 to 600 characters.
Responses
200Success
idstringThe comment.
sellerbooleanWritten as the listing's seller.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A review is one person saying how it went. A key is not a person, and has hired nothing. Comments come from companies that hired it and from its seller, five per person per review, with a confirmed email address.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/marketplace/reviews/{id}/hideHide or restore a reviewPerson
No API key can call this. A review is one person saying how it went. A key is not a person, and has hired nothing.
Zuger only: hide a review (not shown, not counted), or with hidden: false put it back and clear its reports.
Why no key
A review is one person saying how it went. A key is not a person, and has hired nothing.
AccessA person, signed in. No API key can call this.
Operationmarketplace.review
Parameters
idpathstring
Request body
hiddenbooleanfalse: put it back and clear its reports. Anything else hides it.
Responses
200Success
idstringAn id.
hiddenboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A review is one person saying how it went. A key is not a person, and has hired nothing. Only Zuger can hide a review or put one back.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/marketplace/reviews/{id}/reportReport a reviewPerson
No API key can call this. A review is one person saying how it went. A key is not a person, and has hired nothing.
Say a review should not be there, and why. Once per person. Three companies' reports hold its text back until Zuger has looked.
Why no key
A review is one person saying how it went. A key is not a person, and has hired nothing.
AccessA person, signed in. No API key can call this.
Operationmarketplace.review
Parameters
idpathstring
Request bodyrequired
reasonenumWhy it should not be there.
"spam"·"abusive"·"not a customer"·"off topic"·"private information"notestringUp to 400 characters.
Responses
200Success
reportedenumtrueheldbooleanIts text is now held back (three companies that hired the listing reported it).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A review is one person saying how it went. A key is not a person, and has hired nothing. Confirm your email address first.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/marketplace/{id}/hire/confirmStart a hire after the bank confirmed its paymentPerson
No API key can call this. Hiring from the Zuger Store can cost money. A person does it, or an agent does it inside a run where the gate sees it — never a key.
After the bank confirmed the payment for a priced hire: start the hire if Stripe says it is paid.
Why no key
Hiring from the Zuger Store can cost money. A person does it, or an agent does it inside a run where the gate sees it — never a key.
AccessA person, signed in. No API key can call this.
Operationmarketplace.hire
Parameters
idpathstring
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Hiring from the Zuger Store can cost money. A person does it, or an agent does it inside a run where the gate sees it — never a key. The payment has not been confirmed, so nothing was hired and nothing was charged.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/marketplace/listings/{id}/verification/confirmFinish Verified after the bank confirmed the feePerson
No API key can call this. Publishing a listing is customer-facing. A person publishes it.
After the bank confirmed the Verified fee: Verified once Stripe says it is paid.
Why no key
Publishing a listing is customer-facing. A person publishes it.
AccessA person, signed in. No API key can call this.
Operationmarketplace.write
Parameters
idpathstring
Responses
200Success
listingIdstringAn id.
verifiedbooleanvalidUntilstring (date-time)Verified until then.
needsActionbooleanThe bank wants the person to confirm the fee first.
clientSecretstringFor Stripe.js to confirm the invoice's payment in place.
publicKeystring | nullStripe's publishable key.
- 400No Verified fee waits to be confirmed for this listing.
- 401Not signed in: no session, or no valid API key.
- 403Publishing a listing is customer-facing. A person publishes it. Not the owner, not a person signed in, or Stripe has not been paid.
- 404No such listing of yours. With
kya_storeoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
Billing
Plans, Runs, invoices and the card on file.
GET/v1/billingRead the plan, usage and billing detailsPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationbilling.read
Responses
200Success
usageBillingUsageRuns and limits now, from the Run ledger.
usage
sellerstringZuger's legal name, the seller of record.
canBillbooleanA checkout can be opened here.
sandboxbooleanStripe runs in test mode: test cards only, no money moves.
blockersarray of stringWhy billing is not open yet, if it is not.
configuredbooleanStripe is configured on this deployment.
providerenum"stripe"publicKeystring | nullStripe's publishable key, to mount Stripe.js; null where it is not configured.
modeenumWhether Stripe runs on test or live keys here; null where Stripe is not configured.
"test"·"live"·nullplansarray of objectEvery plan, priced in the company's billing currency.
plans
codeenumA plan, by its database code: PRE_REVENUE (Free), STARTER, SOLO (Pro), COMPANY (Max), GROUP (Ultra).
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"namestringmonthlyMinorintegerA month, billed monthly, before VAT, in the minor unit of the company's billing currency.
yearlyMinorinteger | nullThe yearly price as a month; null where there is none.
yearlyTotalMinorinteger | nullIn another currency than EUR: the year upfront as it is charged (rounded on its own, so not twelve times
yearlyMinor).currencyenumThe company's billing currency: EUR unless it is billed in another.
"EUR"·"USD"·"CHF"·"GBP"·"AED"limitsBillingPlanLimitsWhat a plan allows. A cap with no limit is null (JSON has no Infinity).
limits
currencyobjectMulti-currency billing: present where
multi_currency_billingis on for the company, or it is billed in another currency than EUR.currency
codeenumThe currency the company is billed in now.
"EUR"·"USD"·"CHF"·"GBP"·"AED"lockedbooleanFixed by its first paid invoice: it never changes (Stripe bills a customer in one currency).
chosenenumThe owner's own choice; null while it follows the billing country.
"EUR"·"USD"·"CHF"·"GBP"·"AED"·nullsuggestedenumWhat the billing country (else the company's country) gives.
"EUR"·"USD"·"CHF"·"GBP"·"AED"countrystring | nullThe country
suggestedwas read from.changeablebooleanThe owner can still change it (
POST /v1/billing/currency).choicesarray of enumWhat it can be changed to: every billing currency while changeable, else only the one it is.
planenumThe plan now; null with no subscription yet.
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"·nullstatusenum"TRIALING"·"ACTIVE"·"PAST_DUE"·"SUSPENDED"·"CANCELLED"·nullnotestring"No subscription yet."
planNamestringcurrentPeriodEndstring | nullcancelAtPeriodEndbooleanhasPaidSubscriptionbooleanintervalenumMonthly or yearly; null on the free plan.
"month"·"year"·nulllimitsBillingPlanLimitsThe limits in force, raised where Zuger raised one.
limits
entitiesintegeragentsinteger | nullNull: no cap.
runsPerMonthintegerrunGrantintegerbankAccountsintegerconnectedToolsinteger | nullNull: no cap.
overnightRunsbooleanroutinesbooleanauditExportbooleanresidencyChoicebooleanboardPackbooleanssoboolean
accessobjectaccess
activebooleanAgents run.
readablebooleanEverything can still be read.
messagestring
taxobject | nullVAT as decided at checkout.
tax
countrystringnamestring | nullvatNumberstring | nullvatValidatedAtstring | nulltreatmentstring | nullratePercentnumber | null
detailsobjectWho the invoice is to, and where.
details
namestring | nullcountrystring | nulladdressstring | nulltaxIdstring | null
paymentMethodsobjectpaymentMethods
defaultenum"card"·"invoice_sepa"acceptedarray of enum
cardobject | nullThe card on file, read from Stripe; null if none or Stripe is slow.
card
brandstringlast4stringexpMonthintegerexpYearintegerwalletenum"apple_pay"·"google_pay"·nullcountrystring | null
paymentsHeldobject | nullCard payments paused by Zuger.
paymentsHeld
heldenumtrueuntilstring | null
creditobject | nullA credit from Zuger waiting on the next invoice.
credit
amountMinorintegerAn amount in the currency's minor unit (cents).
currencystring
refundsarray of objectRefunds of the company's payments, newest first.
refunds
idstringAn id.
amountMinorintegerAn amount in the currency's minor unit (cents).
currencystringstatusstringpending, succeeded, failed or canceled, as Stripe reports it.
invoiceNumberstring | nullatstring (date-time)settledAtstring | nullcreditNoteobject | nullcreditNote
numberstringinvoiceRowIdstring | nullAn id.
extendedUntilstring | nullA paid period Zuger extended: the new renewal.
scheduledobject | nullA change waiting for the period end.
scheduled
planenumA plan, by its database code: PRE_REVENUE (Free), STARTER, SOLO (Pro), COMPANY (Max), GROUP (Ultra).
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"planNamestringatstring (date-time)
vatRatesReviewedstringWhen the VAT rates were last reviewed.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
GET/v1/plansList plans and pricesPublic
The plans: keys, names, monthly and yearly prices in euro cents, Runs, top-up packs, and what each plan includes.
AccessPublic: no key and no sign-in.
Operationget_v1_plans
Responses
200Success
plansarray of objectSmallest first.
plans
keyenum"free"·"starter"·"pro"·"max"·"ultra"codeenumThe plan's database code.
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"displayNamestringIts name in the Console.
externalNamestringIts name everywhere else: "Zuger" and the plan's name.
badgestring | nullmonthlyCentsintegerEuro cents a month, billed monthly, before VAT.
yearlyCentsinteger | nullEuro cents for a year paid upfront (10% off); null where there is none.
yearlyMonthlyCentsinteger | nullThe yearly price as a month.
runsPerMonthintegerRuns a month; 0 on Free, which has a one-time grant.
freeGrantintegerA one-time grant of Runs (Free only).
topupCentsPerRuninteger | nullEuro cents per top-up Run; null where top-ups are not sold.
featuresobjectfeatures
maxAgentsinteger | nullNull: no cap.
routinesbooleanovernightbooleantoolsinteger | nullNull: no cap.
bankAccountsintegercompaniesintegerauditExportbooleanboardPackbooleanssobooleandelegatedApprovalsbooleanconsolidationbooleanprioritySupportbooleanonboardingEngineerbooleaneuResidencyboolean
topupobjecttopup
packsarray of integerPack sizes in Runs.
validMonthsintegerMonths a top-up lasts.
- 400Every failure has this shape.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/plansPOST/v1/billing/cardOpen an embedded card updatePerson
No API key can call this. Changing what a company pays is not something an integration does on its behalf.
The older embedded setup session, kept for Consoles that have not refreshed; POST /v1/billing/card/form is the current way.
Why no key
Changing what a company pays is not something an integration does on its behalf.
AccessA person, signed in. No API key can call this.
Operationbilling.write
Responses
200Success
providerenum"stripe"clientSecretstringThe client secret Stripe.js confirms in the browser. Zuger never sees a card.
sessionIdstringpublicKeystring | nullStripe's publishable key, to mount Stripe.js; null where it is not configured.
modeenumWhether Stripe runs on test or live keys here; null where Stripe is not configured.
"test"·"live"·null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Changing what a company pays is not something an integration does on its behalf. Only the owner can change what the company pays. Or Stripe is not configured here.
- 429Every failure has this shape.
POST/v1/billing/checkoutOpen a checkout for a paid planPerson
No API key can call this. Changing what a company pays is not something an integration does on its behalf.
Answers an embedded Stripe checkout the Console mounts. On Free's limits after an unpaid renewal, the first call answers what is owed (owed) and charges nothing; calling again with payOwed exactly as shown pays it.
Why no key
Changing what a company pays is not something an integration does on its behalf.
AccessA person, signed in. No API key can call this.
Operationbilling.write
Request bodyrequired
planstringThe plan: a key (starter, pro, max, ultra) or a code.
intervalenumDefault month.
"month"·"year"countrystringTwo letters: the country the invoice goes to.
vatNumberstringA company's EU VAT number.
namestringThe name on the invoice (200 characters).
buyerenumWho buys; anything but individual is a company.
"individual"·"company"payOwedobjectThe unpaid renewal as it was shown in
owed.payOwed
amountMinorintegerinvoicesarray of objectAt most 50.
invoices
idstringin_…amountMinorinteger
Responses
200Success
any of
- object The checkout to mount.
providerenum"stripe"uiModeenum"elements"clientSecretstringThe client secret Stripe.js confirms in the browser. Zuger never sees a card.
sessionIdstringpublicKeystring | nullStripe's publishable key, to mount Stripe.js; null where it is not configured.
modeenumWhether Stripe runs on test or live keys here; null where Stripe is not configured.
"test"·"live"·nullplanenumA plan, by its database code: PRE_REVENUE (Free), STARTER, SOLO (Pro), COMPANY (Max), GROUP (Ultra).
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"intervalenumHow the plan is billed.
"month"·"year"amountMinorintegerWith VAT, in the minor unit of the company's billing currency.
netMinorintegerBefore VAT, in the minor unit of the company's billing currency.
currencyenumThe currency the checkout charges in: the company's, or the one Stripe already bills the customer in.
"EUR"·"USD"·"CHF"·"GBP"·"AED"emailstring | nulltaxobjecttax
countrystringtreatmentstringratePercentnumbervatValidatedbooleanviesReasonstring | nullbecausestring
paymentMethodsobjectpaymentMethods
defaultstringacceptedarray of string
- object What an unpaid renewal owes, charged nothing.
owedobjectowed
planenumA plan, by its database code: PRE_REVENUE (Free), STARTER, SOLO (Pro), COMPANY (Max), GROUP (Ultra).
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"·nullintervalenumHow the plan is billed.
"month"·"year"·nullamountMinorintegerAn amount in the currency's minor unit (cents).
taxMinorintegerAn amount in the currency's minor unit (cents).
currencystringperiodStartstring | nullperiodEndstring | nullinvoicesarray of objectinvoices
idstringamountMinorintegerAn amount in the currency's minor unit (cents).
changedenumThe amount changed since it was shown; nothing was charged.
true
- object The bank wants the person to confirm.
needsActionenumtrueclientSecretstringThe client secret Stripe.js confirms in the browser. Zuger never sees a card.
publicKeystring | nullStripe's publishable key, to mount Stripe.js; null where it is not configured.
modeenumWhether Stripe runs on test or live keys here; null where Stripe is not configured.
"test"·"live"·null
- object What paying the renewal did.
restoredbooleanplanenumA plan, by its database code: PRE_REVENUE (Free), STARTER, SOLO (Pro), COMPANY (Max), GROUP (Ultra).
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"·nullintervalenumHow the plan is billed.
"month"·"year"·nullpaidMinorintegerAn amount in the currency's minor unit (cents).
restMinorintegerAn amount in the currency's minor unit (cents).
currencystringreasonstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Changing what a company pays is not something an integration does on its behalf. Only the owner can change what the company pays. Or: Stripe is not configured on this deployment, or billing is not open yet (the seller's identifiers are missing outside test mode). Or: payments from this network are paused (
checkout_unavailable). - 409Payments are paused while Zuger checks something (
payments_held). - 429Every failure has this shape.
POST/v1/billing/currencyChoose the currency the company is billed inPerson
No API key can call this. Changing what a company pays is not something an integration does on its behalf.
Choose the currency the company is billed in (EUR, USD, CHF, GBP or AED), or null to follow the billing country. Owner only, and only before the first payment; where multi-currency billing is not on, refused.
EUR, USD, CHF, GBP or AED, or null to follow the billing country. Only before the first payment: a paid invoice fixes the currency, because Stripe bills a customer in one currency. Where multi-currency billing is not on for the company, refused and everything stays in EUR.
Why no key
Changing what a company pays is not something an integration does on its behalf.
AccessA person, signed in. No API key can call this.
Operationbilling.write
Request bodyrequired
currencyenumThe currency, or
nullto follow the billing country."EUR"·"USD"·"CHF"·"GBP"·"AED"·null
Responses
200Success
currencyenumThe currency the company is billed in now.
"EUR"·"USD"·"CHF"·"GBP"·"AED"chosenenumIts own choice; null while it follows its billing country.
"EUR"·"USD"·"CHF"·"GBP"·"AED"·nullchangedbooleanWhether anything changed.
- 400Not a currency Zuger bills in, or the currency is fixed by a payment.
- 401Not signed in: no session, or no valid API key.
- 403Changing what a company pays is not something an integration does on its behalf. Only the owner can change what the company pays. Or multi-currency billing is not open for the company.
- 429Every failure has this shape.
POST/v1/billing/intervalSwitch between monthly and yearly billingPerson
No API key can call this. Changing what a company pays is not something an integration does on its behalf.
Monthly to yearly applies now (what is left of the month is credited); yearly to monthly when the paid year ends.
Why no key
Changing what a company pays is not something an integration does on its behalf.
AccessA person, signed in. No API key can call this.
Operationbilling.write
Request bodyrequired
intervalenumThe interval to move to.
"month"·"year"
Responses
200Success
planenumA plan, by its database code: PRE_REVENUE (Free), STARTER, SOLO (Pro), COMPANY (Max), GROUP (Ultra).
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"intervalenumHow the plan is billed.
"month"·"year"timingenum"IMMEDIATE"·"AT_PERIOD_END"effectiveAtstring (date-time)notestringWhat happened, in a sentence for a person.
needsActionenumtrueclientSecretstringThe client secret Stripe.js confirms in the browser. Zuger never sees a card.
publicKeystring | nullStripe's publishable key, to mount Stripe.js; null where it is not configured.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Changing what a company pays is not something an integration does on its behalf. Only the owner can change what the company pays. Or Stripe is not configured here.
- 409Payments are paused while Zuger checks something (
payments_held). - 429Every failure has this shape.
GET/v1/billing/invoicesList invoicesPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationbilling.read
Responses
200Success
invoicesarray of BillingInvoiceNewest first.
invoices
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
POST/v1/billing/keepKeep the plan as it isPerson
No API key can call this. Changing what a company pays is not something an integration does on its behalf.
Withdraw a scheduled cancellation or plan change; the plan renews as it is.
Why no key
Changing what a company pays is not something an integration does on its behalf.
AccessA person, signed in. No API key can call this.
Operationbilling.write
Responses
200Success
planenumA plan, by its database code: PRE_REVENUE (Free), STARTER, SOLO (Pro), COMPANY (Max), GROUP (Ultra).
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"planNamestringrenewsAtstring (date-time)notestringWhat happened, in a sentence for a person.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Changing what a company pays is not something an integration does on its behalf. Only the owner can change what the company pays. Or Stripe is not configured here.
- 429Every failure has this shape.
POST/v1/billing/planChange planPerson
No API key can call this. Changing what a company pays is not something an integration does on its behalf.
An upgrade applies now and the rest of the period is charged pro rata; a downgrade (and PRE_REVENUE, which cancels) applies when the paid period ends.
Why no key
Changing what a company pays is not something an integration does on its behalf.
AccessA person, signed in. No API key can call this.
Operationbilling.write
Request bodyrequired
planstringThe plan to move to: a key or a code. PRE_REVENUE (free) cancels at the period end.
intervalenumMust match how the plan is billed now.
"month"·"year"whyobjectCancelling only: why, if the person says.
why
reasonenum"too_expensive"·"missing_feature"·"not_using"·"switching"·"closing"·"other"notestringOne line, 300 characters.
Responses
200Success
planstringtimingenum"IMMEDIATE"·"AT_PERIOD_END"effectiveAtstring | nullintervalenumHow the plan is billed.
"month"·"year"notestringWhat happened, in a sentence for a person.
needsCheckoutenumThere is no paid subscription yet: open a checkout instead.
trueneedsActionenumThe bank wants the person to confirm the payment.
trueclientSecretstringThe client secret Stripe.js confirms in the browser. Zuger never sees a card.
publicKeystring | nullStripe's publishable key, to mount Stripe.js; null where it is not configured.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Changing what a company pays is not something an integration does on its behalf. Only the owner can change what the company pays. Or Stripe is not configured here.
- 409Payments are paused while Zuger checks something (
payments_held). - 429Every failure has this shape.
POST/v1/billing/portalOpen Stripe's customer portalPerson
No API key can call this. Changing what a company pays is not something an integration does on its behalf.
Stripe's customer portal, for the owner: invoices, payment methods and the name. Plan changes, the billing address and the VAT number stay in the Console.
Why no key
Changing what a company pays is not something an integration does on its behalf.
AccessA person, signed in. No API key can call this.
Operationbilling.write
Responses
200Success
urlstring (uri)A one-time link to Stripe's customer portal.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Changing what a company pays is not something an integration does on its behalf. Only the owner can change what the company pays. Or Stripe is not configured here.
- 429Every failure has this shape.
POST/v1/billing/topupAsk for a top-up of RunsPerson
No API key can call this. Changing what a company pays is not something an integration does on its behalf.
Ask for a top-up of 50 or 200 Runs. It becomes an approval the owner decides with a passkey; nothing is charged before that.
Why no key
Changing what a company pays is not something an integration does on its behalf.
AccessA person, signed in. No API key can call this.
Operationbilling.write
Request bodyrequired
runsenumThe pack: 50 or 200 Runs.
50·200
Responses
200Success
approvalIdstringThe approval the owner decides with a passkey. Nothing is charged before.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Changing what a company pays is not something an integration does on its behalf. Only the owner can change what the company pays. Or payments from this network are paused (
checkout_unavailable). - 409Payments are paused while Zuger checks something (
payments_held). - 429Every failure has this shape.
POST/v1/billing/card/formOpen the card formPerson
No API key can call this. Changing what a company pays is not something an integration does on its behalf.
A SetupIntent for Stripe's Payment Element; nothing is charged. Finish with POST /v1/billing/card/save.
Why no key
Changing what a company pays is not something an integration does on its behalf.
AccessA person, signed in. No API key can call this.
Operationbilling.write
Responses
200Success
providerenum"stripe"clientSecretstringThe client secret Stripe.js confirms in the browser. Zuger never sees a card.
setupIntentIdstringseti_…publicKeystring | nullStripe's publishable key, to mount Stripe.js; null where it is not configured.
modeenumWhether Stripe runs on test or live keys here; null where Stripe is not configured.
"test"·"live"·null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Changing what a company pays is not something an integration does on its behalf. Only the owner can change what the company pays. Or Stripe is not configured here.
- 429Every failure has this shape.
POST/v1/billing/card/saveSave the card Stripe confirmedPerson
No API key can call this. Changing what a company pays is not something an integration does on its behalf.
Card details are never sent to Zuger: a body carrying cardNumber, number, cvc or expiry is refused.
Why no key
Changing what a company pays is not something an integration does on its behalf.
AccessA person, signed in. No API key can call this.
Operationbilling.write
Request bodyrequired
setupIntentIdstringThe
seti_…id Stripe gave the card form.namestringThe cardholder's name, used on the invoice where no invoiceName is given (200 characters).
invoiceNamestringThe name on the invoice (200 characters).
countrystringTwo letters. On a running plan it changes only with a VAT number VIES accepts for it.
line1stringThe address line (200 characters).
taxIdstringA VAT number or tax ID (40 characters).
Responses
200Success
savedenumtruecardobject | nullcard
brandstringlast4stringexpMonthintegerexpYearintegerwalletenum"apple_pay"·"google_pay"·nullcountrystring | null
notestringWhat was asked for and not done, and why.
renewalRefusedenumAn unpaid renewal was tried with the new card and refused; it is still owed.
truewhystringWhat Stripe said.
renewalUnconfirmedenumAn unpaid renewal was tried and Stripe has not answered yet.
trueowedLaterenumSomething is still owed: choose the plan again to see it.
trueneedsActionenumThe bank wants the renewal confirmed.
trueclientSecretstringThe client secret Stripe.js confirms in the browser. Zuger never sees a card.
publicKeystring | nullStripe's publishable key, to mount Stripe.js; null where it is not configured.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Changing what a company pays is not something an integration does on its behalf. Only the owner can change what the company pays. Or Stripe is not configured here.
- 404That card form is not this company's.
- 429Every failure has this shape.
Company and people
The signed-in person, the company, its people, its legal entities and its settings.
GET/v1/announcementsList the notices from Zuger for this personPerson
No API key can call this. It needs a person, signed in.
The notices from Zuger shown under the Console's top bar for this person, in their language.
AccessA person, signed in. No API key can call this.
Operationannouncements.read
Parameters
langquerystringThe language to read them in; else the account's, else English.
Responses
200Success
announcementsarray of objectLive notices for this company and plan, not put away by this person, five at most, IMPORTANT first.
announcements
idstringThe notice.
kindenum"INFO"·"MAINTENANCE"·"IMPORTANT"titlestringIn the language asked for, else in English.
bodystringlinkstring | nullA link on zuger.ai to read more.
dismissiblebooleanWhether it can be put away (never for IMPORTANT).
endsAtstring (date-time)When it ends.
termsCompanyTermsDueThe Terms in force, when this person is an owner of a company that has not accepted them yet.
terms
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
PATCH/v1/companyRename the companyPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationcompany.write
Request bodyrequired
namestringThe company's name, 2 to 120 characters on one line.
Responses
200Success
idstringThe company.
namestringIts name now.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin.
- 429Every failure has this shape.
GET/v1/consolidationRead one view across the companiesPerson
No API key can call this. It needs a person, signed in.
One view across the companies: cash, owed, pipeline and approvals per company and together. Ultra.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
asOfstring (date-time)windowstring"The last 30 days for cash; open items as they stand now."
companiesarray of CompanyConsolidationRowPer legal entity, oldest first.
companies
idstringAn id.
legalNamestringjurisdictionstringbaseCurrencystringtoolsintegerTools assigned.
net30CompanyMoneyMoney in less money out over the last 30 days, from the synced bank lines.
owedToYouCompanyMoneyOpen receivables.
overdueintegerReceivables past their due date.
youOweCompanyMoneyOpen payables.
openDealsintegerDeals not won, lost or closed.
pipelineCompanyMoneyThe open deals' amounts.
approvalsintegerApprovals waiting.
unassignedany ofunassigned
- CompanyConsolidationRow Tools and approvals assigned to no entity, where there are any.
toolsintegerTools assigned.
net30CompanyMoneyMoney in less money out over the last 30 days, from the synced bank lines.
owedToYouCompanyMoneyOpen receivables.
overdueintegerReceivables past their due date.
youOweCompanyMoneyOpen payables.
openDealsintegerDeals not won, lost or closed.
pipelineCompanyMoneyThe open deals' amounts.
approvalsintegerApprovals waiting.
- null
Everything together.
total
toolsintegerTools assigned.
net30CompanyMoneyMoney in less money out over the last 30 days, from the synced bank lines.
owedToYouCompanyMoneyOpen receivables.
overdueintegerReceivables past their due date.
youOweCompanyMoneyOpen payables.
openDealsintegerDeals not won, lost or closed.
pipelineCompanyMoneyThe open deals' amounts.
approvalsintegerApprovals waiting.
notestring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. The plan runs one company (Ultra has the view across companies).
- 429Every failure has this shape.
GET/v1/entitiesList the legal entities the account runsPerson
No API key can call this. It needs a person, signed in.
The legal entities this account runs, and how many the plan allows.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
capintegerHow many the plan allows now (a raised limit included).
planenumThe plan's code: PRE_REVENUE (Free), STARTER, SOLO (Pro), COMPANY (Max) or GROUP (Ultra).
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"planNamestringThe plan's name.
entitiesarray of CompanyEntityOldest first.
entities
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
POST/v1/entitiesAdd a legal entityPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request bodyrequired
legalNamestringThe legal name, 2 to 120 characters.
jurisdictionstringThe country, a two-letter code such as EE, DE or GB.
baseCurrencystringA three-letter currency code, such as EUR.
registrationNostring | nullThe registry number, 40 characters at most; null or empty clears it.
vatNumberstring | nullThe VAT number, 40 characters at most; null or empty clears it.
fiscalYearEndstring | nullThe day the financial year ends, MM-DD such as 12-31; null clears it.
vatRegisteredboolean | nullVAT registered; null for not said.
vatPeriodenumThe VAT period; null clears it.
"MONTHLY"·"QUARTERLY"·"SEMI_ANNUAL"·"ANNUAL"·nullhasPayrollbooleanWhether it runs a payroll.
incorporatedOnstring | nullWhen it was incorporated, YYYY-MM-DD; null clears it.
ctRegisteredboolean | nullRegistered for corporate tax; null for not said.
Responses
200Success
idstringThe new entity.
legalNamestringjurisdictionstringbaseCurrencystring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin, or the plan's entities are all in use.
- 429Every failure has this shape.
GET/v1/flagsList the Console features switched on for the companyPerson
No API key can call this. It needs a person, signed in.
The keys of the Console's feature flags that are on for this company now.
AccessA person, signed in. No API key can call this.
Operationflags.read
Responses
200Success
flagsarray of stringThe keys of the Console's feature flags that are on now.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
GET/v1/meRead the signed-in person and their companyPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationme.read
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
PATCH/v1/meChange your name, language or sign-in addressPerson
No API key can call this. It needs a person, signed in.
One change a call: locale if sent, else email if sent, else name. Changing the address needs a fresh sign-in proof (/v1/auth/reauth/*), ends every other session and sends a link to confirm the new address.
AccessA person, signed in. No API key can call this.
Operationme.write
Request body
namestringYour name, 1 to 80 characters on one line.
localeenumYour language.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"emailstring (email)Your new sign-in address.
Responses
200Success
one of
- object After a change of language.
idstringYou.
localestringYour language now.
- object After a change of address.
idstringYou.
emailstring (email)Your address now, not confirmed yet.
- object After a change of name.
idstringYou.
namestring | nullYour name now.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Changing the address: no recent proof (
reauth_required), or the company requires single sign-on on the old address's domain. - 429Every failure has this shape.
GET/v1/membersList the people in the companyPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
membersarray of CompanyMemberOldest first.
members
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
GET/v1/newsRead whether you get news from Zuger by emailPerson
No API key can call this. It needs a person, signed in.
Whether this person gets news from Zuger by email (Settings → Notifications).
AccessA person, signed in. No API key can call this.
Operationnews.read
Responses
200Success
newsbooleanWhether news emails come.
sincestring | nullSince when they stopped, where they did.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
POST/v1/newsSwitch news from Zuger by email on or offPerson
No API key can call this. Whether a person gets news from Zuger by email is that person's choice, made signed in or with the link in the email. A key is not that person.
News from Zuger by email, on or off for this person. Emails about the account, billing, security and support always come.
Why no key
Whether a person gets news from Zuger by email is that person's choice, made signed in or with the link in the email. A key is not that person.
AccessA person, signed in. No API key can call this.
Operationnews.write
Request bodyrequired
onbooleanWhether news emails come.
Responses
200Success
newsbooleanWhether news emails come now.
sincestring | nullSince when they stopped, where they did.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Whether a person gets news from Zuger by email is that person's choice, made signed in or with the link in the email. A key is not that person.
- 429Every failure has this shape.
GET/v1/sending-domainRead the company's sending domainPerson
No API key can call this. It needs a person, signed in.
Whether sending from the company’s own domain is on, and the domain: its DNS records and status at Resend.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
availablebooleanWhether sending from the company's own domain is on for it.
domainany ofdomain
- null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
POST/v1/sending-domainSet up the company's sending domainPerson
No API key can call this. It needs a person, signed in.
Set up the company’s sending domain with Resend. Answers the DNS records to publish. Owner or admin.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request body
domainstringThe company's own domain (never Zuger's).
localPartstringThe part before the @ that messages come from.
replyTostring | nullWhere replies go (never Zuger).
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin, or sending from the company's own domain is not switched on for it.
- 409The company has a sending domain already, or Resend has this domain already.
- 429Every failure has this shape.
- 502Resend could not be reached.
DELETE/v1/sending-domainRemove the sending domainPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Responses
200Success
removedenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin.
- 404There is no sending domain.
- 429Every failure has this shape.
GET/v1/settingsRead everything the Settings pages showPerson
No API key can call this. It needs a person, signed in.
Everything the Settings pages show, in one answer: the person, connections, routines, billing, memory, Bernina, passkeys, the catalogue, invoices, members, entities, consolidation, approver roles, single sign-on, payouts, connected apps, support access, chat channels. A part that fails is null.
One read for the Console's Settings. Each part is what its own route answers; a part that could not be read is null (a list is empty).
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
meany ofme
- null
connectionsarray of objectThe company's connections.
routinesarray of objectbillingobject | nullThe plan, Runs and limits, as
GET /v1/billinganswers.memoryarray of objectsecurityobject | nullBernina's security summary, as
GET /v1/bernina/securityanswers.passkeysarray of objectconnectorsarray of objectThe tools Zuger can connect, each read-only, with the scopes it asks for and why.
connectors
idstringnamestringproviderstringcategorystringresidencyenum"EU"·"GLOBAL"readOnlyenumtrueauthModestringHow it connects (OAuth, aggregator, upload, …).
statusenum"LIVE"·"CONTRACT_PENDING"regionsarray of stringscopesarray of objectscopes
scopestringwhystringprepareOnlyboolean
invoicesarray of objectsummaryobject | nullBernina's summary, as
GET /v1/bernina/summaryanswers.membersarray of CompanyMembermembers
entitiesobject | nullAs
GET /v1/entitiesanswers.consolidationobject | nullAs
GET /v1/consolidationanswers; null below Ultra.delegationobject | nullDelegated approvals, as
GET /v1/approvals/delegationanswers.ssoany ofsso
- null
payoutsobject | nullPayouts for what the company sells, as
GET /v1/payoutsanswers.appsarray of objectConnected apps.
statementsobject | nullUploaded statements, as
GET /v1/statementsanswers.supportobject | nullSupport access Zuger had to the company (What Zuger did here).
chatsobject | nullChat channels, as
GET /v1/channelsanswers.sealedobject | nullZuger Sealed, as
GET /v1/sealedanswers.sealLogobject | nullThe Seal Log, as
GET /v1/sealed/loganswers.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
GET/v1/ssoRead the company's single sign-onPerson
No API key can call this. It needs a person, signed in.
The company's single sign-on, without its secret.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
PATCH/v1/ssoSet up single sign-onPerson
No API key can call this. It needs a person, signed in.
Set the OpenID Connect issuer and client. Owner only; Ultra.
The issuer is discovered before anything is stored. A changed issuer, client id or a new secret stops it being the only way in until someone signs in through it again.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request bodyrequired
issuerstring (uri)The OpenID Connect issuer (public https only).
clientIdstringThe client id, 3 to 300 characters.
clientSecretstringThe client secret, 600 characters at most; leave it out for a public client with PKCE, or to keep the one stored.
Responses
200Success
configuredenumtrueissuerstring (uri)clientIdstringdomainstringThe mail domain it covers: the owner's own.
hasSecretbooleanredirectUristring (uri)The redirect address to give the identity provider.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner; the plan has no single sign-on; the owner's address is unconfirmed or a public mail service; no vault for a secret; the domain is another company's.
- 429Every failure has this shape.
DELETE/v1/ssoRemove single sign-onPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Responses
200Success
configuredenumfalse
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner.
- 404Single sign-on is not set up.
- 429Every failure has this shape.
GET/v1/switchesList what Zuger has paused for everyone nowPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
switchesarray of CompanySwitchswitches
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
GET/v1/company/regionWhere your company's data is keptPerson
No API key can call this. Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it.
Where the company's data is kept: its home region (zh, Zurich; ff, Frankfurt) and a change of region the owner approved that waits for the move. The owner, signed in.
Why no key
Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it.
AccessA person, signed in. No API key can call this.
Operationcompany.region
Responses
200Success
homeRegionenumzh is Zurich, ff is Frankfurt.
"zh"·"ff"regionsarray of enumwaitingobject | nullA change you approved, waiting for the move.
waiting
idstringAn id.
fromenumzh is Zurich, ff is Frankfurt.
"zh"·"ff"toenumzh is Zurich, ff is Frankfurt.
"zh"·"ff"approvedAtstring (date-time)
movesbooleanAlways false: an approved change moves nothing until the move carries it out.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it. Not the owner signed in (a key, a connected app or an agent never can).
- 404With
region_changeoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
PATCH/v1/entities/{id}Change a legal entityPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Request body
legalNamestringThe legal name, 2 to 120 characters.
jurisdictionstringThe country, a two-letter code such as EE, DE or GB.
baseCurrencystringA three-letter currency code, such as EUR.
registrationNostring | nullThe registry number, 40 characters at most; null or empty clears it.
vatNumberstring | nullThe VAT number, 40 characters at most; null or empty clears it.
fiscalYearEndstring | nullThe day the financial year ends, MM-DD such as 12-31; null clears it.
vatRegisteredboolean | nullVAT registered; null for not said.
vatPeriodenumThe VAT period; null clears it.
"MONTHLY"·"QUARTERLY"·"SEMI_ANNUAL"·"ANNUAL"·nullhasPayrollbooleanWhether it runs a payroll.
incorporatedOnstring | nullWhen it was incorporated, YYYY-MM-DD; null clears it.
ctRegisteredboolean | nullRegistered for corporate tax; null for not said.
Responses
200Success
idstringThe entity.
legalNamestringjurisdictionstringbaseCurrencystringregistrationNostring | nullvatNumberstring | nullfiscalYearEndstring | nullvatRegisteredboolean | nullvatPeriodstring | nullhasPayrollbooleanincorporatedOnstring | nullMidnight UTC of the day given.
ctRegisteredboolean | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
DELETE/v1/entities/{id}Remove a legal entityPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Responses
200Success
removedstringThe entity removed.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin, or tools, Runs, approvals, documents or memory stand behind it (it is kept for the record).
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/members/inviteInvite a person to the companyPerson
No API key can call this. It needs a person, signed in.
An email with a link that makes their passkey; it lapses in three days. Needs a confirmed address and an email provider on the deployment.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request bodyrequired
emailstring (email)Their address.
roleenumMEMBER unless ADMIN is sent; only the owner invites an admin.
"ADMIN"·"MEMBER"namestringTheir name (80 characters kept); the address's first part otherwise.
Responses
201Success
invitedstring (email)roleenum"ADMIN"·"MEMBER"expiresAtstring (date-time)When the link lapses.
notestring
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin, an admin inviting an admin, the inviter's address not confirmed, or no email provider.
- 429Every failure has this shape.
PATCH/v1/members/{id}Change a person's rolePerson
No API key can call this. It needs a person, signed in.
Give a person the admin or the member role. Owner only.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Request bodyrequired
roleenumThe new role.
"ADMIN"·"MEMBER"
Responses
200Success
idstringThe person.
roleenum"ADMIN"·"MEMBER"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner, or the person is an owner.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
DELETE/v1/members/{id}Remove a person from the companyPerson
No API key can call this. It needs a person, signed in.
Remove a person from the company; their sessions here end at once. Owner only.
Their sessions and the apps they connected for this company end at once.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Responses
200Success
removedstringThe person removed.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner, or the person is an owner.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/sending-domain/checkCheck the sending domain's DNS records againPerson
No API key can call this. It needs a person, signed in.
Ask Resend to check the DNS records again.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin, or sending is not switched on.
- 404No sending domain set up.
- 429Every failure has this shape.
- 502Resend could not be reached.
POST/v1/sending-domain/testSend yourself a test email from the sending domainPerson
No API key can call this. It needs a person, signed in.
One test email from the verified domain to your own confirmed address. Never to anyone else.
To your own confirmed address only, once every ten minutes (429 otherwise). A 400 until the domain is verified.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Responses
200Success
sentenumtruetostring (email)Your address.
fromstringThe From header it carried.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner or an admin, sending not switched on, or your address not confirmed.
- 429Every failure has this shape.
- 502Resend did not take it.
POST/v1/sso/requiredMake single sign-on the only way in, or stopPerson
No API key can call this. It needs a person, signed in.
Owner only: make single sign-on the only way in for members on the domain (required: true), or stop. Never covers the owner, and only once it has been seen to work.
A 400 when it is not set up, or nobody has signed in through it yet.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request body
requiredbooleantrue to make it the only way in for members on the domain; anything else stops it.
Responses
200Success
requiredboolean
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner.
- 429Every failure has this shape.
POST/v1/terms/acceptAccept the Terms in force for the companyPerson
No API key can call this. Accepting Zuger's Terms binds the company, and only an owner who has read them can do it. A key has read nothing.
Accept the Terms in force for this company (an owner, with the version shown).
A 400 when the Terms changed since the page was opened (the version is not the one in force).
Why no key
Accepting Zuger's Terms binds the company, and only an owner who has read them can do it. A key has read nothing.
AccessA person, signed in. No API key can call this.
Operationterms.accept
Request bodyrequired
versionstringThe version of the Terms shown (
terms.versionfromGET /v1/announcements).
Responses
200Success
versionstringThe Terms accepted.
acceptedAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Accepting Zuger's Terms binds the company, and only an owner who has read them can do it. A key has read nothing. Not an owner of the company.
- 429Every failure has this shape.
POST/v1/announcements/{id}/dismissPut a notice from Zuger awayPerson
No API key can call this. Putting a notice from Zuger away is one person saying they have read it. A key has read nothing.
Put a notice from Zuger away for this person. An important one stays until it ends.
Why no key
Putting a notice from Zuger away is one person saying they have read it. A key has read nothing.
AccessA person, signed in. No API key can call this.
Operationannouncements.dismiss
Parameters
idpathstring
Responses
200Success
dismissedstringThe notice.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Putting a notice from Zuger away is one person saying they have read it. A key has read nothing.
- 404No such live notice for this company.
- 429Every failure has this shape.
POST/v1/company/region/changeApprove a change of region with a passkeyPerson
No API key can call this. Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it.
Approve a change of region with a passkey. It is recorded and waits for the move: no data moves, and the home region stays as it is until the move carries it out.
Why no key
Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it.
AccessA person, signed in. No API key can call this.
Operationcompany.region
Request bodyrequired
toenumzh is Zurich, ff is Frankfurt.
"zh"·"ff"assertionobjectA WebAuthn assertion:
{ credentialId, challenge (the token), response }, as the Console sends it.
Responses
200Success
idstringAn id.
fromenumzh is Zurich, ff is Frankfurt.
"zh"·"ff"toenumzh is Zurich, ff is Frankfurt.
"zh"·"ff"statusenum"APPROVED"approvedAtstring (date-time)movesbooleanAlways false.
- 400Not zh or ff.
- 401Not signed in: no session, or no valid API key.
- 403Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it. Not the owner signed in, or the passkey signature did not check out.
- 404With
region_changeoff for the company, every one of these paths answers 404, as an unknown path does. - 409The data is already kept there, or a change is already waiting.
- 429Every failure has this shape.
POST/v1/company/region/change/startStart the passkey for a change of regionPerson
No API key can call this. Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it.
The passkey challenge for choosing the other region: its WebAuthn challenge is the SHA-256 of the change (the company, from, to, a nonce), returned beside it. The owner, signed in.
Why no key
Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it.
AccessA person, signed in. No API key can call this.
Operationcompany.region
Request bodyrequired
toenumzh is Zurich, ff is Frankfurt.
"zh"·"ff"
Responses
200Success
optionsobjectWebAuthn request options;
challengeis the SHA-256 ofpayload.tokenstringSent back with the assertion.
payloadstringWhat the passkey commits to (zuger-region-change/1: the company, from, to, a nonce and its time).
- 400Not zh or ff.
- 401Not signed in: no session, or no valid API key.
- 403Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it. Not the owner signed in (a key, a connected app or an agent never can).
- 404With
region_changeoff for the company, every one of these paths answers 404, as an unknown path does. - 409The data is already kept there, or a change is already waiting.
- 429Every failure has this shape.
DELETE/v1/company/region/change/{id}Withdraw a change of region still waitingPerson
No API key can call this. Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it.
Withdraw a change of region still waiting for the move. Nothing had moved, so nothing moves back.
Why no key
Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it.
AccessA person, signed in. No API key can call this.
Operationcompany.region
Parameters
idpathstring
Responses
200Success
idstringAn id.
statusenum"WITHDRAWN"withdrawnAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Where a company's data is kept is its owner's decision, approved with a passkey that commits to exactly that change. A key is an agent's or an integration's, so it can neither read nor change it. Not the owner signed in (a key, a connected app or an agent never can).
- 404No change of region waiting by that id. With
region_changeoff for the company, every one of these paths answers 404, as an unknown path does. - 429Every failure has this shape.
Sign-in and connected apps
Signing up and in, passkeys, and OAuth for connected apps.
GET/oauth/authorizeSend a person to approve an appPublic
Sends the person to the Console to say yes or no to the app. The answer goes back to the app's redirect address.
As RFC 6749 with PKCE. Every query parameter is passed on to the Console's consent screen.
AccessPublic: no key and no sign-in.
Operationget_oauth_authorize
Parameters
client_idquerystringThe app, as
POST /oauth/registernamed it.redirect_uriquerystringOne of the addresses the app registered.
response_typequeryAlways
code.code_challengequerystringPKCE: the S256 challenge of the app's code verifier.
code_challenge_methodqueryS256, or left out.
scopequerystringSpace-separated scopes; none (or none known) is
agents:readonly.statequerystringHanded back to the app as it came, up to 500 characters.
resourcequerystringThe resource the token is for (RFC 8707), up to 500 characters.
Responses
- 302To the Console's consent screen with the same query; or, for a request that is wrong, to the app's redirect_uri with
error=invalid_request(a redirect_uri the app did not register is answered with a 400, never followed). - 400Every failure has this shape.
- 429Every failure has this shape.
curl https://beta.zuger.ai/oauth/authorizePOST/oauth/registerRegister a connected appPublic
Dynamic client registration (RFC 7591) for a connected app: a name and its redirect addresses. Public clients only.
AccessPublic: no key and no sign-in.
Operationpost_oauth_register
Request bodyrequired
client_namestringThe name the person sees on the consent screen, 2 to 80 characters.
redirect_urisarray of string (uri)One to ten addresses: https, http on this machine, or the app's own scheme.
token_endpoint_auth_methodenumConnected apps are public clients: only
none."none"client_uristring (uri)The app's https homepage (anything else is ignored).
logo_uristring (uri)The app's https logo (anything else is ignored).
Responses
201Registered (RFC 7591). There is no client secret: every authorisation is proven with PKCE.
client_idstringThe app's client_id.
client_namestringredirect_urisarray of string (uri)token_endpoint_auth_methodenum"none"grant_typesarray of enumresponse_typesarray of enumclient_id_issued_atintegerSeconds since the epoch.
client_uristring (uri)logo_uristring (uri)
- 400Every failure has this shape.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/oauth/register \
-H "Content-Type: application/json" \
-d '{"client_name": "…", "redirect_uris": []}'POST/oauth/revokeRevoke a connected app's tokenPublic
Revocation (RFC 7009): an app hands a token back. Always 200.
RFC 7009. Form-encoded (application/x-www-form-urlencoded) or JSON. The answer is the same whether or not the token was live.
AccessPublic: no key and no sign-in.
Operationpost_oauth_revoke
Request bodyrequired
tokenstringAn access token (
zo_…) or refresh token (zr_…).
Responses
200Success
revokedenumtrue
- 400Every failure has this shape.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/oauth/revoke \
-H "Content-Type: application/json" \
-d '{"token": "…"}'POST/oauth/tokenExchange a code or refresh token for tokensPublic
The token endpoint: authorization_code with PKCE, or refresh_token. Form-encoded or JSON.
Form-encoded (application/x-www-form-urlencoded) or JSON. A refusal is RFC 6749's { "error", "error_description" } (invalid_client with 401; invalid_grant, unsupported_grant_type with 400), not Zuger's error shape. A refresh token rotates: the old pair stops working.
AccessPublic: no key and no sign-in.
Operationpost_oauth_token
Request bodyrequired
grant_typeenum"authorization_code"·"refresh_token"client_idstringThe app's client_id.
codestringWith authorization_code: the code (
zc_…).redirect_uristring (uri)With authorization_code: the redirect_uri the code was issued for.
code_verifierstringWith authorization_code: the PKCE verifier.
refresh_tokenstringWith refresh_token: the refresh token (
zr_…).scopestringWith refresh_token: a narrower set of the granted scopes, space-separated.
Responses
200Success
access_tokenstringA bearer token (
zo_…) for this API, valid 24 hours.token_typeenum"Bearer"expires_inintegerSeconds: 86400.
refresh_tokenstringA refresh token (
zr_…), valid 90 days.scopestringThe granted scopes, space-separated.
- 400A grant it cannot take (RFC 6749's shape).
- 401No app is registered under that client_id (RFC 6749's shape).
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/oauth/token \
-H "Content-Type: application/json" \
-d '{"grant_type": "authorization_code", "client_id": "…"}'POST/v1/signupSign up with an emailed linkPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_signup
Request bodyrequired
emailstring (email)The new account's address. Trimmed and lower-cased.
namestringYour name, 2 to 80 characters (made one line).
companyNamestringThe company's name, 2 to 120 characters. Without it one is made from the address; it can be changed later.
countrystringThe company's country, ISO 3166-1 alpha-2, while a region is asked for at sign-up (
regionSteponGET /v1/signups). Not a country: unknown.regionChoicestringzurichorfrankfurt, if the person chose the other region. Unset: the country decides (EU and EEA: Frankfurt; anywhere else: Zurich; unknown: Frankfurt).localeenumThe language for emails and the Console. Anything else is ignored; a signup never fails over it.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"
Responses
200The same answer whether or not the address has an account: the link (to set up a passkey) or a note goes to the address. Nothing here grants access.
- 400Every failure has this shape.
- 403No email provider is configured on this deployment, or sign-ups from this network or email provider are refused.
- 409Sign-ups are paused by Zuger (
paused_by_zuger). - 421This sign-up belongs in the other region (
wrong_region): nothing was read or written;hostsays where. - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/signup \
-H "Content-Type: application/json" \
-d '{"email": "…", "name": "…"}'GET/v1/signupsCheck whether sign-ups are openPublic
AccessPublic: no key and no sign-in.
Operationget_v1_signups
Responses
200Success
openbooleanFalse while Zuger has paused new accounts.
endsAtstring (date-time)When the pause ends (only while paused).
publicNotestring | nullA note Zuger wrote for visitors, if any (only while paused).
- 400Every failure has this shape.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/signupsGET/v1/auth/passkeysList your passkeysPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationpasskey.list
Responses
200Success
passkeysarray of AuthPasskeyYour live passkeys, oldest first.
passkeys
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
POST/v1/auth/passwordSet or change your passwordPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationpassword.set
Request bodyrequired
passwordstringAt least 8 characters, at most 200.
Responses
200Set. Every other session of yours is signed out, and you are told by email.
setenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. You have not confirmed it is you in the last ten minutes (POST /v1/auth/reauth/*).
- 429Every failure has this shape.
POST/v1/auth/sign-out-everywhereSign out everywherePerson
Why no key
Signing everyone out is what a person does when they think something is wrong. A key that could do it is a key that could lock a founder out of their own company.
AccessA person, signed in. No API key can call this.
Operationsession.revoke
Responses
200Every session of yours ends, this one included, and browser notifications stop.
revokedintegerHow many sessions were ended.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Signing everyone out is what a person does when they think something is wrong. A key that could do it is a key that could lock a founder out of their own company.
- 429Every failure has this shape.
POST/v1/auth/whereAsk whether this region knows an addressPublic
Zuger's own router only: without its proof this is a 404, so nobody else can learn whether an address has an account. Nothing is kept.
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_where
Request bodyrequired
emailstringThe address the sign-in names.
Responses
200Success
knownbooleanWhether this region holds an account for it.
- 400Every failure has this shape.
- 404Not the router.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/where \
-H "Content-Type: application/json" \
-d '{"email": "…"}'GET/v1/oauth/appsList connected appsPerson
No API key can call this. Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another.
The apps connected to the company: which, by whom, last used. Owners and admins see all; a member their own.
Why no key
Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another.
AccessA person, signed in. No API key can call this.
Operationoauth.read
Responses
200Success
appsarray of objectNewest first. Owners and admins see every app; a member sees their own.
apps
idstringThe connection (for DELETE /v1/oauth/apps/{id}).
appstring | nullThe app's name, or null when it claims a known app it cannot be.
verifiedbooleansendsToOAuthSendsToWhere the authorisation code goes.
sendsTo
appUristring | nulllogostring | nullscopesarray of stringAPI scopes (
runs:read,agents:read, …).bystringWho connected it: their name, else their address.
minebooleanYou connected it.
connectedAtstring (date-time)lastUsedAtstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another.
- 429Every failure has this shape.
POST/v1/oauth/decideApprove or refuse a connected appPerson
No API key can call this. Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another.
The person's yes or no. Yes mints a code for the app; either way, where to send the person next.
Why no key
Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another.
AccessA person, signed in. No API key can call this.
Operationoauth.write
Request bodyrequired
requestobjectThe authorisation request, as read from GET /v1/oauth/request's query (
client_id,redirect_uri,response_type,code_challenge,code_challenge_method,scope,state,resource).allowbooleanTrue to connect the app; anything else refuses it.
Responses
200Where to send the person next. Yes mints a code for the app, valid ten minutes, once.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another. Only a member of the company can connect an app to it.
- 429Every failure has this shape.
GET/v1/oauth/requestRead what an app is asking forPerson
No API key can call this. Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another.
The consent screen's text: which app is asking and for what. A person, signed in; no key or connected app.
The authorisation request, as the Console received it from GET /oauth/authorize.
Why no key
Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another.
AccessA person, signed in. No API key can call this.
Operationoauth.read
Parameters
client_idquerystringThe app, as
POST /oauth/registernamed it.redirect_uriquerystringOne of the addresses the app registered.
response_typequeryAlways
code.code_challengequerystringPKCE: the S256 challenge of the app's code verifier.
code_challenge_methodqueryS256, or left out.
scopequerystringSpace-separated scopes; none (or none known) is
agents:readonly.statequerystringHanded back to the app as it came, up to 500 characters.
resourcequerystringThe resource the token is for (RFC 8707), up to 500 characters.
Responses
200Success
clientOAuthClientViewclient
scopesarray of stringAPI scopes (
runs:read,agents:read, …).redirectUristring (uri)Where the code will go.
statestring | nullThe app's state, at most 500 characters.
resourcestring | nullThe resource asked for, at most 500 characters.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another.
- 429Every failure has this shape.
POST/v1/auth/code/requestAsk for a sign-in code by emailPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_code_request
Request bodyrequired
emailstring (email)The address to send a six-digit code to. Trimmed and lower-cased.
Responses
200The same answer whether or not the address has an account. A code is mailed only to an account's address, at most one a minute; it lasts ten minutes and five guesses.
sentenumtrueusablebooleanWhether this deployment can send email. True for an address with an account; otherwise it says whether mail could be sent at all.
- 400Every failure has this shape.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/code/request \
-H "Content-Type: application/json" \
-d '{"email": "…"}'POST/v1/auth/code/verifySign in with an emailed codePublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_code_verify
Request bodyrequired
emailstring (email)The address the code was sent to. Trimmed and lower-cased.
codestringThe six digits from the email (spaces are ignored).
Responses
200Signed in: the session is set as the zuger_session cookie (HttpOnly, Secure, SameSite=Lax), never in the body. It also confirms the address.
- 400Every failure has this shape.
- 403The code is wrong or has run out; the account is locked for 15 minutes after ten wrong attempts, suspended, or its company requires single sign-on.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/code/verify \
-H "Content-Type: application/json" \
-d '{"email": "…", "code": "…"}'POST/v1/auth/email/confirmConfirm an email addressPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_email_confirm
Request bodyrequired
tokenstringThe token from the confirmation link (
#/verify/<token>), valid seven days.
Responses
200Confirmed. Confirming twice is not an error.
confirmedenumtrueemailstring (email)The confirmed address.
- 400Every failure has this shape.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/email/confirm \
-H "Content-Type: application/json" \
-d '{"token": "…"}'POST/v1/auth/login/finishFinish a passkey sign-inPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_login_finish
Request bodyrequired
tokenstringThe signed challenge token from the matching start call. Valid for one ceremony.
responseobjectThe browser's PublicKeyCredential as JSON (
id,rawId,type,response, …), as navigator.credentials returned it.
Responses
200Signed in: the session is set as the zuger_session cookie (HttpOnly, Secure, SameSite=Lax), never in the body.
- 400Every failure has this shape.
- 403The passkey is on no account, could not be verified, the account is suspended, or the company requires single sign-on.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/login/finish \
-H "Content-Type: application/json" \
-d '{"token": "…", "response": {}}'POST/v1/auth/login/startStart a passkey sign-inPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_login_start
Request body
emailstring (email)The address, to narrow nothing on the server: the challenge names no account either way. Kept only if it looks like an address.
Responses
200A WebAuthn challenge (PublicKeyCredentialRequestOptions) and its token, for POST /v1/auth/login/finish.
- 400Every failure has this shape.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/login/start \
-H "Content-Type: application/json" \
-d '{"email": "…"}'POST/v1/auth/passkeys/finishFinish registering a passkeyPerson
Why no key
A passkey is registered by the person who will hold it.
AccessA person, signed in. No API key can call this.
Operationpasskey.register
Request bodyrequired
tokenstringThe signed challenge token from the matching start call. Valid for one ceremony.
responseobjectThe browser's PublicKeyCredential as JSON (
id,rawId,type,response, …), as navigator.credentials returned it.
Responses
201Created. You are told by email that a passkey was added.
credentialIdstringThe new passkey's id in Zuger.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A passkey is registered by the person who will hold it.
- 429Every failure has this shape.
POST/v1/auth/passkeys/startStart registering a passkeyPerson
Why no key
A passkey is registered by the person who will hold it.
AccessA person, signed in. No API key can call this.
Operationpasskey.register
Responses
200A WebAuthn challenge (PublicKeyCredentialCreationOptions) and its token, for POST /v1/auth/passkeys/finish.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A passkey is registered by the person who will hold it.
- 429Every failure has this shape.
DELETE/v1/auth/passkeys/{id}Remove a passkeyPerson
No API key can call this. Removing the way someone signs in is not an API operation.
Your only passkey can go only if the account has a password.
Why no key
Removing the way someone signs in is not an API operation.
AccessA person, signed in. No API key can call this.
Operationpasskey.revoke
Parameters
idpathstring
Responses
200Success
revokedstringThe passkey removed.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Removing the way someone signs in is not an API operation.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/auth/password/loginSign in with a passwordPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_password_login
Request bodyrequired
emailstring (email)The account's address. Trimmed and lower-cased.
passwordstringThe password (at most 200 characters).
Responses
200Signed in: the session is set as the zuger_session cookie (HttpOnly, Secure, SameSite=Lax), never in the body.
- 400Every failure has this shape.
- 403The address and password do not match (the same words either way); the account is locked for 15 minutes after ten wrong attempts, suspended, or its company requires single sign-on.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/password/login \
-H "Content-Type: application/json" \
-d '{"email": "…", "password": "…"}'POST/v1/auth/password/signupSign up with a passwordPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_password_signup
Request bodyrequired
emailstring (email)The new account's address. Trimmed and lower-cased.
namestringYour name, 2 to 80 characters (made one line).
passwordstringAt least 8 characters, at most 200.
companyNamestringThe company's name, at most 120 characters. Without it one is made from the address; it can be changed later.
countrystringThe company's country, ISO 3166-1 alpha-2, while a region is asked for at sign-up (
regionSteponGET /v1/signups). Not a country: unknown.regionChoicestringzurichorfrankfurt, if the person chose the other region. Unset: the country decides (EU and EEA: Frankfurt; anywhere else: Zurich; unknown: Frankfurt).localeenumThe language for emails and the Console. Anything else is ignored; a signup never fails over it.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"
Responses
201Created. Signed in: the session is set as the zuger_session cookie (HttpOnly, Secure, SameSite=Lax), never in the body. An address that already has an account gets the same status and body and no cookie; its owner is emailed instead.
expiresAtstring (date-time)When the session ends.
- 400Every failure has this shape.
- 403Sign-ups from this network or email provider are refused.
- 409Sign-ups are paused by Zuger (
paused_by_zuger). - 421This sign-up belongs in the other region (
wrong_region): nothing was read or written;hostsays where. - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/password/signup \
-H "Content-Type: application/json" \
-d '{"email": "…", "name": "…", "password": "…"}'POST/v1/auth/reauth/finishConfirm it is youPerson
No API key can call this. It needs a person, signed in.
Send password, or token and response from a passkey. Either marks this session as proven for ten minutes.
AccessA person, signed in. No API key can call this.
Operationreauth.write
Request body
passwordstringYour current password, instead of a passkey.
tokenstringThe signed challenge token from the matching start call. Valid for one ceremony.
responseobjectThe browser's PublicKeyCredential as JSON (
id,rawId,type,response, …), as navigator.credentials returned it.
Responses
200Success
confirmedenumtrueuntilstring (date-time)Until when this session counts as proven.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. The password or passkey is not right, or the account is locked for 15 minutes after ten wrong attempts.
- 429Every failure has this shape.
POST/v1/auth/reauth/startStart confirming it is youPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationreauth.write
Responses
200The ways to prove it is you now, before changing a password or an address.
passwordbooleanThe account has a password, so it can be used instead of a passkey.
tokenstringThe signed challenge token from the matching start call. Valid for one ceremony.
optionsobjectWebAuthn PublicKeyCredentialRequestOptions bound to this session, with
allowCredentialslisting your passkeys. Absent when you have none.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
POST/v1/auth/recovery/claimOpen a recovery or invitation linkPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_recovery_claim
Request bodyrequired
tokenstringThe token from the link (
#/claim/<token>). It opens once.
Responses
200A recovery session, set as the zuger_session cookie. Opening the link confirms the address; a password set before the address was ever confirmed is dropped.
expiresAtstring (date-time)When the recovery session ends.
scopeenumA recovery session can only register a passkey.
"RECOVERY"nextstring"Register a passkey. It is the only thing this can do."
- 400Every failure has this shape.
- 403The account is suspended.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/recovery/claim \
-H "Content-Type: application/json" \
-d '{"token": "…"}'POST/v1/auth/recovery/requestAsk for a recovery linkPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_recovery_request
Request bodyrequired
emailstring (email)The account's address. Trimmed and lower-cased.
Responses
200The same answer whether or not the address has an account. One link an address every ten minutes.
- 400Every failure has this shape.
- 403No email provider is configured on this deployment.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/recovery/request \
-H "Content-Type: application/json" \
-d '{"email": "…"}'POST/v1/auth/sso/finishFinish a single sign-onPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_sso_finish
Parameters
cookieheaderstring
Request bodyrequired
codestringThe
codethe identity provider returned.statestringThe
stateit returned.
Responses
200Signed in: the session is set as the zuger_session cookie (HttpOnly, Secure, SameSite=Lax), never in the body. The zuger_sso cookie is cleared.
- 400Every failure has this shape.
- 403The attempt expired, was used, began in another browser, or single sign-on is no longer set up for the company.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/sso/finish \
-H "Content-Type: application/json" \
-d '{"code": "…", "state": "…"}'POST/v1/auth/sso/startStart a single sign-onPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_auth_sso_start
Request bodyrequired
emailstring (email)Your work address; its domain finds the company's identity provider. Trimmed and lower-cased.
autobooleanTrue from the sign-in door: answers a
urlonly where that person's company requires single sign-on.
Responses
200A short zuger_sso cookie ties the attempt to this browser (ten minutes).
urlstring (uri)The identity provider's authorisation address: send the browser there.
- 400Every failure has this shape.
- 404No single sign-on is set up (or, with
auto, required) for that address. - 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/auth/sso/start \
-H "Content-Type: application/json" \
-d '{"email": "…"}'DELETE/v1/oauth/apps/{id}Disconnect an appPerson
No API key can call this. Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another.
Disconnect an app: its tokens stop working at once.
Why no key
Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another.
AccessA person, signed in. No API key can call this.
Operationoauth.write
Parameters
idpathstring
Responses
200Success
disconnectedenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Connecting an app is a person saying yes on a screen they can read. A key or a connected app cannot connect another. Only the person who connected the app, or an owner or admin, can disconnect it.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/auth/email/confirm/sendSend the confirmation link againPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationme.write
Responses
200Success
sentbooleanWhether a link was sent (false when the address is already confirmed).
confirmedbooleanWhether the address is already confirmed.
emailstring (email)The account's address.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. No email provider is configured on this deployment.
- 429Every failure has this shape.
Zuger Sealed
Who at Zuger may read the company's content, decided by its owner or an admin.
GET/v1/sealedRead Zuger Sealed for the companyPerson
No API key can call this. Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
Whether Sealed is on; Unseal requests waiting, grants open now and past; every value Zuger opened under a grant; changes to who could open sealed content.
Why no key
Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
AccessA person, signed in. No API key can call this.
Operationsealed.read
Responses
200Success
sealedobjectsealed
onbooleanWhether Sealed is on for this deployment.
keysenumWhere the keys are held, while it is on.
"aws-kms"·"local"·null
pendingarray of SealedRequestRequests waiting for an owner or admin.
pending
activearray of SealedRequestGrants open now.
active
historyarray of SealedRequestEverything else, newest first (50 requests at most in all).
history
accessarray of objectValues opened under a grant, newest first, 200 at most.
access
atstring (date-time)grantIdstringAn id.
staffstring | nullWho at Zuger, by name.
objectstringThe value opened.
securityarray of objectChanges to who could open sealed content, newest first.
security
atstring (date-time)kindstringWhat changed.
detailanyThe event's details.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
- 429Every failure has this shape.
GET/v1/sealed/access.csvExport every value Zuger opened as CSVPerson
No API key can call this. Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
Every value Zuger opened under a grant, as CSV: when, who, which value, which grant.
Why no key
Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
AccessA person, signed in. No API key can call this.
Operationsealed.read
Responses
200Success
filenameenum"zuger-sealed-access.csv"csvstringColumns: when, staff, value opened, grant (10,000 rows at most). Formula-safe.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
- 429Every failure has this shape.
GET/v1/sealed/logRead the Seal LogPerson
No API key can call this. Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
The Seal Log: every request, approval, denial, value opened, and ending, newest first. Read-only.
Why no key
Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
AccessA person, signed in. No API key can call this.
Operationsealed.read
Responses
200Success
sealStateCompanySealStateThe workspace's Seal (apps/api/src/seal-state.ts): sealed, a Seal request waiting for the company, or access open until a time.
sealState
rowsarray of objectNewest first.
rows
atstring (date-time)kindenum"requested"·"withdrawn"·"approved"·"denied"·"resealed"·"expired"·"lapsed"·"opened"stateenumThe Seal after it.
"sealed"·"request"actorstring | nullWho, by name.
atZugerbooleanWhether that person is at Zuger.
requestIdstringThe request (the grant, for a value opened).
scopestringRUN or DOCUMENTS (empty where unknown).
runIdstring | nullAn id.
documentIdsarray of stringobjectstringThe value opened.
minutesinteger | nullMinutes asked for or approved.
reasonstringWhy it was asked.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
- 429Every failure has this shape.
GET/v1/sealed/log.csvExport the Seal Log as CSVPerson
No API key can call this. Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
The Seal Log as CSV.
Why no key
Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
AccessA person, signed in. No API key can call this.
Operationsealed.read
Responses
200Success
filenameenum"zuger-seal-log.csv"csvstringColumns: when, what, seal, who, scope, value opened, minutes, request. Formula-safe.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
- 429Every failure has this shape.
GET/v1/sealed/stateRead the workspace's SealPerson
No API key can call this. Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
The workspace's Seal: sealed, a Seal request waiting (who, why, what, for how long), or access open (until when).
Why no key
Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
AccessA person, signed in. No API key can call this.
Operationsealed.read
Responses
200Success
sealStateCompanySealStateThe workspace's Seal (apps/api/src/seal-state.ts): sealed, a Seal request waiting for the company, or access open until a time.
sealState
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Who at Zuger read what is shown to the company's own people in the Console, not handed to an integration.
- 429Every failure has this shape.
POST/v1/sealed/requests/{id}Approve or deny a Seal requestPerson
No API key can call this. Letting a person at Zuger read a company's content, or ending it, is decided by an owner or admin, signed in.
Approve a Seal request (minutes: 15, 60 or 240, never more than asked) with a passkey assertion bound to it, or deny it: decision is approve or deny. Owner or admin. One open at a time.
A 400 when the request was withdrawn, decided or lapsed, or another grant is open (one at a time).
Why no key
Letting a person at Zuger read a company's content, or ending it, is decided by an owner or admin, signed in.
AccessA person, signed in. No API key can call this.
Operationsealed.decide
Parameters
idpathstring
Request bodyrequired
decisionenum"approve"·"deny"minutesenumHow long to approve it for, never more than asked; the longest allowed when left out.
15·60·240assertionobjectThe passkey assertion bound to this request.
assertion
credentialIdstringThe passkey's credential id.
challengestringThe
tokenfrom the signature call.responseobjectThe WebAuthn assertion response.
Responses
200Success
requestSealedRequestA Seal request, as the company sees it: people at Zuger by name only.
request
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Letting a person at Zuger read a company's content, or ending it, is decided by an owner or admin, signed in. Not the owner or an admin, the request is your own, or the passkey did not check out.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/sealed/grants/{id}/endEnd an open Unseal grant nowPerson
No API key can call this. Letting a person at Zuger read a company's content, or ending it, is decided by an owner or admin, signed in.
End an open Unseal grant now. Owner or admin. Reading under it stops at once.
A 400 when there is no open grant by that id.
Why no key
Letting a person at Zuger read a company's content, or ending it, is decided by an owner or admin, signed in.
AccessA person, signed in. No API key can call this.
Operationsealed.decide
Parameters
idpathstring
Responses
200Success
endedenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Letting a person at Zuger read a company's content, or ending it, is decided by an owner or admin, signed in. Not the owner or an admin.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/sealed/requests/{id}/signatureStart approving a Seal request with a passkeyPerson
No API key can call this. Letting a person at Zuger read a company's content, or ending it, is decided by an owner or admin, signed in.
Start approving a Seal request: a passkey challenge bound to this one request. Owner or admin.
A 400 when the request was withdrawn, decided, or lapsed.
Why no key
Letting a person at Zuger read a company's content, or ending it, is decided by an owner or admin, signed in.
AccessA person, signed in. No API key can call this.
Operationsealed.decide
Parameters
idpathstring
Responses
200Success
optionsobjectWebAuthn request options for
navigator.credentials.get, bound to this one request.tokenstringThe challenge token, sent back as
assertion.challenge.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Letting a person at Zuger read a company's content, or ending it, is decided by an owner or admin, signed in. Not the owner or an admin, or the request is your own.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
Chats
Telegram and WhatsApp linked to a person.
GET/v1/channelsList the chat channels and your links to themPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.read
Responses
200Success
channelsarray of objectchannels
channelenum"TELEGRAM"·"WHATSAPP"usablebooleanWhether this deployment has the channel set up.
handlestring | nullThe bot's username (Telegram) or the number's digits (WhatsApp), where usable.
linkedarray of objectYour chats linked to this company, newest first.
linked
idstringThe link.
linkedAtstring | nulllastInboundAtstring | nullWhen you last wrote from the chat.
addressstring | nullWhatsApp: the number's last four digits (…1234); null for Telegram.
contentenumWhat may leave Zuger into a chat: titles, short answers and links, or the full answers.
"LINKS"·"FULL"canSetContentbooleanWhether you may change it (the owner).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
PATCH/v1/channels/contentChoose what may leave Zuger into a chatPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Request bodyrequired
contentenumLINKS: titles, answers cut to 600 characters, links. FULL: the full answers.
"LINKS"·"FULL"
Responses
200Success
contentenum"LINKS"·"FULL"
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in. Not the owner.
- 429Every failure has this shape.
POST/v1/telegram/linkStart linking Telegram (older Consoles)Person
No API key can call this. It needs a person, signed in.
The same as POST /v1/channels/telegram/link, with the bot's name.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Responses
201Success
botstring | nullThe bot's username.
channelenum"TELEGRAM"·"WHATSAPP"codestringThe code to send from the chat.
urlstring (uri)A link that opens the chat with the code ready (t.me or wa.me).
instructionstringWhat to do, in words.
expiresAtstring (date-time)When the code lapses (15 minutes).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
DELETE/v1/channels/links/{id}Unlink a chatPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
idpathstring
Responses
200Success
removedenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 404No such link of yours.
- 429Every failure has this shape.
POST/v1/channels/{channel}/linkStart linking a chatPerson
No API key can call this. It needs a person, signed in.
channel is telegram or whatsapp (any case). A new code retires the last one waiting.
AccessA person, signed in. No API key can call this.
Operationsettings.write
Parameters
channelpathstring
Responses
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 404No such channel.
- 429Every failure has this shape.
Privacy and your account
The company's export and deletion, and a person's requests about their data.
GET/v1/data-requestsList your data requestsPerson
No API key can call this. A person's own requests about their data are theirs to read, signed in. A key is not that person.
Your own requests to Zuger about your data, with their due dates.
Why no key
A person's own requests about their data are theirs to read, signed in. A key is not that person.
AccessA person, signed in. No API key can call this.
Operationprivacy.read
Responses
200Success
requestsarray of DataRequestViewYour last 20, newest first.
requests
kindsarray of enumroleenumYour role in this company.
"OWNER"·"ADMIN"·"MEMBER"·nullselfServeobjectFor each kind, what you can do yourself instead:
export(owners and admins, access and portability),delete(the owner, erasure), or null.selfServe
ACCESSenum"export"·"delete"·nullRECTIFICATIONenum"export"·"delete"·nullERASUREenum"export"·"delete"·nullPORTABILITYenum"export"·"delete"·nullOBJECTIONenum"export"·"delete"·nullOTHERenum"export"·"delete"·null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403A person's own requests about their data are theirs to read, signed in. A key is not that person.
- 429Every failure has this shape.
POST/v1/data-requestsAsk Zuger about your dataPerson
No API key can call this. Asking Zuger for your data, its correction or its erasure is a person's right, used in person: their session is how Zuger knows it is them.
Ask Zuger about your data (GDPR): access, correction, erasure, portability, objection, or other. Answered within a month.
Why no key
Asking Zuger for your data, its correction or its erasure is a person's right, used in person: their session is how Zuger knows it is them.
AccessA person, signed in. No API key can call this.
Operationprivacy.request
Request bodyrequired
kindenumWhat you are asking for (case is ignored).
"ACCESS"·"RECTIFICATION"·"ERASURE"·"PORTABILITY"·"OBJECTION"·"OTHER"messagestringYour own words, at most 1,000 characters.
Responses
201Created. Your session is your proof of identity; a receipt is emailed.
requestDataRequestViewOne of your requests about your data.
request
notestringWhen Zuger answers by, and where the receipt went.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Asking Zuger for your data, its correction or its erasure is a person's right, used in person: their session is how Zuger knows it is them.
- 429Every failure has this shape.
POST/v1/account/deleteAsk for the company to be deletedPerson
No API key can call this. Deleting a company is the owner's decision, made in person.
Ask for the company to be deleted in thirty days. Owner only; the company name confirms it.
Why no key
Deleting a company is the owner's decision, made in person.
AccessA person, signed in. No API key can call this.
Operationaccount.delete
Request bodyrequired
confirmstringThe company's name, typed to confirm (compared without case).
Responses
200Scheduled. Agents and routines pause, the plan is set not to renew, and Store charges stop now.
dueAtstring (date-time)When it will be deleted: thirty days on.
notestringWhat happens, and that it can be taken back until then.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Deleting a company is the owner's decision, made in person. Only the owner can ask for this.
- 429Every failure has this shape.
GET/v1/account/exportExport everything the company hasPerson
No API key can call this. The export is everything a company has. It is handed to a person who signed in, never to a key.
Everything the company has in Zuger, as one document. Owner or admin. No secrets are included.
Why no key
The export is everything a company has. It is handed to a person who signed in, never to a key.
AccessA person, signed in. No API key can call this.
Operationaccount.export
Responses
200Success
exportedAtstring (date-time)formatenum"zuger-export-1"notestringWhat the file holds and what it leaves out.
cappedobjectWhere a list was cut (2,000 Runs, 5,000 approvals or memories, 20,000 audit events).
capped
runsbooleanapprovalsbooleanmemorybooleanauditEventsboolean
companyobject | nullThe company: id, name, residency, createdAt and its subscription (plan, status, period end, billing country and name, VAT number).
entitiesarray of objectpeoplearray of objectpeople
namestring | nullemailstring (email)roleenum"OWNER"·"ADMIN"·"MEMBER"sincestring (date-time)
agentsarray of objectrunsarray of objectapprovalsarray of objectmemoryarray of objectroutinesarray of objectconnectionsarray of objectconnections
providerstringdisplayNamestring | nullstatusstringaccessstringscopesarray of stringcreatedAtstring (date-time)lastUsedAtstring | null
invoicesarray of objectmarketplaceobjectmarketplace
hiresarray of objectlistingsarray of objectreviewsarray of object
auditLogarray of objectfilesarray of objectfiles
idstringAn id.
filenamestringmimeTypestringsizeBytesintegersha256stringrunIdstring | nullAn id.
createdAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403The export is everything a company has. It is handed to a person who signed in, never to a key. Only an owner or admin can export.
- 429Every failure has this shape.
POST/v1/data-requests/confirmConfirm your identity for a data requestPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_data_requests_confirm
Request bodyrequired
tokenstringThe token from the identity link Zuger emailed (
#/data-confirm/<token>), valid seven days, once.
Responses
200Success
confirmedenumtruekindenum"ACCESS"·"RECTIFICATION"·"ERASURE"·"PORTABILITY"·"OBJECTION"·"OTHER"answerBystring (date-time)The date Zuger answers by.
- 400Every failure has this shape.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/data-requests/confirm \
-H "Content-Type: application/json" \
-d '{"token": "…"}'POST/v1/data-requests/exportDownload your data exportPerson
Why no key
The export Zuger prepared for a data request is everything it holds about one person. It is handed to that person, signed in, never to a key.
AccessA person, signed in. No API key can call this.
Operationprivacy.export
Request bodyrequired
tokenstringThe token from the download link Zuger emailed (
#/data-export/<token>): the newest one, valid 24 hours, once.
Responses
200The file, made now. The request is then answered.
formatenum"zuger-data-request-1"exportedAtstring (date-time)requeststringThe data request it answers.
notestringpersonobjectperson
idstringAn id.
emailstring (email)namestring | nulllocalestring | nullemailConfirmedbooleancreatedAtstring (date-time)passkeysarray of objectpasskeys
devicestring | nullcountrystring | nullcreatedAtstring (date-time)lastUsedAtstring | nullremovedAtstring | null
signInsAndSecurityarray of objectYour last 1,000 security events.
signInsAndSecurity
kindstringcountrystring | nullcreatedAtstring (date-time)
dataRequestsarray of objectdataRequests
idstringAn id.
kindstringstatusstringreceivedAtstring (date-time)dueAtstring (date-time)extendedTostring | nullclosedAtstring | null
companiesarray of objectcompanies
companyIdstringAn id.
namestringroleenum"OWNER"·"ADMIN"·"MEMBER"sincestring (date-time)exportobjectAs an owner or admin: the company's whole export, as GET /v1/account/export answers it.
notestringAs a member: why only your own actions are here.
yourActionsarray of objectAs a member: your actions in the company's audit log, without payloads.
yourActions
seqintegercreatedAtstring (date-time)actionstringsubjectTypestringsubjectIdstring | null
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403The export Zuger prepared for a data request is everything it holds about one person. It is handed to that person, signed in, never to a key. The link is for another account: sign in as the person it was sent to.
- 429Every failure has this shape.
GET/v1/unsubscribe/{token}Read an unsubscribe linkPublic
A browser opening this address is redirected to the Console's /unsubscribe page instead.
AccessPublic: no key and no sign-in.
Operationget_v1_unsubscribe_token_
Parameters
tokenpathstring
Responses
200Success
addressstringThe address the link is for, masked.
subscribedbooleanWhether it still gets news from Zuger.
sincestring | nullWhen it stopped getting news.
- 400Every failure has this shape.
- 404The link does not work, or its address is no longer on an account.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/unsubscribe/{token}POST/v1/unsubscribe/{token}Stop or restart news emailsPublic
JSON from the page, or a mail provider's RFC 8058 one-click POST (List-Unsubscribe=One-Click, form-encoded or multipart). Only news stops: emails about the account, billing, security and support still come.
AccessPublic: no key and no sign-in.
Operationpost_v1_unsubscribe_token_
Parameters
tokenpathstring
Request body
subscribebooleanTrue to get news again; anything else stops it.
List-UnsubscribeenumSent by a mail provider's one-click unsubscribe.
"One-Click"
Responses
200Success
addressstringThe address, masked.
subscribedboolean
- 400Every failure has this shape.
- 404The link does not work, or its address is no longer on an account.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/unsubscribe/{token} \
-H "Content-Type: application/json" \
-d '{"subscribe": true, "List-Unsubscribe": "One-Click"}'POST/v1/account/delete/cancelTake back a deletionPerson
Why no key
Deleting a company is the owner's decision, made in person.
AccessA person, signed in. No API key can call this.
Operationaccount.delete
Responses
200Success
cancelledenumtruenotestringWhat is running again and what stays paused.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Deleting a company is the owner's decision, made in person. Only the owner can take it back.
- 429Every failure has this shape.
Support
Writing to Zuger support.
GET/v1/supportList your conversations with Zuger supportPerson
No API key can call this. Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
Your conversations with Zuger support (an owner or an admin: all of the company's), newest activity first.
Why no key
Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
AccessA person, signed in. No API key can call this.
Operationsupport.use
Responses
200Success
threadsarray of SupportThreadNewest activity first, 100 at most.
threads
allbooleanWhether these are all of the company's (an owner or an admin).
unreadintegerConversations with a reply not read yet.
categoriesarray of enumlimitsobjectlimits
subjectMaxinteger120
bodyMaxinteger5,000
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
- 429Every failure has this shape.
POST/v1/supportWrite to Zuger supportPerson
No API key can call this. Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
Write to Zuger support: a subject, a category and a message, optionally about one Run or approval.
Ten new conversations a day per person.
Why no key
Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
AccessA person, signed in. No API key can call this.
Operationsupport.use
Request bodyrequired
subjectstringOne line, 120 characters at most.
categoryenum"billing"·"agents"·"connections"·"account"·"bug"·"other"bodystringThe message, plain text, 5,000 characters at most.
runIdstringA Run of this company it is about.
approvalIdstringAn approval of this company it is about.
Responses
200Success
threadSupportThreadthread
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
- 429Every failure has this shape.
GET/v1/support/{id}Read a conversation with Zuger supportPerson
No API key can call this. Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
One conversation with Zuger support and its messages.
Why no key
Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
AccessA person, signed in. No API key can call this.
Operationsupport.use
Parameters
idpathstring
Responses
200Success
threadSupportThreadthread
ratingSupportRating"Was this helpful?": null when it is not asked and was never answered.
rating
messagesarray of objectOldest first, 500 at most.
messages
idstringAn id.
fromenum"CUSTOMER"·"STAFF"bystring | nullWho wrote it: a member by name, or "<first name>" at Zuger.
minebooleanWritten by this person (customer messages).
bodystringcreatedAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
- 404No such conversation for this person (a member reads their own).
- 429Every failure has this shape.
POST/v1/support/{id}/closeClose a conversationPerson
No API key can call this. Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
Close a conversation with Zuger support. Writing in it again opens it again.
A 400 when it is closed already.
Why no key
Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
AccessA person, signed in. No API key can call this.
Operationsupport.use
Parameters
idpathstring
Responses
200Success
idstringAn id.
statusenum"DONE"closedAtstring (date-time)
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/support/{id}/messagesWrite again in a conversationPerson
No API key can call this. Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
Write again in a conversation with Zuger support.
Sixty messages an hour per person. Writing in a closed conversation opens it again.
Why no key
Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
AccessA person, signed in. No API key can call this.
Operationsupport.use
Parameters
idpathstring
Request bodyrequired
bodystringThe message, plain text, 5,000 characters at most.
Responses
200Success
messageobjectmessage
idstringAn id.
fromenum"CUSTOMER"mineenumtruebodystringcreatedAtstring (date-time)
statusenum"OPEN"·"WAITING_ON_ZUGER"reopenedbooleanWhether it was closed before.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
POST/v1/support/{id}/ratingSay whether Zuger's answer helpedPerson
No API key can call this. Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
Say whether Zuger's answer helped (yes or no, and an optional line), once Zuger has closed the conversation. It can be changed for 7 days.
A 400 unless Zuger closed the conversation, or once the 7 days to change it are over.
Why no key
Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
AccessA person, signed in. No API key can call this.
Operationsupport.use
Parameters
idpathstring
Request bodyrequired
ratingenum"yes"·"no"notestring | nullAn optional line, 300 characters at most.
Responses
200Success
ratingSupportRating"Was this helpful?": null when it is not asked and was never answered.
rating
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403Writing to Zuger support is a person asking a person. Replies are signed by someone at Zuger and read in the Console, never by a key.
- 404Nothing by that id in this company.
- 429Every failure has this shape.
Notifications and diagnostics
Browser notifications and the Console's own diagnostics.
POST/v1/diagnostics/viewportSend the Console's viewport measurementsPerson
No API key can call this. It needs a person, signed in.
For the Console's own layout diagnostics. Up to 48 keys; numbers, booleans and a few named strings are kept in the log, nothing a person typed.
AccessA person, signed in. No API key can call this.
Operationdiagnostics.write
Request bodyrequired
notemap of anyMeasurements by name (letters, digits and _, 24 characters at most).
Responses
200Success
notedenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
GET/v1/push/keyRead the key for browser notificationsPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationpush.read
Responses
200Success
publicKeystring | nullThe VAPID public key to subscribe with, or null where browser notifications are not set up.
emailbooleanWhether this deployment can send email.
telegrambooleanWhether this deployment has Telegram.
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
POST/v1/push/subscribeSwitch on browser notifications for this browserPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationpush.write
Request bodyrequired
endpointstring (uri)The push subscription's endpoint: a browser's push service only (Google, Mozilla, Apple, Windows).
keysobjectThe subscription's keys, as the browser gives them.
keys
p256dhstringauthstring
Responses
201Success
savedenumtrue
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
POST/v1/push/unsubscribeSwitch off browser notifications for this browserPerson
No API key can call this. It needs a person, signed in.
AccessA person, signed in. No API key can call this.
Operationpush.write
Request bodyrequired
endpointstring (uri)The push subscription's endpoint.
Responses
200Success
removedintegerHow many subscriptions were removed (0 or 1).
- 400Every failure has this shape.
- 401Not signed in: no session, or no valid API key.
- 403No API key can call this. It needs a person, signed in.
- 429Every failure has this shape.
Status and public
Public reads: the status page, the deployment, the legal pages.
GET/v1/addressRead your own address as the API sees itPublic
Your own address, as the API sees it: what its per-address limits count. Nothing else.
AccessPublic: no key and no sign-in.
Operationget_v1_address
Responses
200Success
addressstring | nullThe client address the per-address limits count, or null where none is known.
- 400Every failure has this shape.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/addressPOST/v1/contactSend a request through the site's contact formPublic
The site's own form, not an integration's: not on api.zuger.ai. A 404 until Zuger turns the form on. The answer is the same, and takes the same time, whatever is known of the address. Five an hour from one IP address and five a day from one email address; over the address's limit nothing is kept and the answer does not change. 12 KB at most. Kept 12 months.
AccessPublic: no key and no sign-in.
Operationpost_v1_contact
Request bodyrequired
firststringFirst name (100 characters at most).
laststringLast name (100 characters at most).
emailstring (email)Where to reply (254 characters at most).
companystring200 characters at most.
countrystring100 characters at most.
topicstring100 characters at most.
messagestring2,000 characters at most.
langstringThe language of the page (en, de, fr, es, it, ja, zh-CN, ar); English otherwise.
bot_fieldstringLeft empty by people. Filled in, the answer is the same and nothing is kept.
turnstile_tokenstringA Cloudflare Turnstile token, required where the deployment has Turnstile set.
Responses
200Success
okenumtrue
- 400Every failure has this shape.
- 403The Turnstile check did not pass.
- 404The form is off.
- 429Every failure has this shape.
- 503The Turnstile check could not run, or the form has taken as much as it may this hour. Nothing was kept.
curl -X POST https://beta.zuger.ai/v1/contact \
-H "Content-Type: application/json" \
-d '{"first": "…", "last": "…", "email": "…"}'GET/v1/deploymentRead what this deployment can doPublic
AccessPublic: no key and no sign-in.
Operationget_v1_deployment
Responses
200Success
modelsReadybooleanWhether agents can call a model here.
webSearchbooleanWhether briefs can search the public web here.
mcpstring (uri)The MCP server's address, where it is served from its own host.
- 400Every failure has this shape.
- 429Every failure has this shape.
curl https://beta.zuger.ai/v1/deploymentGET/v1/legal/{page}Read the Terms, the Privacy policy or the Security pagePublic
The Terms, the Privacy policy or the Security page (terms, privacy, security), as the website publishes them: title, lead, notice, table of contents and the text as sanitised HTML. The English text is the binding one.
page is terms, privacy or security. Kept by the server for ten minutes and by a browser for five (cache-control: public, max-age=300).
AccessPublic: no key and no sign-in.
Operationget_v1_legal_page_
Parameters
pagepathstring
Responses
200Success
pageenum"terms"·"privacy"·"security"titlestringThe page's heading, as plain text.
leadstringThe line under the heading; empty when there is none.
noticestring | nullThe notice above the text (draft, last updated), as sanitised HTML.
tocarray of objectThe page's table of contents, in order.
toc
idstringAn anchor in
html.labelstring
htmlstringThe legal text as sanitised HTML: text tags, links and anchors only.
sourcestring (uri)Where it was read from.
fetchedAtstring (date-time)When the server read it from the website.
stalebooleanTrue while the website cannot be read and an older copy is served.
- 400Every failure has this shape.
- 404No such page: ask for terms, privacy or security.
- 429Every failure has this shape.
- 503The text could not be read and no copy is held.
curl https://beta.zuger.ai/v1/legal/{page}POST/v1/status/confirmConfirm a status page subscriptionPublic
A 400 when the link is not valid, ran out (seven days), was used already, or a newer one was sent.
AccessPublic: no key and no sign-in.
Operationpost_v1_status_confirm
Request bodyrequired
tokenstringThe token from the
#confirm=link in the email.
Responses
200Success
confirmedenumtrue
- 400Every failure has this shape.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/status/confirm \
-H "Content-Type: application/json" \
-d '{"token": "…"}'POST/v1/status/one-clickStop status page emails in one click (RFC 8058)Public
The address in an update email's List-Unsubscribe header. The body a mail client posts is not read.
AccessPublic: no key and no sign-in.
Operationpost_v1_status_one_click
Parameters
tokenquerystringThe unsubscribe token.
Responses
200Success
unsubscribedenumtrue
- 400Every failure has this shape.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/status/one-clickPOST/v1/status/subscribeAsk for status page updates by emailPublic
Ask to be emailed when Zuger posts an incident on its status page, an update or its end. A link to confirm is sent first; the answer is the same for any address.
The answer is the same, and takes the same time, for a new, a waiting and a confirmed address. One confirmation email every 15 minutes and three a day per address.
AccessPublic: no key and no sign-in.
Operationpost_v1_status_subscribe
Request bodyrequired
emailstring (email)Where to send the updates (254 characters at most).
langstringThe language of the emails (en, de, fr, es, it, ja, zh-CN, ar); English otherwise.
Responses
200Success
okenumtruenotestring"If that address can receive them, a link to confirm is on its way…"
- 400Every failure has this shape.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/status/subscribe \
-H "Content-Type: application/json" \
-d '{"email": "…"}'POST/v1/status/unsubscribeStop status page emailsPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_status_unsubscribe
Request bodyrequired
tokenstringThe token from the
#unsubscribe=link in an update email.
Responses
200Success
unsubscribedenumtrue
- 400Every failure has this shape.
- 429Every failure has this shape.
curl -X POST https://beta.zuger.ai/v1/status/unsubscribe \
-H "Content-Type: application/json" \
-d '{"token": "…"}'Inbound hooks
Addresses Zuger's own providers call (Stripe, Telegram, WhatsApp, Resend, the key service). Your app does not call them.
POST/billing/stripe/webhookReceive a Stripe eventPublic
For Stripe. The body is a Stripe event, verified against the exact bytes received with stripe-signature; Zuger reads what it means back from Stripe.
AccessPublic: no key and no sign-in.
Operationpost_billing_stripe_webhook
Parameters
stripe-signatureheaderstringStripe's signature over the raw body.
Responses
200Success
appliedbooleanbecausestringWhat was done, or why nothing was.
- 400Every failure has this shape.
- 429Every failure has this shape.
POST/v1/billing/webhookReceive a Stripe event (alias)Public
The same as POST /billing/stripe/webhook.
AccessPublic: no key and no sign-in.
Operationpost_v1_billing_webhook
Parameters
stripe-signatureheaderstringStripe's signature over the raw body.
Responses
200Success
appliedbooleanbecausestringWhat was done, or why nothing was.
- 400Every failure has this shape.
- 429Every failure has this shape.
POST/v1/hooks/kmsReceive a key service eventPublic
AccessPublic: no key and no sign-in.
Operationpost_v1_hooks_kms
Parameters
x-zuger-kms-secretheaderstringThe shared secret for this hook. Wrong or missing: 404.
Request bodyrequired
Responses
200Success
recordedbooleanWhether it is a change every company is told of.
kindenum"kms.key_policy_changed"·"kms.grant_changed"·"kms.key_state_changed"·"kms.decrypt_unexpected"
- 400Every failure has this shape.
- 404The secret did not match, or the hook is not set up here.
- 429Every failure has this shape.
POST/v1/hooks/resendReceive an email delivery report from ResendPublic
Signed by Svix (svix-id, svix-timestamp, svix-signature, five minutes either way); unsigned or wrong: 404.
AccessPublic: no key and no sign-in.
Operationpost_v1_hooks_resend
Request bodyrequired
Responses
200Success
appliedbooleaneventenumWhat was recorded.
"DELIVERED"·"DELAYED"·"BOUNCED"·"COMPLAINED"·"FAILED"toldintegerOps alerts raised (a hard bounce or a complaint on an owner's email).
becausestringWhy nothing was recorded.
- 400Every failure has this shape.
- 404The signature did not verify.
- 429Every failure has this shape.
POST/v1/hooks/unresolvedReceive a vendor delivery the router could not placePublic
Zuger's own router only: without its proof this is a 404. Off by default: a 503, nothing is kept, and the vendor delivers again.
AccessPublic: no key and no sign-in.
Operationpost_v1_hooks_unresolved
Parameters
x-zuger-router-vendorheaderstringWhich vendor sent it: stripe, telegram, whatsapp, resend or kms.
x-zuger-router-original-pathheaderstringThe address the vendor called.
Responses
202Success
heldenumtrue
- 400Every failure has this shape.
- 404Not the router, or the vendor's signature did not verify.
- 429Every failure has this shape.
- 503Not held: deliver it again.
POST/v1/telegram/webhookReceive a Telegram updatePublic
AccessPublic: no key and no sign-in.
Operationpost_v1_telegram_webhook
Parameters
x-telegram-bot-api-secret-tokenheaderstringThe secret Zuger set with the webhook. Wrong or missing: 404.
Request bodyrequired
Responses
200Success
handledbooleanbecausestring
- 400Every failure has this shape.
- 404The secret did not match.
- 429Every failure has this shape.
GET/v1/whatsapp/webhookAnswer WhatsApp's webhook verificationPublic
Meta's check when the webhook is set up: with hub.mode=subscribe and Zuger's hub.verify_token, it echoes hub.challenge as text. Anything else: 404.
AccessPublic: no key and no sign-in.
Operationget_v1_whatsapp_webhook
Parameters
hub.modequeryAlways
subscribe.hub.verify_tokenquerystringThe verify token set in Meta's webhook configuration (
WHATSAPP_VERIFY_TOKEN).hub.challengequerystringWhat to echo back: letters, digits,
.,_or-, up to 256.
Responses
- 400Every failure has this shape.
- 404Not Meta's check, or the verify token did not match.
- 429Every failure has this shape.
POST/v1/whatsapp/webhookReceive a WhatsApp deliveryPublic
Answered at once; the messages are handled after.
AccessPublic: no key and no sign-in.
Operationpost_v1_whatsapp_webhook
Parameters
x-hub-signature-256headerstringsha256=<HMAC-SHA256 of the raw body with the app secret>. Wrong or missing: 404.
Request bodyrequired
Responses
200Success
receivedenumtrue
- 400Every failure has this shape.
- 404The signature did not verify.
- 429Every failure has this shape.
POST/v1/hooks/stripe/whereSay which region a Stripe event's charge belongs toPublic
Zuger's own router only: without its proof and Stripe's signature this is a 404. Frankfurt only. The charge is read from Stripe and nothing is kept.
AccessPublic: no key and no sign-in.
Operationpost_v1_hooks_stripe_where
Parameters
stripe-signatureheaderstringStripe's signature over the raw body.
Responses
200Success
regionstringThe region's code, or null when nobody can say.
- 400Every failure has this shape.
- 404Not the router, or the signature did not verify.
- 429Every failure has this shape.
- 503Off here, or Stripe could not be asked: deliver it again.
POST/v1/hooks/telegram/whereSay whether a Telegram chat is linked in this regionPublic
Zuger's own router only: without its proof and Telegram's secret this is a 404. Nothing is kept.
AccessPublic: no key and no sign-in.
Operationpost_v1_hooks_telegram_where
Parameters
x-telegram-bot-api-secret-tokenheaderstringTelegram's secret for this bot.
Request bodyrequired
chatstringThe chat's id.
Responses
200Success
knownbooleanWhether the chat is linked to someone here.
- 400Every failure has this shape.
- 404Not the router, the secret did not match, or that is not a chat.
- 429Every failure has this shape.
Webhooks
Zuger calls an address of yours when one of these happens. A call carries ids and states only, never a document or an approval’s reasoning: read the detail from the API with a key that has the scope. Each is signed: X-Zuger-Signature: t=…,v1=…, where v1 is HMAC-SHA256 of t + "." + body with the secret shown once when you add the address. Add one with POST /v1/webhooks; POST /v1/webhooks/{id}/ping sends a test.
POSTrun.finishedAn agent finished a Run, or stopped to wait for a decision
Operationwebhook.run.finished
Parameters
x-zuger-signatureheaderstringt=<seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">with the address's signing secret. Check it against the exact bytes received, and refuse atmore than five minutes away.x-zuger-eventheaderstringx-zuger-deliveryheaderstring
Request bodyrequired
idstringThis delivery's id (
whd_…), also inx-zuger-delivery. A retry carries the same id: use it to see a delivery twice once.typeenumThe event, also in
x-zuger-event."run.finished"createdstring (date-time)When the event was queued.
companyIdstringThe company.
dataobjectdata
runIdstringThe Run.
agentstring | nullThe kind of agent (
CHIEF_OF_STAFF,LEDGER, …), or null where Zuger itself made it.statusstringThe Run's status as written:
DONE,AWAITING_APPROVAL,AWAITING_INPUT,HELD_BY_BERNINA,STOPPED_BY_BERNINA, …costMinorintegerWhat its model calls cost, in US cents.
POSTrun.failedA Run could not finish
Operationwebhook.run.failed
Parameters
x-zuger-signatureheaderstringt=<seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">with the address's signing secret. Check it against the exact bytes received, and refuse atmore than five minutes away.x-zuger-eventheaderstringx-zuger-deliveryheaderstring
Request bodyrequired
idstringThis delivery's id (
whd_…), also inx-zuger-delivery. A retry carries the same id: use it to see a delivery twice once.typeenumThe event, also in
x-zuger-event."run.failed"createdstring (date-time)When the event was queued.
companyIdstringThe company.
dataobjectdata
runIdstringThe Run.
agentstring | nullThe kind of agent (
CHIEF_OF_STAFF,LEDGER, …), or null where Zuger itself made it.statusenum"FAILED"
POSTapproval.createdSomething consequential is waiting on a human
Operationwebhook.approval.created
Parameters
x-zuger-signatureheaderstringt=<seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">with the address's signing secret. Check it against the exact bytes received, and refuse atmore than five minutes away.x-zuger-eventheaderstringx-zuger-deliveryheaderstring
Request bodyrequired
idstringThis delivery's id (
whd_…), also inx-zuger-delivery. A retry carries the same id: use it to see a delivery twice once.typeenumThe event, also in
x-zuger-event."approval.created"createdstring (date-time)When the event was queued.
companyIdstringThe company.
dataobjectdata
approvalIdstringThe approval.
runIdstring | nullThe Run that asked, if any.
categorystringThe approval's category (
MONEY_OUT,FILING,CONTRACT,CUSTOMER_FACING,DATA_WRITE, …).agentstring | nullThe kind of agent (
CHIEF_OF_STAFF,LEDGER, …), or null where Zuger itself made it.
POSTapproval.decidedA human approved or rejected it
Operationwebhook.approval.decided
Parameters
x-zuger-signatureheaderstringt=<seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">with the address's signing secret. Check it against the exact bytes received, and refuse atmore than five minutes away.x-zuger-eventheaderstringx-zuger-deliveryheaderstring
Request bodyrequired
idstringThis delivery's id (
whd_…), also inx-zuger-delivery. A retry carries the same id: use it to see a delivery twice once.typeenumThe event, also in
x-zuger-event."approval.decided"createdstring (date-time)When the event was queued.
companyIdstringThe company.
dataobjectdata
approvalIdstringThe approval.
runIdstring | nullThe Run that asked, if any.
categorystringThe approval's category (
MONEY_OUT,FILING,CONTRACT,CUSTOMER_FACING,DATA_WRITE, …).statusenumThe decision.
"APPROVED"·"REJECTED"byUserIdstringWho decided.
POSTapproval.doneA human marked what they approved as carried out
Operationwebhook.approval.done
Parameters
x-zuger-signatureheaderstringt=<seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">with the address's signing secret. Check it against the exact bytes received, and refuse atmore than five minutes away.x-zuger-eventheaderstringx-zuger-deliveryheaderstring
Request bodyrequired
idstringThis delivery's id (
whd_…), also inx-zuger-delivery. A retry carries the same id: use it to see a delivery twice once.typeenumThe event, also in
x-zuger-event."approval.done"createdstring (date-time)When the event was queued.
companyIdstringThe company.
dataobjectdata
approvalIdstringThe approval.
runIdstring | nullThe Run that asked, if any.
categorystringThe approval's category (
MONEY_OUT,FILING,CONTRACT,CUSTOMER_FACING,DATA_WRITE, …).byUserIdstringWho marked it done.
POSTkya.stoppedA person stopped agents with an emergency stop
Operationwebhook.kya.stopped
Parameters
x-zuger-signatureheaderstringt=<seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">with the address's signing secret. Check it against the exact bytes received, and refuse atmore than five minutes away.x-zuger-eventheaderstringx-zuger-deliveryheaderstring
Request bodyrequired
idstringThis delivery's id (
whd_…), also inx-zuger-delivery. A retry carries the same id: use it to see a delivery twice once.typeenumThe event, also in
x-zuger-event."kya.stopped"createdstring (date-time)When the event was queued.
companyIdstringThe company.
dataobjectdata
stopIdstringThe stop.
scopeenumWhat it reached: one agent, the whole fleet, or the agents that hold one skill.
"agent"·"operator"·"skill"agentIdstring | nullThe agent, for an
agentstop.skillstring | nullThe skill (a scope such as
publish:social), for askillstop.agentIdsarray of stringEvery agent the stop took off shift.
runsCancelledintegerRuns that were under way or waiting, ended and never charged.
stoppedAtstring (date-time)When it became a stop.
POSTpingA test sent from the Console or POST /v1/webhooks/{id}/ping
Operationwebhook.ping
Parameters
x-zuger-signatureheaderstringt=<seconds>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">with the address's signing secret. Check it against the exact bytes received, and refuse atmore than five minutes away.x-zuger-eventheaderstringx-zuger-deliveryheaderstring
Request bodyrequired
idstringThis delivery's id (
whd_…), also inx-zuger-delivery. A retry carries the same id: use it to see a delivery twice once.typeenumThe event, also in
x-zuger-event."ping"createdstring (date-time)When the event was queued.
companyIdstringThe company.
dataobjectdata
messagestring"A test from the Console. Nothing happened."
Schemas
The shapes routes share, as the OpenAPI document names them.
schemaAgent
idstringAn id.
kindenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"namestringIts name (Dom, Säntis, Kesch, …).
stateenumRUNNINGis on shift."RUNNING"·"PAUSED"·"STOPPED"pausedForPlanenumPaused because the plan has no room for it; it comes back by itself when there is.
truemandateobject | nullIts current mandate. The approval policy is never in it: an agent cannot read its own gate.
mandate
versionintegerownsarray of stringWhat it is responsible for.
decidesAlonearray of stringWhat it may do without asking.
alwaysReturnsarray of stringWhat it always brings back to a person.
toolsarray of stringThe tool scopes it reads through.
companyIdstringAn id.
schemaAgentsBriefQueuedThe brief, queued.
The brief, queued.
queuedenumtrueagentstringThe agent kind the brief went to.
atintegerWhen it was queued, in milliseconds since the epoch.
titlestringThe brief's first 90 characters.
documentsintegerHow many files it carries.
briefIdstringFollow it at
GET /v1/briefs/{id}/steps.runsintegerWhat it weighs, where it is a fixed-weight brief (a contract review: 5).
schemaAgentsLegalSource
statutestringThe statute or official text, by name and article ("Code of Obligations, Art. 699 para. 2").
urlstring (uri)A page to read it on.
publisherstringWhose page that is.
officialbooleanTrue when the page is the authority's or the statute's own.
schemaAgentsScheduleWhen it runs, in the routine's time zone. Weekdays are 0 (Sunday) to 6, as cron counts them.
When it runs, in the routine's time zone. Weekdays are 0 (Sunday) to 6, as cron counts them.
- object
everyenum"day"hourintegerminuteinteger
- object
everyenum"week"weekdayintegerhourintegerminuteinteger
- object
everyenum"month"dayintegerhourintegerminuteinteger
- object
everyenum"weekdays"hourintegerminuteinteger
schemaApprovalAn approval in a list.
An approval in a list.
offerobjectAn UpgradeOffer or a top-up card: what it is for (pricing v2026-10).
offer
kindenumA move up a plan, or a prepaid pack of Runs.
"UPGRADE"·"TOPUP"currentPlanstring | nullThe plan now (database code).
targetPlanstring | nullThe plan offered (database code).
targetPlanNamestring | nullThe plan offered, as customers know it.
intervalstring | nullmonthoryear.proratedMinorinteger | nullWhat moving up costs now, pro rata, in cents.
queuedRunCountinteger | nullRuns waiting for Runs when it was offered.
recommendationstring | nullWhy this offer.
comparisonany ofcomparison
- any The plans side by side, as the Console shows them.
- null
packRunsinteger | nullRuns in the pack, for a top-up.
packAmountMinorinteger | nullWhat the pack costs, in cents.
statusstringWhere the offer is (
OPEN,AWAITING_PAYMENT,PAID,DISMISSED,EXPIRED,SUPERSEDED, …).
outboundApprovalOutboundA message an agent prepared for a counterparty (v5 K1b): who it goes to, the From line, the words and the guardrails.
outbound
tostring (email)The address it goes to.
toNamestring | nullfromstring | nullThe From line, from the company's verified sending domain.
subjectstringbodystringThe words as they will be sent; a debtor-portal link is shown as
https://…/l/…, never the link itself.localestringchannelstringEMAIL.statusstringDRAFT,RELEASED,SENDING,SENT,REFUSED,FAILEDorCANCELLED.notBeforestring | nullsentAtstring | nullrefusedReasonstring | nullguardrailsarray of objectEach guardrail as the worker will read it now (for a draft), or as it was.
guardrails
keystringThe guardrail (
recipient,stop_contact,b2b_only,domain_verified,no_write_off, quiet hours, frequency, …).okbooleanuntilstringFor a wait: until when.
refusedstring | nullA hard guardrail that refuses it, for a draft.
waitUntilstring | nullFor a draft held only by waits: the earliest time it may go.
timezonestring | nullThe zone the quiet hours were read in.
draftedBystringWho drafted it (
SANTIS,KESCH,ZERMATT, …).purposestringWhy (
firm,final_notice, an invitation, …).citationsarray of objectWhat it rests on.
citations
kindstringsourcestringnumberstring | nullThe invoice number, for an invoice.
atstring | nullWhen the ledger or bank line was booked.
attachmentsarray of objectWhat goes with it (the invoice, its payment page, an .ics).
attachments
kindstring
instalmentsApprovalInstalmentsAn instalment plan Kesch proposed.
instalments
instalmentsarray of objectTwo to six, adding up to exactly what is owed.
instalments
seqintegerdueAtstringThe date it is due.
amountMinorintegerAn amount in the currency's minor unit (cents).
totalMinorintegerAn amount in the currency's minor unit (cents).
currencystringstatusenum"PROPOSED"·"ACTIVE"·"BROKEN"·"COMPLETED"·"REJECTED"·"CANCELLED"
filingPackApprovalFilingPackA filing pack Pilatus prepared. Pilatus prepares; you file.
filingPack
obligationIdstringAn id.
ruleIdstringtitlestringbodystringThe pack, in the founder's language.
localestringchecklistarray of stringWhat to check, ending with where the person files it themselves.
citationsarray of any ofcitations
- object
kindenum"rule"ruleIdstringstatutestringurlstring (uri)officialboolean
- object
kindenum"entity"idstringAn id.
- object
kindenum"ledger"sourceenum"invoices"·"bank"countintegeridsarray of stringconnectorsarray of string
- object
kindenum"document"countintegeridsarray of string
needsReviewbooleanRests on a rule that is not verified: to confirm with your adviser.
dueOnstring (date)periodStartstring (date)periodEndstring (date)statusenumThe obligation's status.
"UPCOMING"·"PREPARED"·"APPROVED"·"FILED"·"DISMISSED"jurisdictionstringentitystringThe entity's legal name.
whereToFileobject | nullWhere the person files it themselves; null where nothing is filed.
whereToFile
namestringurlstring (uri)
formationPackApprovalFormationPackAn Atlas-ready pack Pilatus prepared. Approving records that it was handed to you; you submit, sign and pay in Stripe Atlas.
formationPack
idstringThe pack.
approvalIdstringAn id.
localeenumThe language it was written in.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"entityTypeenum"C_CORP"·"LLC"legalNamestringThe name wanted.
titlestringbodystringThe pack, in the founder's language.
sheetarray of objectEvery field Stripe Atlas asks, in its order. Never an SSN, ITIN, date of birth or home address: those rows say you enter them in Stripe Atlas.
sheet
keystringWhat Stripe Atlas asks, e.g. company_name.
labelstringvaluestringstatusenum"prefilled"·"enter_in_atlas"·"decide_in_atlas"sourcesarray of string
checklistarray of stringcitationsarray of objectcitations
fieldstringsourcesarray of string
statusenum"PREPARED"·"HANDED_OVER"·"DECLINED"·"FORMED"handedAtstring | nullformedOnstring | nullformedEntityIdstring | nullAn id.
createdAtstring (date-time)atlasUrlstring (uri)https://stripe.com/atlas: where you apply yourself.
contractReviewApprovalContractReviewA contract review Titlis prepared, with its redlines.
contractReview
contractIdstringAn id.
titlestringcounterpartystring | nullourSidestring | nulllanguagestringThe contract's language.
verdictenum"blocked"·"flagged"·"meets"blockedintegerflaggedintegerlocalestringThe review's language (the founder's).
bodystringThe review.
effectiveOnstring | nulltermEndsOnstring | nullrenewsOnstring | nullnoticeBystring | nullplaybookVersionintegerreviewStatusenum"PROPOSED"·"TAKEN"·"DECLINED"·"LAPSED"findingsarray of TitlisFindingfindings
redlinesarray of objectredlines
positionIdenum"liability_cap"·"notice"·"renewal"·"term"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"severityenum"flag"·"block"refstring | nullThe clause's number.
quotestringThe words now.
suggestedstringThe words suggested, in the contract's language.
reasonstringA reason key, said in the reader's language by the Console.
varsmap of string | numberlocalestringcitationsarray of any ofcitations
- object
kindenum"clause"documentIdstringAn id.
refstringThe clause's number.
clauseenum"parties"·"term"·"renewal"·"notice"·"liability_cap"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"
- object
kindenum"document"documentIdstringAn id.
missingenum"parties"·"term"·"renewal"·"notice"·"liability_cap"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"
- object
kindenum"playbook"positionIdenum"liability_cap"·"notice"·"renewal"·"term"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"versionintegercovenantboolean
socialPostApprovalSocialPostA post or public reply Matterhorn drafted.
socialPost
idstringThe post.
approvalIdstringAn id.
channelenum"X"·"LINKEDIN"kindenum"POST"·"REPLY"statusenum"DRAFT"·"RELEASED"·"PUBLISHING"·"PUBLISHED"·"REFUSED"·"FAILED"·"CANCELLED"accountstring | nullThe account it is for.
textstringThe words, as they will be published.
localestringcharCountintegerAs the platform counts it.
charLimitintegerscheduledAtstring | nullWhen to publish; null: as soon as released.
timezonestring | nulllocalobject | nullThe time in its zone.
local
datestring (date)timestringHH:MM
replyToUrlstring | nullThe public post a reply answers.
citationsarray of objectclaimsanyThe claims in the words and what each rests on, as Matterhorn recorded them.
publishedAtstring | nullurlstring | nullWhere it was published.
refusedReasonstring | nullWhy it stopped (
withdrawn,channel_paused,rejected, …).notBeforestring | nullmetricsanyThe numbers read back from the platform, where any.
releasedAtstring | nullcreatedAtstring (date-time)approvalStatusstringIts approval's status.
expiresAtstring | nullWhen its approval lapses.
blockedenumWhat stands in the way of releasing it now; null when nothing does (or it is no longer a draft).
"off"·"account"·"reconnect"·"paused"·"stale"·nullblockedWhystringThe same, in words, where something stands in the way.
shortlistApprovalZermattShortlistA shortlist Zermatt proposed.
shortlist
roleIdstringAn id.
statusenum"PROPOSED"·"TAKEN"·"DECLINED"candidatesarray of objectcandidates
candidateIdstringAn id.
namestring | nullNull once erased.
stageenum"NEW"·"SHORTLISTED"·"INTERVIEWING"·"ON_HOLD"·"NOT_PROGRESSED"·"HIRED"·"WITHDRAWN"fitenumAgainst the role's written requirements; never a decision.
"STRONG"·"PARTIAL"·"UNCLEAR"proposedbooleanZermatt proposes them for the shortlist.
summarystringlocalestringrequirementsarray of objectrequirements
requirementstringfitenum"STRONG"·"PARTIAL"·"UNCLEAR"evidencestring
citationsarray of objectAt least two artefacts, one the candidate's own.
citations
kindenum"role"·"cv"·"note"idstringAn id.
interviewApprovalZermattInterviewAn interview invitation Zermatt prepared.
interview
idstringAn id.
candidatestringlocalestringThe language the candidate reads.
startsAtstring (date-time)endsAtstring (date-time)timezonestringThe candidate's zone.
companyTimezonestringformatstringVIDEO,PHONEorONSITE.locationstring | nullA link or an address, as the company gave it.
statusenum"PROPOSED"·"INVITED"·"SENT"·"CANCELLED"·"REFUSED"busyCheckedbooleanBusy times were read from the company's calendar.
icsUidstring
contractPackApprovalZermattContractPackA contract pack Zermatt prepared.
contractPack
idstringAn id.
titlestringcountrystringkindenum"EMPLOYEE"·"CONTRACTOR"localestringbodystringsectionsarray of objectsections
idstringheadingstringtextstringsourcesarray of stringreviewstring | nullWhat counsel should look at.
sourcesarray of objectsources
idstringstatutestringurlstring (uri)publisherstringofficialboolean
reviewFlagsarray of objectThe points for counsel.
reviewFlags
idstringtextstring
needsReviewbooleantemplateVersionstringstatusenum"PROPOSED"·"APPROVED"·"DECLINED"titlisbooleanSent on to Titlis for a review.
titlisQueuedAtstring | null
engActionApprovalEngActionA comment, issue or labels Gotthard prepared.
engAction
idstringThe finding.
approvalIdstringAn id.
channelenum"GITHUB"·"LINEAR"kindenum"COMMENT"·"ISSUE"·"LABELS"findingenumWhich of Gotthard's four jobs it came from.
"TRIAGE"·"REPRO"·"REVIEW"·"CHANGELOG"statusenum"DRAFT"·"RELEASED"·"POSTING"·"POSTED"·"REFUSED"·"FAILED"·"CANCELLED"accountstring | nulltargetstringThe repository or team.
numberinteger | nullThe issue or pull request.
isPullbooleanrefstringWhere, as written on the platform (
owner/repo#12).placeUrlstring | nulltitlestring | nullbodystring | nullWhat would be posted.
localestringcharCountintegerlabelsarray of stringprioritystring | nullduplicateOfstring | nullownerstring | nullcitationsarray of objecturlstring | nullWhere it was posted.
postedAtstring | nullpostedNumberinteger | nullrefusedReasonstring | nullnotBeforestring | nullreleasedAtstring | nullcreatedAtstring (date-time)approvalStatusstringexpiresAtstring | nullblockedenumWhat stands in the way of releasing it now; null when nothing does (or it is no longer a draft).
"off"·"account"·"reconnect"·"paused"·nullblockedWhystringThe same, in words, where something stands in the way.
supportReplyApprovalSupportReplyA reply to a customer Moléson drafted.
supportReply
idstringThe message.
conversationIdstringAn id.
channelenum"WIDGET"·"WHATSAPP"·"TELEGRAM"·"INSTAGRAM"·"MESSENGER"·"EMAIL"statusenum"RECEIVED"·"SCREENED"·"BLOCKED"·"DRAFT"·"RELEASED"·"SENDING"·"SENT"·"REFUSED"·"FAILED"·"CANCELLED"textstringThe reply as it would be sent.
localestring | nullintentstring | nullmodestring | nullcustomerobjectcustomer
namestring | nulltextstring | nullThe message it answers, as written.
localestring | null
sourcesarray of objectsources
kindanyThe kind of passage it cites.
titlestring | nullThe source's title.
blockedenumWhat stands in the way of releasing it now; null when nothing does (or it is no longer a draft).
"off"·"paused"·nullblockedWhystringThe same, in words, where something stands in the way.
idstringAn id.
categoryenumWhat kind of decision it is.
"MONEY_OUT"·"FILING"·"CONTRACT"·"CUSTOMER_FACING"·"DATA_WRITE"·"SCHEDULING"·"INTERNAL_NOTE"·"BERNINA_REVIEW"·"UPGRADE_OFFER"·"TOPUP"titlestringsummarystringreasoningstringWhy the agent asks.
statusenumWhere the decision is.
"PENDING"·"APPROVED"·"REJECTED"·"EXPIRED"·"CANCELLED"amountMinorinteger | nullThe amount, in the currency's minor unit, where it has one.
currencystring | nullcounterpartystring | nullhumanNextStepstring | nullWhat is left for a person to do once it is approved: Zuger prepares, a person files, signs and pays.
agentenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"entitystring | nullThe legal entity's name, if any.
runIdstring | nullAn id.
expiresAtstring | nullcreatedAtstring (date-time)decidedAtstring | nulldoneAtstring | nullWhen a person marked it carried out.
doneNotestring | nullheldobject | nullOn a Bernina review: what she held back. Never given to an API key or a connected app (left out).
schemaApprovalContractReviewThe review beside its approval. Not legal advice; Titlis never signs or sends.
The review beside its approval. Not legal advice; Titlis never signs or sends.
contractIdstringAn id.
titlestringcounterpartystring | nullourSidestring | nulllanguagestringThe contract's language.
verdictenum"blocked"·"flagged"·"meets"blockedintegerflaggedintegerlocalestringThe review's language (the founder's).
bodystringThe review.
effectiveOnstring | nulltermEndsOnstring | nullrenewsOnstring | nullnoticeBystring | nullplaybookVersionintegerreviewStatusenum"PROPOSED"·"TAKEN"·"DECLINED"·"LAPSED"findingsarray of TitlisFindingfindings
redlinesarray of objectredlines
positionIdenum"liability_cap"·"notice"·"renewal"·"term"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"severityenum"flag"·"block"refstring | nullThe clause's number.
quotestringThe words now.
suggestedstringThe words suggested, in the contract's language.
reasonstringA reason key, said in the reader's language by the Console.
varsmap of string | numberlocalestringcitationsarray of any ofcitations
- object
kindenum"clause"documentIdstringAn id.
refstringThe clause's number.
clauseenum"parties"·"term"·"renewal"·"notice"·"liability_cap"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"
- object
kindenum"document"documentIdstringAn id.
missingenum"parties"·"term"·"renewal"·"notice"·"liability_cap"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"
- object
kindenum"playbook"positionIdenum"liability_cap"·"notice"·"renewal"·"term"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"versionintegercovenantboolean
schemaApprovalDetailOne approval.
One approval.
offerobjectAn UpgradeOffer or a top-up card: what it is for (pricing v2026-10).
offer
kindenumA move up a plan, or a prepaid pack of Runs.
"UPGRADE"·"TOPUP"currentPlanstring | nullThe plan now (database code).
targetPlanstring | nullThe plan offered (database code).
targetPlanNamestring | nullThe plan offered, as customers know it.
intervalstring | nullmonthoryear.proratedMinorinteger | nullWhat moving up costs now, pro rata, in cents.
queuedRunCountinteger | nullRuns waiting for Runs when it was offered.
recommendationstring | nullWhy this offer.
comparisonany ofcomparison
- any The plans side by side, as the Console shows them.
- null
packRunsinteger | nullRuns in the pack, for a top-up.
packAmountMinorinteger | nullWhat the pack costs, in cents.
statusstringWhere the offer is (
OPEN,AWAITING_PAYMENT,PAID,DISMISSED,EXPIRED,SUPERSEDED, …).
outboundApprovalOutboundA message an agent prepared for a counterparty (v5 K1b): who it goes to, the From line, the words and the guardrails.
outbound
tostring (email)The address it goes to.
toNamestring | nullfromstring | nullThe From line, from the company's verified sending domain.
subjectstringbodystringThe words as they will be sent; a debtor-portal link is shown as
https://…/l/…, never the link itself.localestringchannelstringEMAIL.statusstringDRAFT,RELEASED,SENDING,SENT,REFUSED,FAILEDorCANCELLED.notBeforestring | nullsentAtstring | nullrefusedReasonstring | nullguardrailsarray of objectEach guardrail as the worker will read it now (for a draft), or as it was.
guardrails
keystringThe guardrail (
recipient,stop_contact,b2b_only,domain_verified,no_write_off, quiet hours, frequency, …).okbooleanuntilstringFor a wait: until when.
refusedstring | nullA hard guardrail that refuses it, for a draft.
waitUntilstring | nullFor a draft held only by waits: the earliest time it may go.
timezonestring | nullThe zone the quiet hours were read in.
draftedBystringWho drafted it (
SANTIS,KESCH,ZERMATT, …).purposestringWhy (
firm,final_notice, an invitation, …).citationsarray of objectWhat it rests on.
citations
kindstringsourcestringnumberstring | nullThe invoice number, for an invoice.
atstring | nullWhen the ledger or bank line was booked.
attachmentsarray of objectWhat goes with it (the invoice, its payment page, an .ics).
attachments
kindstring
instalmentsApprovalInstalmentsAn instalment plan Kesch proposed.
instalments
instalmentsarray of objectTwo to six, adding up to exactly what is owed.
instalments
seqintegerdueAtstringThe date it is due.
amountMinorintegerAn amount in the currency's minor unit (cents).
totalMinorintegerAn amount in the currency's minor unit (cents).
currencystringstatusenum"PROPOSED"·"ACTIVE"·"BROKEN"·"COMPLETED"·"REJECTED"·"CANCELLED"
filingPackApprovalFilingPackA filing pack Pilatus prepared. Pilatus prepares; you file.
filingPack
obligationIdstringAn id.
ruleIdstringtitlestringbodystringThe pack, in the founder's language.
localestringchecklistarray of stringWhat to check, ending with where the person files it themselves.
citationsarray of any ofcitations
- object
kindenum"rule"ruleIdstringstatutestringurlstring (uri)officialboolean
- object
kindenum"entity"idstringAn id.
- object
kindenum"ledger"sourceenum"invoices"·"bank"countintegeridsarray of stringconnectorsarray of string
- object
kindenum"document"countintegeridsarray of string
needsReviewbooleanRests on a rule that is not verified: to confirm with your adviser.
dueOnstring (date)periodStartstring (date)periodEndstring (date)statusenumThe obligation's status.
"UPCOMING"·"PREPARED"·"APPROVED"·"FILED"·"DISMISSED"jurisdictionstringentitystringThe entity's legal name.
whereToFileobject | nullWhere the person files it themselves; null where nothing is filed.
whereToFile
namestringurlstring (uri)
formationPackApprovalFormationPackAn Atlas-ready pack Pilatus prepared. Approving records that it was handed to you; you submit, sign and pay in Stripe Atlas.
formationPack
idstringThe pack.
approvalIdstringAn id.
localeenumThe language it was written in.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"entityTypeenum"C_CORP"·"LLC"legalNamestringThe name wanted.
titlestringbodystringThe pack, in the founder's language.
sheetarray of objectEvery field Stripe Atlas asks, in its order. Never an SSN, ITIN, date of birth or home address: those rows say you enter them in Stripe Atlas.
sheet
keystringWhat Stripe Atlas asks, e.g. company_name.
labelstringvaluestringstatusenum"prefilled"·"enter_in_atlas"·"decide_in_atlas"sourcesarray of string
checklistarray of stringcitationsarray of objectcitations
fieldstringsourcesarray of string
statusenum"PREPARED"·"HANDED_OVER"·"DECLINED"·"FORMED"handedAtstring | nullformedOnstring | nullformedEntityIdstring | nullAn id.
createdAtstring (date-time)atlasUrlstring (uri)https://stripe.com/atlas: where you apply yourself.
contractReviewApprovalContractReviewA contract review Titlis prepared, with its redlines.
contractReview
contractIdstringAn id.
titlestringcounterpartystring | nullourSidestring | nulllanguagestringThe contract's language.
verdictenum"blocked"·"flagged"·"meets"blockedintegerflaggedintegerlocalestringThe review's language (the founder's).
bodystringThe review.
effectiveOnstring | nulltermEndsOnstring | nullrenewsOnstring | nullnoticeBystring | nullplaybookVersionintegerreviewStatusenum"PROPOSED"·"TAKEN"·"DECLINED"·"LAPSED"findingsarray of TitlisFindingfindings
redlinesarray of objectredlines
positionIdenum"liability_cap"·"notice"·"renewal"·"term"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"severityenum"flag"·"block"refstring | nullThe clause's number.
quotestringThe words now.
suggestedstringThe words suggested, in the contract's language.
reasonstringA reason key, said in the reader's language by the Console.
varsmap of string | numberlocalestringcitationsarray of any ofcitations
- object
kindenum"clause"documentIdstringAn id.
refstringThe clause's number.
clauseenum"parties"·"term"·"renewal"·"notice"·"liability_cap"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"
- object
kindenum"document"documentIdstringAn id.
missingenum"parties"·"term"·"renewal"·"notice"·"liability_cap"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"
- object
kindenum"playbook"positionIdenum"liability_cap"·"notice"·"renewal"·"term"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"versionintegercovenantboolean
socialPostApprovalSocialPostA post or public reply Matterhorn drafted.
socialPost
idstringThe post.
approvalIdstringAn id.
channelenum"X"·"LINKEDIN"kindenum"POST"·"REPLY"statusenum"DRAFT"·"RELEASED"·"PUBLISHING"·"PUBLISHED"·"REFUSED"·"FAILED"·"CANCELLED"accountstring | nullThe account it is for.
textstringThe words, as they will be published.
localestringcharCountintegerAs the platform counts it.
charLimitintegerscheduledAtstring | nullWhen to publish; null: as soon as released.
timezonestring | nulllocalobject | nullThe time in its zone.
local
datestring (date)timestringHH:MM
replyToUrlstring | nullThe public post a reply answers.
citationsarray of objectclaimsanyThe claims in the words and what each rests on, as Matterhorn recorded them.
publishedAtstring | nullurlstring | nullWhere it was published.
refusedReasonstring | nullWhy it stopped (
withdrawn,channel_paused,rejected, …).notBeforestring | nullmetricsanyThe numbers read back from the platform, where any.
releasedAtstring | nullcreatedAtstring (date-time)approvalStatusstringIts approval's status.
expiresAtstring | nullWhen its approval lapses.
blockedenumWhat stands in the way of releasing it now; null when nothing does (or it is no longer a draft).
"off"·"account"·"reconnect"·"paused"·"stale"·nullblockedWhystringThe same, in words, where something stands in the way.
shortlistApprovalZermattShortlistA shortlist Zermatt proposed.
shortlist
roleIdstringAn id.
statusenum"PROPOSED"·"TAKEN"·"DECLINED"candidatesarray of objectcandidates
candidateIdstringAn id.
namestring | nullNull once erased.
stageenum"NEW"·"SHORTLISTED"·"INTERVIEWING"·"ON_HOLD"·"NOT_PROGRESSED"·"HIRED"·"WITHDRAWN"fitenumAgainst the role's written requirements; never a decision.
"STRONG"·"PARTIAL"·"UNCLEAR"proposedbooleanZermatt proposes them for the shortlist.
summarystringlocalestringrequirementsarray of objectrequirements
requirementstringfitenum"STRONG"·"PARTIAL"·"UNCLEAR"evidencestring
citationsarray of objectAt least two artefacts, one the candidate's own.
citations
kindenum"role"·"cv"·"note"idstringAn id.
interviewApprovalZermattInterviewAn interview invitation Zermatt prepared.
interview
idstringAn id.
candidatestringlocalestringThe language the candidate reads.
startsAtstring (date-time)endsAtstring (date-time)timezonestringThe candidate's zone.
companyTimezonestringformatstringVIDEO,PHONEorONSITE.locationstring | nullA link or an address, as the company gave it.
statusenum"PROPOSED"·"INVITED"·"SENT"·"CANCELLED"·"REFUSED"busyCheckedbooleanBusy times were read from the company's calendar.
icsUidstring
contractPackApprovalZermattContractPackA contract pack Zermatt prepared.
contractPack
idstringAn id.
titlestringcountrystringkindenum"EMPLOYEE"·"CONTRACTOR"localestringbodystringsectionsarray of objectsections
idstringheadingstringtextstringsourcesarray of stringreviewstring | nullWhat counsel should look at.
sourcesarray of objectsources
idstringstatutestringurlstring (uri)publisherstringofficialboolean
reviewFlagsarray of objectThe points for counsel.
reviewFlags
idstringtextstring
needsReviewbooleantemplateVersionstringstatusenum"PROPOSED"·"APPROVED"·"DECLINED"titlisbooleanSent on to Titlis for a review.
titlisQueuedAtstring | null
engActionApprovalEngActionA comment, issue or labels Gotthard prepared.
engAction
idstringThe finding.
approvalIdstringAn id.
channelenum"GITHUB"·"LINEAR"kindenum"COMMENT"·"ISSUE"·"LABELS"findingenumWhich of Gotthard's four jobs it came from.
"TRIAGE"·"REPRO"·"REVIEW"·"CHANGELOG"statusenum"DRAFT"·"RELEASED"·"POSTING"·"POSTED"·"REFUSED"·"FAILED"·"CANCELLED"accountstring | nulltargetstringThe repository or team.
numberinteger | nullThe issue or pull request.
isPullbooleanrefstringWhere, as written on the platform (
owner/repo#12).placeUrlstring | nulltitlestring | nullbodystring | nullWhat would be posted.
localestringcharCountintegerlabelsarray of stringprioritystring | nullduplicateOfstring | nullownerstring | nullcitationsarray of objecturlstring | nullWhere it was posted.
postedAtstring | nullpostedNumberinteger | nullrefusedReasonstring | nullnotBeforestring | nullreleasedAtstring | nullcreatedAtstring (date-time)approvalStatusstringexpiresAtstring | nullblockedenumWhat stands in the way of releasing it now; null when nothing does (or it is no longer a draft).
"off"·"account"·"reconnect"·"paused"·nullblockedWhystringThe same, in words, where something stands in the way.
supportReplyApprovalSupportReplyA reply to a customer Moléson drafted.
supportReply
idstringThe message.
conversationIdstringAn id.
channelenum"WIDGET"·"WHATSAPP"·"TELEGRAM"·"INSTAGRAM"·"MESSENGER"·"EMAIL"statusenum"RECEIVED"·"SCREENED"·"BLOCKED"·"DRAFT"·"RELEASED"·"SENDING"·"SENT"·"REFUSED"·"FAILED"·"CANCELLED"textstringThe reply as it would be sent.
localestring | nullintentstring | nullmodestring | nullcustomerobjectcustomer
namestring | nulltextstring | nullThe message it answers, as written.
localestring | null
sourcesarray of objectsources
kindanyThe kind of passage it cites.
titlestring | nullThe source's title.
blockedenumWhat stands in the way of releasing it now; null when nothing does (or it is no longer a draft).
"off"·"paused"·nullblockedWhystringThe same, in words, where something stands in the way.
idstringAn id.
categoryenumWhat kind of decision it is.
"MONEY_OUT"·"FILING"·"CONTRACT"·"CUSTOMER_FACING"·"DATA_WRITE"·"SCHEDULING"·"INTERNAL_NOTE"·"BERNINA_REVIEW"·"UPGRADE_OFFER"·"TOPUP"titlestringsummarystringreasoningstringstatusenumWhere the decision is.
"PENDING"·"APPROVED"·"REJECTED"·"EXPIRED"·"CANCELLED"amountMinorinteger | nullcurrencystring | nullcounterpartystring | nullhumanNextStepstring | nullagentenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"entitystring | nullrunobjectrun
idstringAn id.
titlestring
createdAtstring (date-time)
schemaApprovalEngActionExactly what would be posted, and where.
Exactly what would be posted, and where.
idstringThe finding.
approvalIdstringAn id.
channelenum"GITHUB"·"LINEAR"kindenum"COMMENT"·"ISSUE"·"LABELS"findingenumWhich of Gotthard's four jobs it came from.
"TRIAGE"·"REPRO"·"REVIEW"·"CHANGELOG"statusenum"DRAFT"·"RELEASED"·"POSTING"·"POSTED"·"REFUSED"·"FAILED"·"CANCELLED"accountstring | nulltargetstringThe repository or team.
numberinteger | nullThe issue or pull request.
isPullbooleanrefstringWhere, as written on the platform (
owner/repo#12).placeUrlstring | nulltitlestring | nullbodystring | nullWhat would be posted.
localestringcharCountintegerlabelsarray of stringprioritystring | nullduplicateOfstring | nullownerstring | nullcitationsarray of objecturlstring | nullWhere it was posted.
postedAtstring | nullpostedNumberinteger | nullrefusedReasonstring | nullnotBeforestring | nullreleasedAtstring | nullcreatedAtstring (date-time)approvalStatusstringexpiresAtstring | nullblockedenumWhat stands in the way of releasing it now; null when nothing does (or it is no longer a draft).
"off"·"account"·"reconnect"·"paused"·nullblockedWhystringThe same, in words, where something stands in the way.
schemaApprovalFilingPackThe pack beside its approval. Pilatus never files.
The pack beside its approval. Pilatus never files.
obligationIdstringAn id.
ruleIdstringtitlestringbodystringThe pack, in the founder's language.
localestringchecklistarray of stringWhat to check, ending with where the person files it themselves.
citationsarray of any ofcitations
- object
kindenum"rule"ruleIdstringstatutestringurlstring (uri)officialboolean
- object
kindenum"entity"idstringAn id.
- object
kindenum"ledger"sourceenum"invoices"·"bank"countintegeridsarray of stringconnectorsarray of string
- object
kindenum"document"countintegeridsarray of string
needsReviewbooleanRests on a rule that is not verified: to confirm with your adviser.
dueOnstring (date)periodStartstring (date)periodEndstring (date)statusenumThe obligation's status.
"UPCOMING"·"PREPARED"·"APPROVED"·"FILED"·"DISMISSED"jurisdictionstringentitystringThe entity's legal name.
whereToFileobject | nullWhere the person files it themselves; null where nothing is filed.
whereToFile
namestringurlstring (uri)
schemaApprovalFormationPackAn Atlas-ready pack. Pilatus is not connected to Stripe: you submit, sign and pay in Stripe Atlas yourself.
An Atlas-ready pack. Pilatus is not connected to Stripe: you submit, sign and pay in Stripe Atlas yourself.
idstringThe pack.
approvalIdstringAn id.
localeenumThe language it was written in.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"entityTypeenum"C_CORP"·"LLC"legalNamestringThe name wanted.
titlestringbodystringThe pack, in the founder's language.
sheetarray of objectEvery field Stripe Atlas asks, in its order. Never an SSN, ITIN, date of birth or home address: those rows say you enter them in Stripe Atlas.
sheet
keystringWhat Stripe Atlas asks, e.g. company_name.
labelstringvaluestringstatusenum"prefilled"·"enter_in_atlas"·"decide_in_atlas"sourcesarray of string
checklistarray of stringcitationsarray of objectcitations
fieldstringsourcesarray of string
statusenum"PREPARED"·"HANDED_OVER"·"DECLINED"·"FORMED"handedAtstring | nullformedOnstring | nullformedEntityIdstring | nullAn id.
createdAtstring (date-time)atlasUrlstring (uri)https://stripe.com/atlas: where you apply yourself.
schemaApprovalInstalmentsThe plan beside its approval.
The plan beside its approval.
instalmentsarray of objectTwo to six, adding up to exactly what is owed.
instalments
seqintegerdueAtstringThe date it is due.
amountMinorintegerAn amount in the currency's minor unit (cents).
totalMinorintegerAn amount in the currency's minor unit (cents).
currencystringstatusenum"PROPOSED"·"ACTIVE"·"BROKEN"·"COMPLETED"·"REJECTED"·"CANCELLED"
schemaApprovalOutboundThe message beside its approval.
The message beside its approval.
tostring (email)The address it goes to.
toNamestring | nullfromstring | nullThe From line, from the company's verified sending domain.
subjectstringbodystringThe words as they will be sent; a debtor-portal link is shown as
https://…/l/…, never the link itself.localestringchannelstringEMAIL.statusstringDRAFT,RELEASED,SENDING,SENT,REFUSED,FAILEDorCANCELLED.notBeforestring | nullsentAtstring | nullrefusedReasonstring | nullguardrailsarray of objectEach guardrail as the worker will read it now (for a draft), or as it was.
guardrails
keystringThe guardrail (
recipient,stop_contact,b2b_only,domain_verified,no_write_off, quiet hours, frequency, …).okbooleanuntilstringFor a wait: until when.
refusedstring | nullA hard guardrail that refuses it, for a draft.
waitUntilstring | nullFor a draft held only by waits: the earliest time it may go.
timezonestring | nullThe zone the quiet hours were read in.
draftedBystringWho drafted it (
SANTIS,KESCH,ZERMATT, …).purposestringWhy (
firm,final_notice, an invitation, …).citationsarray of objectWhat it rests on.
citations
kindstringsourcestringnumberstring | nullThe invoice number, for an invoice.
atstring | nullWhen the ledger or bank line was booked.
attachmentsarray of objectWhat goes with it (the invoice, its payment page, an .ics).
attachments
kindstring
schemaApprovalSocialPostThe post beside its approval, as the platform will show it.
The post beside its approval, as the platform will show it.
idstringThe post.
approvalIdstringAn id.
channelenum"X"·"LINKEDIN"kindenum"POST"·"REPLY"statusenum"DRAFT"·"RELEASED"·"PUBLISHING"·"PUBLISHED"·"REFUSED"·"FAILED"·"CANCELLED"accountstring | nullThe account it is for.
textstringThe words, as they will be published.
localestringcharCountintegerAs the platform counts it.
charLimitintegerscheduledAtstring | nullWhen to publish; null: as soon as released.
timezonestring | nulllocalobject | nullThe time in its zone.
local
datestring (date)timestringHH:MM
replyToUrlstring | nullThe public post a reply answers.
citationsarray of objectclaimsanyThe claims in the words and what each rests on, as Matterhorn recorded them.
publishedAtstring | nullurlstring | nullWhere it was published.
refusedReasonstring | nullWhy it stopped (
withdrawn,channel_paused,rejected, …).notBeforestring | nullmetricsanyThe numbers read back from the platform, where any.
releasedAtstring | nullcreatedAtstring (date-time)approvalStatusstringIts approval's status.
expiresAtstring | nullWhen its approval lapses.
blockedenumWhat stands in the way of releasing it now; null when nothing does (or it is no longer a draft).
"off"·"account"·"reconnect"·"paused"·"stale"·nullblockedWhystringThe same, in words, where something stands in the way.
schemaApprovalSupportReplyThe reply beside its approval.
The reply beside its approval.
idstringThe message.
conversationIdstringAn id.
channelenum"WIDGET"·"WHATSAPP"·"TELEGRAM"·"INSTAGRAM"·"MESSENGER"·"EMAIL"statusenum"RECEIVED"·"SCREENED"·"BLOCKED"·"DRAFT"·"RELEASED"·"SENDING"·"SENT"·"REFUSED"·"FAILED"·"CANCELLED"textstringThe reply as it would be sent.
localestring | nullintentstring | nullmodestring | nullcustomerobjectcustomer
namestring | nulltextstring | nullThe message it answers, as written.
localestring | null
sourcesarray of objectsources
kindanyThe kind of passage it cites.
titlestring | nullThe source's title.
blockedenumWhat stands in the way of releasing it now; null when nothing does (or it is no longer a draft).
"off"·"paused"·nullblockedWhystringThe same, in words, where something stands in the way.
schemaApprovalZermattContractPackA contract pack; every figure a blank, never signed.
A contract pack; every figure a blank, never signed.
idstringAn id.
titlestringcountrystringkindenum"EMPLOYEE"·"CONTRACTOR"localestringbodystringsectionsarray of objectsections
idstringheadingstringtextstringsourcesarray of stringreviewstring | nullWhat counsel should look at.
sourcesarray of objectsources
idstringstatutestringurlstring (uri)publisherstringofficialboolean
reviewFlagsarray of objectThe points for counsel.
reviewFlags
idstringtextstring
needsReviewbooleantemplateVersionstringstatusenum"PROPOSED"·"APPROVED"·"DECLINED"titlisbooleanSent on to Titlis for a review.
titlisQueuedAtstring | null
schemaApprovalZermattInterviewAn interview invitation; its message is the approval's `outbound`.
An interview invitation; its message is the approval's outbound.
idstringAn id.
candidatestringlocalestringThe language the candidate reads.
startsAtstring (date-time)endsAtstring (date-time)timezonestringThe candidate's zone.
companyTimezonestringformatstringVIDEO,PHONEorONSITE.locationstring | nullA link or an address, as the company gave it.
statusenum"PROPOSED"·"INVITED"·"SENT"·"CANCELLED"·"REFUSED"busyCheckedbooleanBusy times were read from the company's calendar.
icsUidstring
schemaApprovalZermattShortlistA shortlist: one assessment per candidate.
A shortlist: one assessment per candidate.
roleIdstringAn id.
statusenum"PROPOSED"·"TAKEN"·"DECLINED"candidatesarray of objectcandidates
candidateIdstringAn id.
namestring | nullNull once erased.
stageenum"NEW"·"SHORTLISTED"·"INTERVIEWING"·"ON_HOLD"·"NOT_PROGRESSED"·"HIRED"·"WITHDRAWN"fitenumAgainst the role's written requirements; never a decision.
"STRONG"·"PARTIAL"·"UNCLEAR"proposedbooleanZermatt proposes them for the shortlist.
summarystringlocalestringrequirementsarray of objectrequirements
requirementstringfitenum"STRONG"·"PARTIAL"·"UNCLEAR"evidencestring
citationsarray of objectAt least two artefacts, one the candidate's own.
citations
kindenum"role"·"cv"·"note"idstringAn id.
schemaAuthChallenge
optionsobjectWebAuthn options for navigator.credentials (PublicKeyCredentialRequestOptions or PublicKeyCredentialCreationOptions as JSON).
tokenstringThe signed challenge token from the matching start call. Valid for one ceremony.
schemaAuthLinkSent
sentenumtruenotestringWhat happens next, in words to show the person. Says the same whether or not the address has an account.
schemaAuthPasskey
idstringThe passkey's id in Zuger (for DELETE /v1/auth/passkeys/{id}).
deviceNamestring | nullThe device it was made on, as the browser said ("Chrome on a Mac").
countrystring | nullTwo-letter country it was made from, where known.
lastUsedAtstring | nullLast sign-in with it.
createdAtstring (date-time)shortIdstringThe start of the WebAuthn credential id: enough to tell two passkeys apart.
schemaAuthSessionA signed-in session. The token itself is only in the cookie.
A signed-in session. The token itself is only in the cookie.
expiresAtstring (date-time)When the session ends.
schemaBillingInvoiceAn invoice or credit note, live mode only on live keys. Every recorded invoice was paid.
An invoice or credit note, live mode only on live keys. Every recorded invoice was paid.
idstringThe invoice row.
numberstringThe invoice number.
issuedAtstring (date-time)periodStartstring | nullperiodEndstring | nullplanenumA plan, by its database code: PRE_REVENUE (Free), STARTER, SOLO (Pro), COMPANY (Max), GROUP (Ultra).
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"intervalstringmonth,year, oroncefor a top-up.currencystringnetMinorintegerBefore VAT, in cents (negative on a credit note).
vatRateBpsintegerThe VAT rate in basis points.
vatMinorintegerThe VAT, in cents.
totalMinorintegerWith VAT, in cents (negative on a credit note).
treatmentstringThe VAT treatment: DOMESTIC, OSS, REVERSE_CHARGE or OUT_OF_SCOPE.
documentobjectThe invoice as issued: seller, customer, lines and notes, as it is rendered.
statusenum"paid"·"refunded"·"partly_refunded"·"credit_note"
schemaBillingPlanLimitsWhat a plan allows. A cap with no limit is null (JSON has no Infinity).
What a plan allows. A cap with no limit is null (JSON has no Infinity).
entitiesintegeragentsinteger | nullNull: no cap.
runsPerMonthintegerrunGrantintegerbankAccountsintegerconnectedToolsinteger | nullNull: no cap.
overnightRunsbooleanroutinesbooleanauditExportbooleanresidencyChoicebooleanboardPackbooleanssoboolean
schemaBillingUsageRuns and limits now, from the Run ledger.
Runs and limits now, from the Run ledger.
runsUsedintegerRuns used of this month's plan allowance (or the Free grant).
allowanceintegerThis month's plan Runs, prorated where the plan changed part-way (or the Free grant).
planRunsintegerThe plan's own Runs a month (Free's grant).
heldUntilstring | nullThe renewal the rest of the month's Runs wait on being paid, if any.
refillsbooleanThe allowance refills (a paid plan); Free's grant does not.
resetsAtstring | nullWhen the allowance refills: the next UTC month.
topupRunsintegerTop-up Runs left.
runsLeftintegerEvery Run the company can still use.
onboardingRunLeftbooleanRun 0, the company's first, is still to come (never debited).
awaitingEmailbooleanOn Free: nothing runs until an owner's address is confirmed.
freeGrantLeftintegerWhat is left of the Free grant.
sharenumberRuns used over the allowance (1 where there is none).
topupLotsarray of objectEach top-up lot with what is left and its expiry.
topupLots
runsintegerexpiresAtstring (date-time)
grantRunsintegerRuns from Zuger left.
grantLotsarray of objectEach lot of Runs from Zuger, with what is left and its expiry.
grantLots
runsintegerexpiresAtstring (date-time)
raisedarray of objectLimits Zuger raised for a while: to what, from what, until when.
raised
limitenum"AGENTS"·"ENTITIES"·"RUNS"valueintegerplanValueintegerendsAtstring (date-time)
runOutstring | nullWhen Runs run out at the last seven days' pace; null where they do not, or it could not be read.
queuedRunsintegerRuns waiting for Runs (QUEUED_FOR_ALLOWANCE).
openOfferobject | nullThis cycle's open upgrade offer, as an approval.
openOffer
approvalIdstringAn id.
targetPlanstring
topupPacksarray of objectThe top-up packs on this plan (none on Free).
topupPacks
runsenum50·200amountMinorintegerThe pack's price before VAT, in the minor unit of the company's billing currency.
currencyenumPresent where the company is billed in another currency than EUR.
"EUR"·"USD"·"CHF"·"GBP"·"AED"
agentsOnShiftintegeragentCapinteger | nullAgents on shift the limits allow; null where unlimited.
entityCapintegerCompanies (legal entities) the limits allow.
toolCapinteger | nullConnected tools the limits allow; null where unlimited.
schemaBriefStartedWhere to look: the Run is the record.
Where to look: the Run is the record.
queuedenumtrueagentenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"atintegerWhen it was queued, in milliseconds since 1970.
titlestringThe brief's first words, as the Run will be called (empty on a replay).
briefIdstringThe brief,
brf_…: follow it withGET /v1/briefs/{id}/steps.documentsintegerHow many files it carries.
runsintegerWhat it weighs, where it is not 1 (a contract review: 5).
replayedenumThe same
Idempotency-Keywas seen in the last day: this is the first answer again, and nothing new was started.true
schemaChannelLinkStart
channelenum"TELEGRAM"·"WHATSAPP"codestringThe code to send from the chat.
urlstring (uri)A link that opens the chat with the code ready (t.me or wa.me).
instructionstringWhat to do, in words.
expiresAtstring (date-time)When the code lapses (15 minutes).
schemaCompanyConsolidationRow
toolsintegerTools assigned.
net30CompanyMoneyMoney in less money out over the last 30 days, from the synced bank lines.
owedToYouCompanyMoneyOpen receivables.
overdueintegerReceivables past their due date.
youOweCompanyMoneyOpen payables.
openDealsintegerDeals not won, lost or closed.
pipelineCompanyMoneyThe open deals' amounts.
approvalsintegerApprovals waiting.
schemaCompanyEntityA legal entity the account runs. The calendar facts (fiscalYearEnd, vatRegistered, vatPeriod, hasPayroll, incorporatedOn, ctRegistered) feed Pilatus.
A legal entity the account runs. The calendar facts (fiscalYearEnd, vatRegistered, vatPeriod, hasPayroll, incorporatedOn, ctRegistered) feed Pilatus.
idstringThe legal entity.
legalNamestringIts legal name.
jurisdictionstringTwo-letter country code.
registrationNostring | nullIts registry number.
vatNumberstring | nullIts VAT number.
baseCurrencystringThree-letter currency code.
fiscalYearEndstring | nullThe day the financial year ends, MM-DD.
vatRegisteredboolean | nullVAT registered; null where not said.
vatPeriodenumThe VAT period.
"MONTHLY"·"QUARTERLY"·"SEMI_ANNUAL"·"ANNUAL"·nullhasPayrollbooleanWhether it runs a payroll.
incorporatedOnstring | nullWhen it was incorporated.
ctRegisteredboolean | nullRegistered for corporate tax; null where not said.
connectionsintegerTools assigned to it.
runsintegerRuns for it.
approvalsintegerApprovals for it.
schemaCompanyMeThe signed-in person and their company.
The signed-in person and their company.
idstringThe person.
emailstring (email)Their sign-in address.
namestring | nullTheir name.
emailConfirmedbooleanWhether they confirmed the address.
localestring | nullTheir language (en, de, fr, es, it, ja, zh-CN, ar), or null where none was chosen.
companyobject | nullThe company they are in, or null before signing up finished.
company
idstringThe company.
namestringIts name.
residencyenumWhere its data is kept.
"EU"·"CH"roleenumThe person's role in the company.
"OWNER"·"ADMIN"·"MEMBER"planenumThe plan's code: PRE_REVENUE (Free), STARTER, SOLO (Pro), COMPANY (Max) or GROUP (Ultra).
"PRE_REVENUE"·"STARTER"·"SOLO"·"COMPANY"·"GROUP"·nulldeletionDueAtstring | nullWhen the company is deleted, where its owner asked.
statusenumThe subscription's status.
"TRIALING"·"ACTIVE"·"PAST_DUE"·"SUSPENDED"·"CANCELLED"·nullsealedPendingintegerSeal requests waiting for the company's owners and admins.
sealStateCompanySealStateThe workspace's Seal (apps/api/src/seal-state.ts): sealed, a Seal request waiting for the company, or access open until a time.
sealState
entitiesarray of objectentities
idstringThe legal entity.
legalNamestringjurisdictionstringTwo-letter country code.
baseCurrencystringThree-letter currency code.
schemaCompanyMember
idstringThe person (their user id).
emailstring (email)namestring | nullroleenumThe person's role in the company.
"OWNER"·"ADMIN"·"MEMBER"sincestring (date-time)When they joined the company.
joinedbooleanWhether they have a passkey or a password yet: an invited person who never claimed the invitation has neither.
schemaCompanyMoneyPer currency, never converted, largest first.
Per currency, never converted, largest first.
currencystringThree-letter currency code.
minorintegerAn amount in the currency's minor unit (cents).
schemaCompanySealStateThe workspace's Seal (apps/api/src/seal-state.ts): sealed, a Seal request waiting for the company, or access open until a time.
The workspace's Seal (apps/api/src/seal-state.ts): sealed, a Seal request waiting for the company, or access open until a time.
- object Zuger's staff tools show none of the company's content.
stateenum"sealed"
- object A Seal request is waiting for an owner or an admin.
stateenum"request"phaseenum"pending"requestIdstringThe Seal request.
requestedBystring | nullWho at Zuger asked, by name.
reasonstringWhy they asked, in their words.
scopeenumWhat the request covers: one Run, or named documents.
"RUN"·"DOCUMENTS"runIdstring | nullThe Run, where the scope is RUN.
documentIdsarray of stringThe documents, where the scope is DOCUMENTS.
minutesintegerHow long they asked for.
requestedAtstring (date-time)When they asked.
minebooleanThe request is the viewer's own (Zuger OPS only).
- object Access is open now, until `expiresAt`.
stateenum"request"phaseenum"open"grantIdstringThe grant.
expiresAtstring (date-time)When the access ends by itself.
scopeenumWhat the request covers: one Run, or named documents.
"RUN"·"DOCUMENTS"runIdstring | nullThe Run, where the scope is RUN.
documentIdsarray of stringThe documents, where the scope is DOCUMENTS.
requestedBystring | nullWho at Zuger asked, by name.
minebooleanThe grant is the viewer's own (Zuger OPS only).
schemaCompanySendingDomain
domainstringThe domain.
statusenumIts status at Resend.
"NOT_STARTED"·"PENDING"·"VERIFIED"·"PARTIALLY_VERIFIED"·"FAILED"·"TEMPORARY_FAILURE"recordsarray of objectThe DNS records to publish, as Resend gives them.
records
recordstringWhat the record is for (SPF, DKIM, …).
namestringThe record's name.
typestringMX, TXT, CNAME, …
valuestringThe value to publish.
ttlany ofttl
- any The TTL, as Resend gives it.
- null
priorityinteger | nullAn MX record's priority.
statusstring | nullResend's status for the record.
localPartstringThe part before the @ that messages come from.
replyTostring | nullWhere replies go.
verifiedAtstring | nullWhen Resend verified it.
lastCheckedAtstring | nullWhen it was last checked.
fromstring | nullThe From header messages carry, or null where the company's name cannot be sent as it is.
schemaCompanySsoThe company's single sign-on, without its secret.
The company's single sign-on, without its secret.
onPlanbooleanWhether the plan includes single sign-on (Ultra).
editablebooleanWhether this person may change it: the owner, on a plan with it.
planNamestringThe plan's name.
configuredbooleanWhether single sign-on is set up.
issuerstring | nullThe OpenID Connect issuer.
clientIdstring | nullThe client id.
hasSecretbooleanWhether a client secret is stored (never shown).
domainstring | nullThe mail domain it covers.
redirectUristring (uri)The redirect address to give the identity provider.
yourDomainstringThe domain of this person's own address.
domainUsablebooleanWhether that domain can be claimed: confirmed and not a public mail service.
emailConfirmedbooleanWhether this person confirmed their address.
secretsStorablebooleanWhether this deployment can store a client secret.
requiredbooleanWhether it is the only way in for members on the domain.
lastSignInAtstring | nullThe last sign-in through it.
canRequirebooleanWhether it can be made the only way in: someone has signed in through it.
schemaCompanySwitchSomething Zuger paused for everyone, until a time. Never the reason, never who.
Something Zuger paused for everyone, until a time. Never the reason, never who.
kindenumWhat Zuger paused.
"CONNECTOR"·"AGENT"·"STORE"·"CHANNEL"·"BRIEFS"·"SIGNUPS"targetstring | nullWhich one: a provider, an agent kind or a channel.
endsAtstring (date-time)When the pause ends.
publicNotestring | nullA note Zuger wrote for customers, if any.
schemaCompanyTermsDueThe Terms in force, when this person is an owner of a company that has not accepted them yet.
The Terms in force, when this person is an owner of a company that has not accepted them yet.
versionstringThe Terms in force.
publishedAtstringWhen they were published.
urlstring (uri)Where to read them.
schemaConnectionA connected tool. No token or secret is ever in it.
A connected tool. No token or secret is ever in it.
idstringThe connection.
entityIdstring | nullThe legal entity (company) it is assigned to, or null.
providerenumThe tool.
"GOOGLE_WORKSPACE"·"SLACK"·"NOTION"·"GITHUB"·"LINEAR"·"HUBSPOT"·"STRIPE"·"XERO"·"QUICKBOOKS"·"ZOHO_BOOKS"·"WAFEQ"·"REVOLUT_BUSINESS"·"MICROSOFT_365"·"DOCUSIGN"·"DEEL"·"COMPANIES_HOUSE"·"BANK_AGGREGATOR"·"EXAMPLE"·"STATEMENT"·"X"·"LINKEDIN"labelstringThe tool's name as people read it.
displayNamestring | nullThe account it reaches, as the provider names it.
statusenum"ACTIVE"·"NEEDS_RECONNECT"·"REVOKED"·"EXPIRED"accessenumREAD_WRITE only for a company's own X or LinkedIn account and Gotthard's GitHub or Linear grant, used by a passkey-signed release alone.
"READ_ONLY"·"READ_WRITE"scopesarray of stringWhat the grant allows, in the provider's words.
expiresAtstring | nullWhen the grant runs out, where the provider says.
lastUsedAtstring | nullWhen it was last read.
createdAtstring (date-time)pastPlanbooleanPast what the plan in force covers: kept, and not synced until the plan covers it again.
accountsSyncingintegerA bank feed with more accounts than the plan has room for: how many of them sync.
accountsConnectedinteger…and how many it brought in.
accountsPerCompanyinteger…and how many bank accounts the plan syncs for one company.
higherPlanHelpsbooleanFor one that waits, wholly or in part: whether a higher plan would sync more of it.
schemaDataRequestViewOne of your requests about your data.
One of your requests about your data.
idstringAn id.
kindenum"ACCESS"·"RECTIFICATION"·"ERASURE"·"PORTABILITY"·"OBJECTION"·"OTHER"statusenum"RECEIVED"·"VERIFYING"·"IN_PROGRESS"·"DONE"·"REFUSED"sourceenumHow it reached Zuger.
"CONSOLE"·"EMAIL"·"OTHER"receivedAtstring (date-time)dueAtstring (date-time)One calendar month after it was received (GDPR Art. 12(3)).
extendedTostring | nullA later date Zuger set, once, with a reason (at most two months more).
extensionReasonstring | nullrefusalReasonstring | nullclosedAtstring | nulldeadlinestring (date-time)The date Zuger answers by: extendedTo where set, else dueAt.
exportReadybooleanA download link was sent and has not been used or run out.
schemaErrorEvery failure has this shape.
Every failure has this shape.
errorErrorDetailOne failure. Other detail fields may appear; ignore what you do not know.
error
schemaErrorDetailOne failure. Other detail fields may appear; ignore what you do not know.
One failure. Other detail fields may appear; ignore what you do not know.
typestringWhat kind of failure:
bad_request,unauthorized,forbidden,not_found,method_not_allowed,conflict,rate_limited,briefs_busy,paused_by_zuger,reauth_required,proof_required,busy,model_unavailable,unavailable,not_configured,internal, and a few more named on the route that answers them. Stable: switch on it.messagestringThe refusal in plain English, written for a person to read.
codestringA stable code for this refusal (packages/http/src/error-codes.ts), to say it in another language. Absent where there is none.
paramsmap of stringThe values the refusal's words hold, by name, when its code has any. A value chosen from a short list (an approval category, a state, billing's reasons, durations, a schedule's part, an identity provider's setting) is its own code, several joined by commas (ERROR_VALUES in packages/http/src/error-codes.ts).
fieldstringThe request field the refusal is about, where it is about one.
retryAfterSecondsintegerOn 429: how long to wait before trying again (also sent as the
Retry-Afterheader).problemsarray of stringEvery reason the words were refused, where there can be more than one.
pausedobjectOn
paused_by_zuger(409): the pause, so a client can say it in its reader's language.paused
kindenumWhat Zuger paused.
"CONNECTOR"·"AGENT"·"STORE"·"CHANNEL"·"BRIEFS"·"SIGNUPS"targetstring | nullWhich one: a provider, an agent kind or a channel.
endsAtstring (date-time)When the pause ends.
publicNotestring | nullA note Zuger wrote for customers, if any.
offerApprovalIdstringWhere a plan does not include what was asked: the approval that offers the plan that does.
statusstringOn a refused
statusquery: the value that was not recognised.
schemaGotthardAction
idstringThe finding.
approvalIdstringAn id.
channelenum"GITHUB"·"LINEAR"kindenum"COMMENT"·"ISSUE"·"LABELS"findingenumWhich of Gotthard's four jobs it came from.
"TRIAGE"·"REPRO"·"REVIEW"·"CHANGELOG"statusenum"DRAFT"·"RELEASED"·"POSTING"·"POSTED"·"REFUSED"·"FAILED"·"CANCELLED"accountstring | nulltargetstringThe repository or team.
numberinteger | nullThe issue or pull request.
isPullbooleanrefstringWhere, as written on the platform (
owner/repo#12).placeUrlstring | nulltitlestring | nullbodystring | nullWhat would be posted.
localestringcharCountintegerlabelsarray of stringprioritystring | nullduplicateOfstring | nullownerstring | nullcitationsarray of objecturlstring | nullWhere it was posted.
postedAtstring | nullpostedNumberinteger | nullrefusedReasonstring | nullnotBeforestring | nullreleasedAtstring | nullcreatedAtstring (date-time)approvalStatusstringexpiresAtstring | null
schemaKeschAccount
chaseIdstringAn id.
invoiceIdstringAn id.
numberstring | nullThe invoice number.
debtorstring | nullamountDueMinorintegerAn amount in the currency's minor unit (cents).
currencystringdueAtstring | nulldaysOverdueintegerstagestring | nullThe chase stage (
firm,final_notice,paused, …).scoreinteger0 to 100: amount, age and behaviour.
atRiskbooleanflagsarray of enumnextStepenum"draft_firm"·"draft_final_notice"·"release_draft"·"wait"·"wait_promise"·"check_payment"·"watch_plan"·"review_dispute"·"read_reply"·"your_decision"·"stopped"·"consumer"·"no_email"·"closed"nextByenumWho takes it.
"kesch"·"saentis"·"you"·"nobody"nextAtstring | nullWhen the next step is a wait: until when.
stoppedbooleanThe debtor asked not to be contacted.
hasEmailbooleanlocalestring | nullcountrystring | nullpaymentPagebooleanThe invoice has its own payment page.
handedOffAtstring | nulllastReplyobject | nulllastReply
idstringAn id.
replyClassenum"promise_to_pay"·"dispute"·"hardship"·"already_paid"·"stop_contact"·"other"atstring (date-time)statusstringHELD: Bernina stopped it.nextStepstring | nullsourcestringMANUALorPORTAL.
openPromiseobject | nullopenPromise
kindstringamountMinorintegerAn amount in the currency's minor unit (cents).
dueBystring (date-time)
planenumThe instalment plan, if any.
"PROPOSED"·"ACTIVE"·"BROKEN"·"COMPLETED"·"REJECTED"·"CANCELLED"·null
schemaKeschPortalSettings
hostnamestring | nullThe portal's subdomain.
statusstringThe hostname's status at Cloudflare (
none,pending,active, …).sslStatusstring | nullIts certificate's status.
activebooleanThe hostname and its certificate are active: the portal answers.
recordsarray of objectWhat to publish in DNS.
records
typeenum"CNAME"·"TXT"namestringvaluestringpurposeenum"route"·"ownership"·"certificate"
urlstring | nullThe portal, once active.
brandColourstring | null#RRGGBB
logoobject | nulllogo
typestring | nullIts media type.
versionstring | nullA short hash of it.
poweredBybooleanThe footer says "Powered by Zuger".
lastCheckedAtstring | nullactiveAtstring | null
schemaKyaDealOne deal.
One deal.
idstringAn id.
sideenum"buyer"·"seller"stateenumAuthorised at Accept, taken at Receipt.
"OFFERED"·"DECLINED"·"LAPSED"·"AUTHORISING"·"AUTHORISED"·"ACCEPTED"·"DELIVERED"·"CAPTURED"·"SETTLED"·"CANCELLED"·"REFUNDED"currencystringEUR.
priceMinorintegerThe price before VAT, in cents.
feeMinorintegerZuger's fee (MARKETPLACE_FEE_PERCENT of the price).
shareMinorintegerWhat the seller is paid through Stripe Connect.
approvalIdstringAn id.
agentIdstringAn id.
sellerAgentIdstringAn id.
sellerDidstringThe seller agent's opaque did:web.
taskHashstringThe parties' own hash of the job.
resultHashstring | nullThe seller's hash of its result.
deliverHoursintegerreceiptHoursintegerauthorisedAtstring | nullsellerAcceptBystring | nullsellerAcceptedAtstring | nulldeliverBystring | nulldeliveredAtstring | nullreceiptDueAtstring | nullTaken at this time unless someone disputes first.
captureBystring | nullThe latest the payment can be taken, inside the card authorisation window.
receiptByenum"PERSON"·"WINDOW"·nullreceiptAtstring | nullcapturedAtstring | nullsettledAtstring | nullheldbooleanAn emergency stop holds it: only a person's Receipt takes it.
cancelledAtstring | nullcancelReasonstring | nullA code: disputed, declined_by_bank, seller_did_not_accept, not_delivered, stopped, …
refundedMinorintegerreversedMinorintegerWhat was taken back from the seller's transfer.
bankDisputebooleanlivemodebooleanAlways false until live mode is approved.
createdAtstring (date-time)
schemaKyaDelegatedKeyOne 24-hour grant of a passkey-delegated key.
One 24-hour grant of a passkey-delegated key.
idstringAn id.
agentIdstringAn id.
agentDidstringthumbprintstringfingerprintstringscopesarray of stringkeyProtectionenum"passkey_delegated"assuranceenum"registered"·"verified"methodenumHow this grant was authorized.
"passkey"·"auto"·"standing_window"passkeysintegerHow many passkeys signed it (0 for a renewal without a tap).
approvedAtstring (date-time)expiresAtstring (date-time)At most 24 hours after it was approved.
standingUntilstring | nullA Verified agent's standing window, at most 7 days.
stateenum"active"·"renewed"·"revoked"renewsstring | nullAn id.
revokedAtstring | nullrevokedCauseenum"owner"·"freeze"·"recovery"·"rotated"·"agent_removed"·nullissueenumready: recorded, the 24-hour credential bound to it waits for milestone A3.
"ready"·"issued"credentialobject | nullAlways null until Zuger issues outside agents' credentials (milestone A3).
schemaKyaExtAgentAn outside agent.
An outside agent.
idstringAn id.
didstringThe opaque subject
did:web:zuger.ai:ext:<registrant>:<agent>(never an account or company id).registrantDidstringThe operator,
did:web:zuger.ai:ext:<registrant>.namestringdescriptionstringmanifestobjectmanifest
doesstringWhat it does, in the developer's words.
homepagestring (uri)On the proven domain.
modelstringOnly if the developer chose to say.
providerstringOnly if the developer chose to say.
declaredScopesarray of stringDeclared by the operator, never enforced or granted; never execute:*.
domainstringThe proven domain it stands on.
stateenum"ACTIVE"·"LAPSED"·"REMOVED"createdAtstring (date-time)lapsedAtstring | nullremovedAtstring | nullkeysarray of objectkeys
kidstringk1, k2…
thumbprintstringRFC 7638, SHA-256.
stateenum"ACTIVE"·"REVOKED"publicJwkobjectAn Ed25519 public key as a JWK (RFC 8037). A JWK holding the private part (
d) is refused and never stored.publicJwk
ktyenum"OKP"crvenum"Ed25519"xstringThe 32-byte public key, base64url.
createdAtstring (date-time)revokedAtstring | null
credentialobject | nullAlways null until Zuger issues outside agents' credentials (milestone A3).
schemaKyaExtDomainA domain the developer company proves.
A domain the developer company proves.
idstringAn id.
domainstringThe domain, lower case.
methodenumHow the domain is proven.
"DNS_TXT"·"WELL_KNOWN"·"EMAIL"stateenumPENDING until first found; PROVEN while it holds (checked again every 30 days); LAPSED when a check lost it, and its agents with it.
"PENDING"·"PROVEN"·"LAPSED"provenAtstring | nullcheckedAtstring | nullnextCheckAtstring | nulllapsedAtstring | nulllastReasonstring | nullWhy the last check did not find it: record_missing, record_mismatch, not_found, content_mismatch, redirect_off_domain, too_many_redirects, too_large, private_address, unreachable, email_not_at_domain, email_unconfirmed, not_a_member.
publishobject | nullWhat to publish:
dns{name, type, value} orwellKnown{url, contentType, content}; null for an email proof.
schemaKyaKeyRequestAn outside agent's request for a key to be delegated (or renewed with a tap).
An outside agent's request for a key to be delegated (or renewed with a tap).
idstringAn id.
kindenum"delegate"·"renew"agentIdstringAn id.
agentNamestring | nullagentDidstringThe agent's opaque did:web subject.
thumbprintstringRFC 7638 SHA-256 of the key, base64url.
fingerprintstringThe thumbprint's first 32 characters in groups of four, as people compare it.
scopesarray of stringDeclared scopes asked for: never enforced or granted by Zuger, never execute:*.
lifetimeSecondsinteger86400: a delegated key lives 24 hours.
assuranceenum"registered"·"verified"originobjectWhere it came from, as a class: never an address.
origin
countrystring | nullWhere Zuger read the request came from, two letters.
networkenum"ipv4"·"ipv6"·nullclientstringsdk-typescript, sdk-python, curl or other.
signalsarray of enumWhat made it unusual; one signal asks for a second passkey.
passkeysNeededinteger1, or 2 for an unusual request.
replacesstring | nullThe live delegated key this one replaces (rotation).
renewsstring | nullThe live delegated key a renewal renews.
stateenum"pending"·"approved"·"declined"·"lapsed"·"refused"refusalstring | nullWhy the rules refused or lapsed it: unusual, frozen, agent_gone, lapsed.
createdAtstring (date-time)waitsUntilstring (date-time)When it lapses if nobody decides it.
decidedAtstring | nullgrantIdstring | nullAn id.
schemaKyaKeyStarted
optionsobjectWebAuthn request options;
challengeis the payload's SHA-256.tokenstringSent back with the assertion.
payloadobjectWhat the passkey commits to: the agent, the key's thumbprint, the scopes, iat, exp, the audience, the request and a nonce.
challengestringThe payload's SHA-256, base64url.
schemaKyaStopOne emergency stop.
One emergency stop.
idstringAn id.
scopeenumagent: one agent;operator: every agent of the company;skill: the agents that hold one skill."agent"·"operator"·"skill"targetstring | nulltargetNamestring | nullThe agent's name, for an
agentstop.stateenum"WAITING_SECOND"·"STOPPED"·"RESTARTED"·"LAPSED"·"WITHDRAWN"requestedBystring | nullWho asked, by name.
requestedByMebooleansecondBystring | nullWho gave the second passkey, by name.
requestedAtstring (date-time)waitsUntilstring | nullWhile it waits for a second passkey.
stoppedAtstring | nullrestartedAtstring | nullrestartedBystring | nullagentsarray of objectagents
idstringAn id.
kindstringnamestringpriorStateenumWhat a restart gives back.
"RUNNING"·"PAUSED"·"STOPPED"restartedAtstring | null
runsCancelledintegerRuns that were under way or waiting, ended and never charged.
proposalsWithdrawnintegerdurationMsinteger | nullFrom the passkey to the last Run ended and the webhook queued.
schemaLinkSpendPurchaseOne agent purchase.
One agent purchase.
idstringThe purchase; also the idempotency key of its Link spend request.
agentIdstringAn id.
parentIdstring | nullThe purchase this one replaces, where Link asked for a new request.
purposeenum"mpp_data"·"infra_topup"·"formation_fee"·"zuger_store"sellerstringWho sells it, as your agent named them.
amountMinorintegerIn minor units: what Link was asked for, else what the agent proposed.
currencystringstateenum"BLOCKED"·"VERIFY_FIRST"·"PASSKEY_PENDING"·"REJECTED"·"READY"·"AT_LINK"·"AFTER_ACTION"·"SUCCEEDED"·"FAILED"·"DENIED"·"EXPIRED"·"CANCELED"·"REPLACED"linkStatusenum"created"·"pending_approval"·"requires_action"·"approved"·"submitted"·"succeeded"·"failed"·"denied"·"expired"·"canceled"·nullpasskeybooleanWhether your passkey was needed as well (above the threshold, P67).
thresholdMinorinteger | nullThe threshold it was measured against; null: a currency with no threshold, so always a passkey.
approvalIdstring | nullIts MONEY_OUT approval, above the threshold.
approveInLinkstring | nullLink's own approval address while Link waits for you ("Approve in Link").
approvalExpiresAtstring | nullLink's 30-minute approval window ends.
nextActionobject | nullnextAction
typestringresolutionenum"auto_resume"·"create_new_spend_request"·"create_new_spend_request_after_completion"urlstring | nullmessagestring | nullLink's own words, shown as Link wrote them.
verifyobject | nullverify
statusstringLink's verification requirement.
urlstring | null
blockCodesarray of stringcodestring | nullWhy it ended, as a code.
createdAtstring (date-time)updatedAtstring (date-time)
schemaMatterhornPost
idstringThe post.
approvalIdstringAn id.
channelenum"X"·"LINKEDIN"kindenum"POST"·"REPLY"statusenum"DRAFT"·"RELEASED"·"PUBLISHING"·"PUBLISHED"·"REFUSED"·"FAILED"·"CANCELLED"accountstring | nullThe account it is for.
textstringThe words, as they will be published.
localestringcharCountintegerAs the platform counts it.
charLimitintegerscheduledAtstring | nullWhen to publish; null: as soon as released.
timezonestring | nulllocalobject | nullThe time in its zone.
local
datestring (date)timestringHH:MM
replyToUrlstring | nullThe public post a reply answers.
citationsarray of objectclaimsanyThe claims in the words and what each rests on, as Matterhorn recorded them.
publishedAtstring | nullurlstring | nullWhere it was published.
refusedReasonstring | nullWhy it stopped (
withdrawn,channel_paused,rejected, …).notBeforestring | nullmetricsanyThe numbers read back from the platform, where any.
releasedAtstring | nullcreatedAtstring (date-time)approvalStatusstringIts approval's status.
expiresAtstring | nullWhen its approval lapses.
schemaMatterhornVoice
voicestringHow the company sounds (1,200 characters at most).
localeenumThe language it posts in.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"registerenum"formal"·"informal"glossaryarray of objectIts own terms.
glossary
termstringkeepbooleanKept exactly as written in every language.
translationsmap of stringBy language.
avoidarray of stringWords it never uses.
versioninteger0: nothing saved yet.
schemaMemoryItem
idstringAn id.
kindenum"COMPANY_FACT"·"CORRECTION"·"PREFERENCE"·"OUTCOME"contentstringauthoredByUserIdstring | nullWho wrote it, or null for an agent.
createdAtstring (date-time)
schemaMolesonMessage
idstringAn id.
directionenum"IN"·"OUT"authorenum"CUSTOMER"·"MOLESON"·"PERSON"·"ZUGER"textstringAs written; nothing is translated.
localestring | nullintentstring | nullstatusenum"RECEIVED"·"SCREENED"·"BLOCKED"·"DRAFT"·"RELEASED"·"SENDING"·"SENT"·"REFUSED"·"FAILED"·"CANCELLED"modestring | nullHow it was answered (
PERSON, copilot, auto).approvalIdstring | nullAn id.
citationsarray of objectcreatedAtstring (date-time)sentAtstring | nullrefusedReasonstring | nulltemplatestring | nullThe WhatsApp template it went as, outside the 24-hour window.
sourcesarray of stringThe titles of the sources it cites.
schemaMoneyDraftOne money draft.
One money draft.
idstringAn id.
agentIdstringAn id.
approvalIdstring | nullIts MONEY_OUT approval; null when Bernina blocked it before it was shown.
kindenum"send_money"·"transfer_money"·"convert_currency"·"setup_recipient"·"spend_request"amountMinorintegerIn minor units; 0 for adding a payee.
currencystringtoCurrencystring | nullA conversion's currency bought.
counterpartystringWho is paid, as your agent named them.
stateenum"BLOCKED"·"PENDING_APPROVAL"·"APPROVED"·"REJECTED"·"EXPIRED"·"EXECUTING"·"SUCCEEDED"·"FAILED"blockCodesarray of stringproviderApprovalobject | nullStripe's own approval, where Stripe asked for one: the second step on the same card (PR 4). Zuger never answers it.
providerApproval
statusenum"requires_review"·"approved"·"unknown"·"succeeded"·"rejected"·"expired"·"canceled"·"failed"urlstring | nullStripe's own address for it (dashboard.stripe.com).
expiresAtstring | null
createdAtstring (date-time)updatedAtstring (date-time)
schemaMoneyLimitOne limit.
One limit.
agentIdstring | nullThe agent this limit is for; null for the whole company.
currencystringISO 4217, three capital letters.
dailyMinorintegerThe most in a day (24 hours), in minor units.
thirtyDayMinorintegerThe most in 30 days, in minor units; at least the daily limit.
schemaMoneyRecordOne thing your agents prepared to pay, move, convert, add as a payee or buy.
One thing your agents prepared to pay, move, convert, add as a payee or buy.
idstringThe draft's or the purchase's id.
typeenum"treasury"·"link"kindenum"send_money"·"transfer_money"·"convert_currency"·"setup_recipient"·"spend_request"groupenumWaiting for a person; approved and on its way; carried out; ended without moving money.
"waiting"·"approved"·"done"·"failed"statestringThe draft's or purchase's own state.
agentobject | nullagent
idstringAn id.
kindstringnamestring
amountMinorintegerIn minor units.
currencystringtoCurrencystring | nullA conversion's currency bought.
counterpartystringWho is paid, or who sells, as your agent named them.
approvalIdstring | nullThe MONEY_OUT approval in your inbox, where there is one.
approvalobject | nullapproval
bystring | nullThe person's name; null for an approval in Link.
methodenum"passkey"·"passkey_stripe"·"passkey_link"·"link"atstring | null
approveInLinkstring | nullLink's own approval page (https on link.com), while Link waits for you.
providerApprovalobject | nullStripe's own approval, where Stripe asked for one.
providerApproval
statusstringurlstring | nulldashboard.stripe.com only.
expiresAtstring | null
codesarray of stringrunIdstring | nullAn id.
createdAtstring (date-time)updatedAtstring (date-time)chainobject | nullThe step's link in the Zuger Agent Chain, where the chain holds one (a person's passkey decision and the final outcome).
chain
rootstringThe chain's root hash.
linkstringThis link's hash.
schemaOAuthClientView
idstringThe app's id inside Zuger, the same in every region. Not its client_id, which
POST /oauth/registergives and this request already holds.namestring | nullThe app's name, or null when it claims to be a known app (Claude, ChatGPT, Cursor) but sends the code elsewhere.
claimedenumThe known app its name claims, if any.
"Claude"·"ChatGPT"·"Cursor"·nullverifiedbooleanIts name is a known app's and every redirect goes to that vendor's own host or scheme.
sendsToOAuthSendsToWhere the authorisation code goes.
sendsTo
uristring | nullThe app's https homepage, when its name is shown.
logostring | nullThe app's https logo, when its name is shown.
schemaOAuthRedirect
redirectTostring | nullWhere to send the person next: the app's redirect_uri with
codeandstate, or witherroranderror_description. Null when the request names no registered app or redirect, so there is nowhere safe to send them.
schemaOAuthSendsToWhere the authorisation code goes.
Where the authorisation code goes.
kindenumweban https address,devicehttp on this machine,appthe app's own scheme."web"·"device"·"app"hoststringThe host (or
scheme://) the code is sent to.
schemaOpportunitiesPage
- object Where `dom_opportunities` is off for the company: this and nothing else.
availableenumOpportunities are not switched on for this company.
false
- object
availableenumtruesettingsobjectsettings
frequencyenumHow often Dom writes a brief.
"weekly"·"monthly"·"on_request"·"off"chosenbooleanWhether the company chose it, rather than the plan's default.
defaultFrequencyenumThe plan's default.
"weekly"·"monthly"·"on_request"·"off"levelsarray of enumWhich levels of idea.
webbooleanWhether briefs research the web.
webAvailablebooleanWhether this deployment can.
planstringThe plan (database code).
goalsobjectv1.1: the company's goals and limits.
goals
revenueKindenum"recurring"·"one_off"·"either"noNewHiresbooleanmarginFloorPctinteger | nullWhole percent, 0 to 95.
marketsarray of stringtestBudgetMinorinteger | nullThe most a first test may cost in cash, minor units.
currencystringThe budget's currency: the one most of the company's invoices are in, else its billing currency (EUR with multi-currency billing off).
alertModeenumv1.1: how alerts reach the company.
"off"·"fold"·"mini_brief"
weightobjectweight
runsintegerWhat the next brief weighs, in Runs (0 when it is the first, which is free).
nominalintegerWhat it weighs when not free: 3, 5 with web research, 6 with web research on Max and Ultra.
freebooleanThe next brief is the company's first, and free.
briefRunsintegerA brief without web research: 3.
webRunsintegerA brief with web research on this plan.
alertRunsintegerv1.1: an alert's short brief: 1.
pipelineobjectv1.1: the idea pipeline by stage (
suggested,saved,testing,won,dropped), 30 each at most:{ id, briefId, title, level, decision, createdAt, wouldAct, outcomeVerdict, attribution }.pipelineCountsobjectv1.1: how many ideas are at each stage.
revenueobjectv1.1: revenue attributed from real invoices and deals.
revenue
quarterstringThe calendar quarter, e.g.
2026-Q4.broughtInarray of objectWhat tested ideas brought in this quarter, by currency, never converted.
broughtIn
currencystringamountMinorinteger
briefsarray of objectBy brief.
briefs
briefIdstringAn id.
broughtInarray of objectbroughtIn
currencystringamountMinorinteger
calibrationobject | nullv1.1: how earlier ranges compared with what tests brought in.
calibration
nintegerwithinintegerbelowintegeraboveintegermedianRationumber | nullRevenue brought in over the range's middle; null under three ended tests.
alertsarray of objectv1.1: the last ten alerts raised between briefs.
alerts
idstringAn id.
titlestringkindenum"repeated_request"·"lost_deal_reason"·"margin_outlier"·"trend"·"seasonality_gap"·"late_payer_cluster"·"contract_hint"·"post_traction"sourceenum"Säntis"·"Kesch"·"Eiger"·"Moléson"·"Titlis"·"Matterhorn"·"Inbox"whyenum"count"·"amount"·"new"beforeCountinteger | nullafterCountintegerbeforeAmountMinorinteger | nullafterAmountMinorinteger | nullcurrencystring | nullmodeenum"fold"·"mini_brief"statusenum"OPEN"·"FOLDED"·"BRIEFED"·"SKIPPED"runIdstring | nullAn id.
createdAtstring (date-time)
scheduleobject | nullWhen the next brief is written by itself; null when off or on request.
schedule
scheduleany ofschedule
- null
nextRunAtstring | null
runningobject | nullA brief being written now, or waiting to start.
running
runIdstringAn id.
statusenumWhere the Run is.
AWAITING_INPUT: it asked you a question (answer withPOST /v1/runs/{id}/checkin).AWAITING_APPROVAL: something it prepared waits on a person.QUEUED_FOR_ALLOWANCE: waiting for Runs; it starts by itself when there are.HELD_BY_BERNINA: finished, its answer held for a person to release."QUEUED"·"QUEUED_FOR_ALLOWANCE"·"COST_CEILING_HIT"·"STOPPED_BY_BERNINA"·"HELD_BY_BERNINA"·"RUNNING"·"AWAITING_APPROVAL"·"AWAITING_INPUT"·"BLOCKED"·"DONE"·"FAILED"·"CANCELLED"waitingForenumWhy a brief waits as
QUEUED_FOR_ALLOWANCE:email, the free first brief on Free until an owner confirms their address (as Run 0 does);runs, any other brief until Runs are back. Null while it is not waiting."email"·"runs"·null
latestobject | nullThe latest brief shown, or null before the first.
latest
idstringAn id.
runIdstring | nullAn id.
createdAtstring (date-time)webbooleanfreebooleanfocusstring | nullThe focus it was asked with.
keptCountintegerIdeas kept.
signalCountintegerSignals counted.
changesobject | nullWhat changed since the brief before, by signal (
NEW,GROWING,STEADY,FADING, andgone).outcomesarray of objectwebSourcesarray of objectdroppedobjectCounts of ideas the Stress test dropped, by reason.
signalsarray of objectThe signals counted in the company's own data, newest trend first, at most 30.
signals
keystringkindenum"repeated_request"·"lost_deal_reason"·"margin_outlier"·"trend"·"seasonality_gap"·"late_payer_cluster"·"contract_hint"·"post_traction"sourceenumThe agent whose records it comes from.
"Säntis"·"Kesch"·"Eiger"·"Moléson"·"Titlis"·"Matterhorn"·"Inbox"titlestringcountintegerwindowFromstring (date-time)windowTostring (date-time)amountMinorinteger | nullcurrencystring | nullstrengthintegertrendenum"NEW"·"GROWING"·"STEADY"·"FADING"linksarray of objectlinks
refstringlabelstring
extraobject | nullMore about the signal.
gonearray of any
cardsarray of OpportunityCardThe latest brief's ideas, three to five.
cards
followedarray of OpportunityCardIdeas saved or being tested from earlier briefs.
followed
historyarray of objectThe last twelve briefs.
history
idstringAn id.
runIdstring | nullAn id.
createdAtstring (date-time)keptCountintegersignalCountintegerwebbooleanfreeboolean
schemaOpportunityCard
idstringThe idea.
briefIdstringThe brief it came in.
statusenumKEPTby the Stress test, a stored cardRETURNEDbecause its signals grew, orVENTURE_TEST: a Venture plan's assumption, tested as an idea of its own."KEPT"·"STORED"·"RETURNED"·"VENTURE_TEST"rankinteger | nullIts place in the brief, 1 first.
levelenum"IMPROVE"·"ADJACENT"·"NEW_VENTURE"ideaTypeenum"new_offer"·"price_change"·"new_segment"·"bundle"·"channel"·"productised_service"·"new_venture"lensenum"customer_pull"·"competitor_gap"·"founder_strength"sizeenum"LOW"·"MID"·"HIGH"scoresobject | nullThe Stress test's scores:
{ evidence, effort, novelty }. Figures only.contentobjectThe card (packages/agents/src/opportunities/cards.ts,
CardContent).content
titlestringwhystringsizeobjectsize
bandenum"LOW"·"MID"·"HIGH"assumptionsarray of string
testobjecttest
actionstringThe first test.
effortDaysintegerAt most 7.
successobjectsuccess
metricenum"replies"·"meetings"·"deals_won"·"invoices"·"revenue"·"post_engagement"·"support_requests"targetintegerwindowDaysinteger7 to 60.
linestringThe success line, in words.
preparearray of objectWhat agents could prepare for the test.
prepare
agentenum"EIGER"·"MATTERHORN"·"SANTIS"·"DOM"whatenum"outreach_drafts"·"post_drafts"·"pricing"·"note"briefstring
risksarray of stringdisproofstringWhat would prove it wrong.
notAdvicestringOn every NEW_VENTURE card.
signalsarray of objectThe signals it rests on.
signals
keystringtitlestringkindstringsourcestring
linksarray of objectThe records behind it.
links
refstringThe record, in the Console's address form.
labelstring
webarray of objectWeb sources it cited, with web research on.
web
titlestringurlstring (uri)
stressTestobjectWhy the Stress test kept it.
stressTest
notestring
goalobjectv1.1: what the idea is against the company's goals:
revenueKind,needsHire,market,testCostMinorand itscurrency,belowMarginFloor.servesarray of enumv1.1: the goals the company set that it serves.
sizingobjectv1.1: a range worked out by code from the company's own money; absent where the base signal has none.
sizing
baseobjectThe signal whose own money the range is a share of.
base
signalKeystringtitlestringamountMinorintegercurrencystring
shareLowintegerWhole percent.
shareHighintegerWhole percent.
lowMinorintegerhighMinorintegercurrencystringThe base signal's own currency: never converted.
keyAssumptionstringsensitivityobjectThe range if the key assumption holds only half as much.
sensitivity
lowMinorintegerhighMinorinteger
whatMustBeTruearray of string
counterobjectv1.1: the strongest case against it from the data, as the Stress test wrote it.
counter
textstringsignalsarray of objectsignals
keystringtitlestring
voiceobjectv1.1: whether customers would pay, in their own words; every quote is held to its message.
voice
judgementenum"would_pay"·"unclear"·"would_not_pay"·"no_evidence"notestringquotesarray of objectquotes
refstringsupport_message:<id>: the customer's message.quotestringTheir own words, found in that message.
atstring (date-time)
decisionenumA person's decision, if any. WON and DROPPED only after a test.
"SAVED"·"NOT_FOR_US"·"TESTING"·"WON"·"DROPPED"·nulldecidedAtstring | nullfeedbackNotestring | nullWhy it was not for the company, as written.
testStartedAtstring | nullWhen the first test started: an approval from its briefs was carried out.
outcomeobject | nullWhat the test showed: the metric, the window and the figures.
outcomeVerdictstring | nullThe test's verdict.
createdAtstring (date-time)prepareAgentsarray of enumWho preparing the first test would brief, one brief each, 1 Run each.
wouldActbooleanv1.1: someone said they would act on it.
attributionobject | nullv1.1: what its test brought in, from invoices to and deals won with the people the test's approved messages reached; null before a test.
attribution
totalMinorintegercurrencystringendedbooleanThe window and its 30 days after are over.
invoicesintegerdealsintegertostring (date-time)
schemaPilatusEntity
idstringThe legal entity.
legalNamestringjurisdictionstringTwo letters, as on the entity.
supportedbooleanPilatus keeps a calendar for this jurisdiction, and its rules file is switched on for the company (EE, CH, AE; US with US formation on).
factsobjectWhat the calendar reads of the entity.
facts
fiscalYearEndstring | nullMM-DD; null: 31 December is assumed.vatRegisteredbooleanvatAssumedbooleanVAT registration was read from whether a VAT number is on record.
vatPeriodenum"MONTHLY"·"QUARTERLY"·"SEMI_ANNUAL"·"ANNUAL"·nullhasPayrollbooleanincorporatedOnstring | nullctRegisteredboolean | nullUAE corporate tax registered; null: not said.
legalFormenumA US entity's legal form, as a person recorded it.
"C_CORP"·"LLC"·nullsubdivisionenumThe state a US entity was formed in.
"US-DE"·null
obligationsarray of PilatusObligationobligations
standingarray of objectDuties that follow a change, shown, never dated.
standing
ruleIdstringtitlestringwithinstringWhen it falls due after a change ("within 30 days of a change").
needsReviewbooleansourcesarray of AgentsLegalSourcesources
whereToFileobject | nullWhere the person files it themselves; null where nothing is filed.
whereToFile
namestringurlstring (uri)
schemaPilatusObligation
idstringThe obligation.
entityIdstringThe legal entity.
ruleIdstringThe rule it comes from, e.g.
EE-ANNUAL-REPORT.titlestringThe obligation, in Zuger's English.
packKindenumWhat a filing pack for it holds.
"annual_report"·"general_meeting"·"vat_return"·"vat_reconciliation"·"payroll_return"·"beneficial_owners"·"tax_return"·"tax_registration"·"register_update"·"substance_report"·nullperiodStartstring (date)periodEndstring (date)dueOnstring (date)The statutory due date, never moved for weekends or holidays.
daysLeftintegerDays from today (the company's day) to the due date; negative when past.
needsReviewbooleanThe rule is not verified from an official source: to confirm with your adviser.
statusenum"UPCOMING"·"PREPARED"·"APPROVED"·"FILED"·"DISMISSED"stateenumHow it stands: due soon is within 14 days.
"filed"·"not_applicable"·"overdue"·"due_soon"·"upcoming"approvalIdstring | nullThe filing pack's approval, while one is prepared.
sourcesarray of AgentsLegalSourcesources
whereToFileobject | nullWhere the person files it themselves; null where nothing is filed.
whereToFile
namestringurlstring (uri)
filedAtstring | nullWhen a person said they filed it.
schemaRoutine
idstringAn id.
namestringinstructionstringWhat the agent is told each time.
cronstringThe schedule as cron, in its time zone.
timezonestringAn IANA time zone.
pausedbooleanexecutionModeenumBATCHruns on the Batch API."INTERACTIVE"·"BATCH"lastRunAtstring | nullnextRunAtstring | nullagentenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"scheduleany ofschedule
- null
whenstring | nullThe schedule in words.
runTypestringbrieffor a person's routine, or the routine Zuger set up for an agent (collections_sweep,statutory_calendar_check,contract_deadlines_check,social_report,hiring_pipeline,engineering_digest,opportunities_brief).runsintegerWhat it weighs each time it runs, in Runs, shown before it does.
schemaRoutineScheduleWhen a routine runs, in its time zone (packages/accounts/src/schedule.ts). `minute` may be left out on input (0).
When a routine runs, in its time zone (packages/accounts/src/schedule.ts). minute may be left out on input (0).
- object Every day at a time.
everyenum"day"hourinteger0–23.
minimum0· maximum23minuteinteger0–59.
minimum0· maximum59
- object Monday to Friday at a time.
everyenum"weekdays"hourinteger0–23.
minimum0· maximum23minuteinteger0–59.
minimum0· maximum59
- object One day a week at a time.
everyenum"week"weekdayinteger0 = Sunday … 6 = Saturday, as cron counts.
minimum0· maximum6hourinteger0–23.
minimum0· maximum23minuteinteger0–59.
minimum0· maximum59
- object One day a month at a time.
everyenum"month"dayinteger1–28.
minimum1· maximum28hourinteger0–23.
minimum0· maximum23minuteinteger0–59.
minimum0· maximum59
schemaRunSummary
idstringAn id.
titlestringstatusenumWhere the Run is.
AWAITING_INPUT: it asked you a question (answer withPOST /v1/runs/{id}/checkin).AWAITING_APPROVAL: something it prepared waits on a person.QUEUED_FOR_ALLOWANCE: waiting for Runs; it starts by itself when there are.HELD_BY_BERNINA: finished, its answer held for a person to release."QUEUED"·"QUEUED_FOR_ALLOWANCE"·"COST_CEILING_HIT"·"STOPPED_BY_BERNINA"·"HELD_BY_BERNINA"·"RUNNING"·"AWAITING_APPROVAL"·"AWAITING_INPUT"·"BLOCKED"·"DONE"·"FAILED"·"CANCELLED"agentenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"startedAtstring | nullNull for a Run that never started (expired, paused, off shift).
endedAtstring | nullcreatedAtstring (date-time)nodesintegerIts steps.
approvalsintegerApprovals it asked for.
costMinorintegerWhat its model calls cost, in US cents.
schemaRunTrace
runIdstringAn id.
companyIdstringAn id.
entityIdstring | nullThe legal entity it was about, if any.
agentKindenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"mandateVersionintegertitlestringstatusenumWhere the Run is.
AWAITING_INPUT: it asked you a question (answer withPOST /v1/runs/{id}/checkin).AWAITING_APPROVAL: something it prepared waits on a person.QUEUED_FOR_ALLOWANCE: waiting for Runs; it starts by itself when there are.HELD_BY_BERNINA: finished, its answer held for a person to release."QUEUED"·"QUEUED_FOR_ALLOWANCE"·"COST_CEILING_HIT"·"STOPPED_BY_BERNINA"·"HELD_BY_BERNINA"·"RUNNING"·"AWAITING_APPROVAL"·"AWAITING_INPUT"·"BLOCKED"·"DONE"·"FAILED"·"CANCELLED"startedAtstring | nullendedAtstring | nullnodesarray of objectIts steps, oldest first.
nodes
idstringAn id.
kindenum"THINK"·"TOOL_READ"·"TOOL_WRITE"·"FANOUT"·"REDUCE"·"HANDOFF"·"APPROVAL_INTERRUPT"·"OUTPUT"labelstringstatusenum"PENDING"·"RUNNING"·"WAITING"·"DONE"·"FAILED"·"SKIPPED"modelstring | nullcostMinorintegerUS cents.
latencyMsinteger | nullstartedAtstring | nullendedAtstring | nullpayloadobject | nullWhat the step read or wrote (tool calls, the answer, a document), redacted before it leaves.
approvalsarray of objectWhat it asked for.
approvals
idstringAn id.
categoryenumWhat kind of decision it is.
"MONEY_OUT"·"FILING"·"CONTRACT"·"CUSTOMER_FACING"·"DATA_WRITE"·"SCHEDULING"·"INTERNAL_NOTE"·"BERNINA_REVIEW"·"UPGRADE_OFFER"·"TOPUP"titlestringsummarystringreasoningstringstatusenumWhere the decision is.
"PENDING"·"APPROVED"·"REJECTED"·"EXPIRED"·"CANCELLED"decidedByUserIdstring | nullAn id.
decidedAtstring | nullcredentialIdstring | nullThe passkey that signed it.
humanNextStepstring | nullWhat is left for a person to do.
heldobject | nullOn a Bernina review: what she held back. Never given to an API key or a connected app (left out).
expiresAtstring | nullOn a Bernina review: when it lapses.
handoffsarray of objectWork it handed to another agent.
handoffs
fromAgentKindenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"toAgentKindenumThe kind of agent:
CHIEF_OF_STAFFis Dom,LEDGERSäntis,COLLECTIONSKesch,REGISTRARPilatus,SENTINELTitlis,FORGEGotthard,CHORUSZermatt,MARKETINGMatterhorn,SUPPORTMoléson,SCOUTEiger."CHIEF_OF_STAFF"·"LEDGER"·"SCOUT"·"REGISTRAR"·"SENTINEL"·"FORGE"·"CHORUS"·"MARKETING"·"COLLECTIONS"·"SUPPORT"atNodeIdstringAn id.
becausestring
memoryarray of objectMemory it acted on.
memory
itemIdstringAn id.
kindstringcontentstringbecausestring
berninaobject | nullBernina's three checkpoints; null where she has not looked yet.
bernina
preobject | nullpre
decisionenumWhat Bernina decided at this checkpoint.
"pass"·"redact"·"block"·"escalate"reasonsarray of stringReason codes, never the words they are about.
modeenumobserve: noted only;enforce: acted on."observe"·"enforce"atstring (date-time)userDecisionobject | nulluserDecision
decisionstringA person's decision on an escalation.
reasonsarray of stringatstring (date-time)
inRunobject | nullinRun
decisionenumWhat Bernina decided at this checkpoint.
"pass"·"redact"·"block"·"escalate"reasonsarray of stringReason codes, never the words they are about.
modeenumobserve: noted only;enforce: acted on."observe"·"enforce"atstring (date-time)userDecisionobject | nulluserDecision
decisionstringA person's decision on an escalation.
reasonsarray of stringatstring (date-time)
postobject | nullpost
decisionenumWhat Bernina decided at this checkpoint.
"pass"·"redact"·"block"·"escalate"reasonsarray of stringReason codes, never the words they are about.
modeenumobserve: noted only;enforce: acted on."observe"·"enforce"atstring (date-time)userDecisionobject | nulluserDecision
decisionstringA person's decision on an escalation.
reasonsarray of stringatstring (date-time)
totalsobjecttotals
nodesintegercostMinorintegerUS cents.
latencyMsintegermodelsUsedarray of string
summarystringThe one-line answer to "what happened".
schemaSealedRequestA Seal request, as the company sees it: people at Zuger by name only.
A Seal request, as the company sees it: people at Zuger by name only.
idstringThe Seal request.
companyIdstringAn id.
scopeenumWhat the request covers: one Run, or named documents.
"RUN"·"DOCUMENTS"runIdstring | nullThe Run, where the scope is RUN.
documentIdsarray of stringThe documents, where the scope is DOCUMENTS.
reasonstringWhy the person at Zuger asked.
requestedMinutesintegerHow long they asked for.
statusenumWhere it stands.
"PENDING"·"APPROVED"·"DENIED"·"REVOKED"·"EXPIRED"·"WITHDRAWN"approvedMinutesinteger | nullHow long it was approved for.
expiresAtstring | nullWhen the access ends.
decidedAtstring | nullrevokedAtstring | nullWhen it was ended early.
firstAccessAtstring | nullWhen the first value was opened under it.
createdAtstring (date-time)openbooleanWhether access is open now.
looksintegerValues opened under it.
requestedBystring | nullWho at Zuger asked, by name.
decidedBystring | nullWho decided, by name.
schemaSellerMppOrderOne order Zuger sells over MPP.
One order Zuger sells over MPP.
idstringThe order (
mpo_…, 192 random bits): its address is the capability to pay it.kindenum"RUNS_TOPUP"·"STORE_LISTING"runsinteger | null50 or 200, for a top-up.
listingIdstring | nullThe Zuger Store listing by Zuger, for a term.
descriptionstringZuger's own words about the item.
netMinorintegerThe published price, minor units.
vatMinorintegerThe VAT your billing details decide.
totalMinorintegerWhat the agent pays.
currencystringstatusenum"OPEN"·"PAYING"·"PAID"·"FULFILLED"·"REFUNDING"·"REFUNDED"·"EXPIRED"·"CANCELLED"expiresAtstring (date-time)An unpaid order lapses then.
paidAtstring | nullfulfilledAtstring | nullservesUntilstring | nullA Store term ends then, by itself.
buyerobjectbuyer
kindenum"NONE"·"ZUGER_KYA"verifiedbooleanWhether the buyer agent's Zuger credential verified (KYA).
codestring | nullThe verifier's code.
subjectstring | nullThe agent's opaque DID, when it verified.
payAddressstring (uri)Where an agent pays it: an HTTP 402 challenge, then the shared payment token.
createdByTypeenum"USER"·"AGENT"createdAtstring (date-time)
schemaStoreHireSomething this company hired and has not let go of.
Something this company hired and has not let go of.
idstringThe hire.
listingIdstringAn id.
statusenumPENDING_APPROVAL while an agent's hire waits for a person.
"PENDING_APPROVAL"·"ACTIVE"byenumWho hired it.
"AGENT"·"USER"createdAtstring (date-time)viaPackbooleanIt came with a pack.
schemaStoreHireResult
idstringThe hire.
listingIdstringAn id.
statusenumACTIVE: hired. PENDING: the money is taken and Stripe has not settled it yet; it starts (or is refunded) when Stripe says. NEEDS_CONFIRMATION: the bank wants the person to confirm the payment (3-D Secure); nothing is hired or charged until they do. CANCELLED: it no longer fits, and what was paid is refunded.
"ACTIVE"·"PENDING"·"NEEDS_CONFIRMATION"·"CANCELLED"notestringWhat happened, in a sentence for a person.
needsActionbooleanPresent with NEEDS_CONFIRMATION: confirm the payment with Stripe.js, then call
POST /v1/marketplace/{id}/hire/confirm.clientSecretstringThe client secret Stripe.js confirms in the browser. Zuger never sees a card.
publicKeystring | nullStripe's publishable key, to mount Stripe.js; null where it is not configured.
schemaStoreListingA listing on the Zuger Store's shelf.
A listing on the Zuger Store's shelf.
idstringThe listing.
kindenum"SKILL"·"AGENT"·"PACK"namestringblurbstringWhat it does, in the seller's words.
agentKindstring | nullFor an agent listing: the kind of agent it puts on shift.
priceMinorintegerThe monthly price in cents; 0 is free.
currencystringThe currency the seller priced it in (listings are priced in EUR).
localPriceMinorintegerA priced listing of another company, for a company billed in another currency than EUR: what it is charged a month, in that currency's minor unit (the price table's rule).
localCurrencyenumThe currency of
localPriceMinor: the company's billing currency."EUR"·"USD"·"CHF"·"GBP"·"AED"byZugerbooleanZuger's own listing.
sellerstringThe selling company's name, or "Zuger".
postedBystring | nullWho posted it: a first name and an initial; null for Zuger's own.
sellerVerifiedbooleanStripe has verified the selling company (the gold tick). Never for Zuger's own, or a seller on hold.
kyaVerifiedbooleanWhere
kya_storeis on for the reader: an outside seller's agent listing that passed the listing gate (Stripe's check, Bernina's scan, the Verified fee) and is Verified now. Not the gold tick.posterVerifiedbooleanThe person who posted it confirmed their email address (the blue tick).
minebooleanYour company sells it.
createdAtstring (date-time)ratingStoreRatingStars from people whose company hired the listing (hidden reviews not counted).
rating
activeHiresintegerCompanies it is on shift at now.
everHiredintegerCompanies that ever hired it.
reputationobjectreputation
badgeenum"NEW"·"RISING"·"TRUSTED"·"TOP_RATED"labelstringThe badge in words.
becausestringWhy it has that badge.
myReviewobject | nullWhat the person asking said of it.
myReview
starsintegerminimum1· maximum5commentstring | null
canReviewbooleanYour company hired it and does not sell it.
itemsarray of objectA pack: what is in it.
items
idstringAn id.
namestringkindenum"SKILL"·"AGENT"·"PACK"agentKindstring | null
itemsValueMinorintegerA pack: what its items would cost one by one, in cents a month.
schemaStoreRatingStars from people whose company hired the listing (hidden reviews not counted).
Stars from people whose company hired the listing (hidden reviews not counted).
averagenumber | nullAverage stars, to one decimal; null with no ratings.
countintegerHow many people rated it.
spreadarray of integerHow many gave one to five stars, in that order (zeros on the shelf, where only the average and count are read).
schemaStoreReview
idstringThe review.
starsintegerminimum1· maximum5commentstring | nullWhat they wrote; null where there is none, or its text is held back after reports (shown to its writer and Zuger only).
heldbooleanIts text is held back after three companies that hired the listing reported it.
hiddenbooleanZuger hid it: not shown to others, not counted. Shown to its writer, so they know.
reportedbooleanYou reported it.
reportsintegerZuger only: how many reports it has.
reasonsarray of stringZuger only: the reasons given.
bystringIts writer: a first name and an initial, never a company or an address.
byVerifiedbooleanIts writer confirmed their email address.
minebooleanYou wrote it.
atstring (date-time)editedbooleanChanged more than a minute after it was written.
commentsarray of objectComments under it, oldest first (twenty at most).
comments
idstringAn id.
bodystringbystringA first name and an initial, or "Zuger" for Zuger's replies under its own listings.
sellerbooleanWritten by the listing's seller.
minebooleanatstring (date-time)
schemaSupportRating"Was this helpful?": null when it is not asked and was never answered.
"Was this helpful?": null when it is not asked and was never answered.
askedbooleanWhether it is asked: Zuger closed the conversation.
valueenumThe answer.
"yes"·"no"·nullnotestring | nullThe optional line.
atstring | nullWhen it was given or last changed.
untilstring | nullUntil when it can be changed (7 days from the first answer).
openbooleanWhether it can be given or changed now.
schemaSupportThread
idstringThe conversation.
subjectstringcategoryenum"billing"·"agents"·"connections"·"account"·"bug"·"other"statusenumOPEN: nobody at Zuger answered yet; WAITING_ON_CUSTOMER: Zuger answered last; WAITING_ON_ZUGER: the customer wrote again; DONE: closed.
"OPEN"·"WAITING_ON_CUSTOMER"·"WAITING_ON_ZUGER"·"DONE"createdAtstring (date-time)closedAtstring | nulllastAtstring (date-time)The newest activity.
lastStaffAtstring | nullZuger's last reply.
unreadbooleanA reply from Zuger not read yet.
minebooleanThis person opened it.
openedBystring | nullWho opened it, by name (an owner or admin sees everyone's).
runIdstring | nullThe Run it is about.
approvalIdstring | nullThe approval it is about.
schemaTitlisContract
idstringThe contract.
documentIdstringThe uploaded file it was read from.
titlestringcounterpartystring | nullourSidestring | nulllanguagestringThe contract's language.
verdictenum"blocked"·"flagged"·"meets"blockedintegerflaggedintegereffectiveOnstring | nulltermEndsOnstring | nullrenewsOnstring | nullnoticeBystring | nullThe last day to give notice.
autoRenewsboolean | nullnoticeDaysinteger | nullfindingsarray of TitlisFindingfindings
termsarray of objectThe key terms as figures, never the clauses' words.
terms
typestringThe clause type.
refstringIts number.
monthsintegerdaysintegerautobooleancapstringamountMinorintegercurrencystringcountrystringownerstringbackgroundAssignedbooleanmutualbooleanyearsintegerforCausebooleanconveniencestringconvenienceDaysintegerearliestDaysinteger
playbookVersionintegerThe playbook version it was held against.
reviewStatusenum"PROPOSED"·"TAKEN"·"DECLINED"·"LAPSED"approvalIdstring | nullAn id.
reviewedAtstring (date-time)deadlinesarray of objectdeadlines
idstringThe contract date.
contractIdstringAn id.
kindenum"notice_window_opens"·"notice_by"·"renews_on"·"ends_on"dueOnstring (date)daysLeftintegerstatusenum"UPCOMING"·"DONE"·"DISMISSED"overdueboolean
schemaTitlisFinding
positionIdenum"liability_cap"·"notice"·"renewal"·"term"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"clauseenum"parties"·"term"·"renewal"·"notice"·"liability_cap"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"severityenum"ok"·"flag"·"block"reasonstringA reason key (
cap_low,notice_long, …), said in the reader's language by the Console.varsmap of string | numberThe figures the reason holds.
refstring | nullThe clause's number; null where the clause is missing.
citationsarray of any ofcitations
- object
kindenum"clause"documentIdstringAn id.
refstringThe clause's number.
clauseenum"parties"·"term"·"renewal"·"notice"·"liability_cap"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"
- object
kindenum"document"documentIdstringAn id.
missingenum"parties"·"term"·"renewal"·"notice"·"liability_cap"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"
- object
kindenum"playbook"positionIdenum"liability_cap"·"notice"·"renewal"·"term"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"versionintegercovenantboolean
schemaTitlisPlaybook
versionintegerBumped on every save; 0 is Zuger's defaults.
positionsarray of TitlisPositionpositions
defaultsarray of TitlisPositionZuger's defaults.
defaults
boundsmap of array of numberThe bounds of each position's figure, by position id.
schemaTitlisPosition
idenum"liability_cap"·"notice"·"renewal"·"term"·"governing_law"·"payment_terms"·"ip"·"confidentiality"·"termination"onbooleanseverityenumflag: a redline is suggested;block: not to be signed as it stands."flag"·"block"sourcestring | nullWhere the rule comes from, in the company's words; null: the playbook.
valueany ofThe position's figure (months, days or years, by position), the countries for governing_law, or null for ip.
value
- number
- array of string
- null
schemaVentureContentThe plan's words. Prose names figures as tokens, `{{key}}` or `{{key.low}}`/`{{key.high}}`: price, grossMarginPct, cac, churnPct, paybackMonths, ltv, ltvToCac, contributionMarginPct, breakEvenMonth, runwayMonths, lowestCash, lowestCashMonth, fundingNeed, revenueMonth12, revenueEnd, revenueYear1, revenueYear2, customersEnd, cashEnd, startingCash, fixedMonthly, marketingMonthly, setupCost, fundingAmount, months, newCustomersTotal.
The plan's words. Prose names figures as tokens, {{key}} or {{key.low}}/{{key.high}}: price, grossMarginPct, cac, churnPct, paybackMonths, ltv, ltvToCac, contributionMarginPct, breakEvenMonth, runwayMonths, lowestCash, lowestCashMonth, fundingNeed, revenueMonth12, revenueEnd, revenueYear1, revenueYear2, customersEnd, cashEnd, startingCash, fixedMonthly, marketingMonthly, setupCost, fundingAmount, months, newCustomersTotal.
titlestringlanguageenumThe language the words are written in.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"companyobjectcompany
namestringcountrystring | null
cardobject | nullThe Opportunities idea it was made from.
card
idstringAn id.
titlestringlevelstring
dataFiguresarray of objectFigures counted from the company's own records, each with its records.
dataFigures
idstringD1, D2…
keystringlabelstringvaluenumberunitenum"money"·"count"·"pct"currencystring | nulllinksarray of objectlinks
refstringA record of the company,
<kind>:<id>.labelstring
webarray of objectThe web sources read, with web research on.
web
idstringW1, W2…
titlestringurlstring (uri)
sectionsobjectsections
ideaobjectThe problem, the customer, why now, and evidence: each on signals with their records, or a customer's own words with their message.
identityobjectTwo or three drafts each of a mission, a vision and values, and which are chosen.
marketobjectCompetitors, gaps and a rough size: from the web with sources, or marked as assumptions.
economicsobjectPricing options and the narrative; the figures are the model's.
strategyobjectPositioning, the first 100 customers, channels, what not to do.
setupobjectThe countries compared (CH, EE, AE and the company's own), the comparison in words and questions for an adviser. Not legal or tax advice.
planobjectMilestones for 90 days and 12 months, and the team.
risksobjectThe Stress test and pre-mortem.
risks
counterArgumentsarray of objectcounterArguments
textstringsectionenumOne of the ten sections.
"idea"·"identity"·"market"·"economics"·"strategy"·"setup"·"plan"·"risks"·"sustainability"·"funding"
killCriteriaarray of objectkillCriteria
metricenum"cac"·"churnPct"·"grossMarginPct"·"paybackMonths"·"customers"·"revenueMonthly"·"cash"openum"above"·"below"thresholdnumberbyMonthintegerwhystring
preMortemarray of objectpreMortem
whystringearlySignstring
verdictstring
sustainabilityobjectImpact, responsible-business choices, and targets on the UN SDGs, each marked an estimate.
fundingobjectBootstrapped, investors or mixed; what to raise and why; grants only with web research, each with its source. Not investment advice.
schemaVentureModelThe economics model. Every figure in the plan is computed from it in code (apps/console/public/venture-model.js).
The economics model. Every figure in the plan is computed from it in code (apps/console/public/venture-model.js).
currencystringThe company's own currency.
monthsenumThe horizon.
12·18·24·36billingenum"monthly"·"one_off"valuesmap of numberEvery input by key: price, grossMarginPct, startCustomers, organicNew, marketingMonthly, marketingGrowthPct, cac, churnPct, fixedMonthly, hireMonthly, hireFrom, setupCost, startingCash, fundingAmount, fundingMonth. Money in major units of the currency; percentages as numbers.
scenariosobjectThe low and high cases: multipliers on price, CAC, churn and organic growth; points on gross margin.
scenarios
lowmap of numberhighmap of number
metamap of objectWhere each input comes from: the assumption ledger.
meta
sourceenumdata: the company's own records (with its D figure and links);assumption: with a confidence and how to test it."data"·"assumption"dataIdstringThe data figure, D1…
linksarray of objectlinks
refstringA record of the company,
<kind>:<id>.labelstring
confidenceenum"low"·"medium"·"high"basisstringWhy this value.
testobjectA one-week test, Opportunities' format.
test
actionstringWhat to do, at most a week of work.
effortDaysintegerAt most 7.
metricenum"replies"·"meetings"·"deals_won"·"invoices"·"revenue"·"post_engagement"·"support_requests"targetintegerwindowDaysinteger7 to 60.
linestringThe success line, in words.
statusenum"open"·"testing"·"confirmed"·"refuted"cardIdstringThe Opportunities card testing it.
resultobjectWhat its test showed, taken back into the plan.
result
verdictstringvaluenumber | nulltargetnumberatstring (date-time)
schemaVenturePlanPage
availableenumtrueplanobjectplan
idstringAn id.
titlestringstatusenumHELD: waiting for Bernina's review."DRAFTING"·"READY"·"HELD"·"FAILED"versionintegerThe current version (0 while the first is written).
languageenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"currencystringwebbooleancardIdstring | nullAn id.
sectionRunningenumOne of the ten sections.
"idea"·"identity"·"market"·"economics"·"strategy"·"setup"·"plan"·"risks"·"sustainability"·"funding"·nullreviewDueAtstring | nullWhen Dom asks for the monthly review.
ratinginteger | null1 to 5.
wouldUseboolean | nullcreatedAtstring (date-time)updatedAtstring (date-time)
sharingbooleanWhether sharing is switched on for the company.
eligiblebooleanWhether the company's plan has Venture plans (Pro, Max and Ultra).
weightobjectweight
sectionintegerA section again: 2 Runs.
firstStepintegerEach agent preparing a first step: 1 Run.
testintegerEach agent preparing a test: 1 Run.
runningobject | nullThe Run writing it now, or the last one.
running
runIdstringAn id.
statusstring
reviewDuebooleanThe monthly review is due.
contentobject | nullThe plan's words. Prose names figures as tokens,
{{key}}or{{key.low}}/{{key.high}}: price, grossMarginPct, cac, churnPct, paybackMonths, ltv, ltvToCac, contributionMarginPct, breakEvenMonth, runwayMonths, lowestCash, lowestCashMonth, fundingNeed, revenueMonth12, revenueEnd, revenueYear1, revenueYear2, customersEnd, cashEnd, startingCash, fixedMonthly, marketingMonthly, setupCost, fundingAmount, months, newCustomersTotal.content
titlestringlanguageenumThe language the words are written in.
"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"companyobjectcompany
namestringcountrystring | null
cardobject | nullThe Opportunities idea it was made from.
card
idstringAn id.
titlestringlevelstring
dataFiguresarray of objectFigures counted from the company's own records, each with its records.
dataFigures
idstringD1, D2…
keystringlabelstringvaluenumberunitenum"money"·"count"·"pct"currencystring | nulllinksarray of objectlinks
refstringA record of the company,
<kind>:<id>.labelstring
webarray of objectThe web sources read, with web research on.
web
idstringW1, W2…
titlestringurlstring (uri)
sectionsobjectsections
ideaobjectThe problem, the customer, why now, and evidence: each on signals with their records, or a customer's own words with their message.
identityobjectTwo or three drafts each of a mission, a vision and values, and which are chosen.
marketobjectCompetitors, gaps and a rough size: from the web with sources, or marked as assumptions.
economicsobjectPricing options and the narrative; the figures are the model's.
strategyobjectPositioning, the first 100 customers, channels, what not to do.
setupobjectThe countries compared (CH, EE, AE and the company's own), the comparison in words and questions for an adviser. Not legal or tax advice.
planobjectMilestones for 90 days and 12 months, and the team.
risksobjectThe Stress test and pre-mortem.
risks
counterArgumentsarray of objectcounterArguments
textstringsectionenumOne of the ten sections.
"idea"·"identity"·"market"·"economics"·"strategy"·"setup"·"plan"·"risks"·"sustainability"·"funding"
killCriteriaarray of objectkillCriteria
metricenum"cac"·"churnPct"·"grossMarginPct"·"paybackMonths"·"customers"·"revenueMonthly"·"cash"openum"above"·"below"thresholdnumberbyMonthintegerwhystring
preMortemarray of objectpreMortem
whystringearlySignstring
verdictstring
sustainabilityobjectImpact, responsible-business choices, and targets on the UN SDGs, each marked an estimate.
fundingobjectBootstrapped, investors or mixed; what to raise and why; grants only with web research, each with its source. Not investment advice.
modelobject | nullThe economics model. Every figure in the plan is computed from it in code (apps/console/public/venture-model.js).
model
currencystringThe company's own currency.
monthsenumThe horizon.
12·18·24·36billingenum"monthly"·"one_off"valuesmap of numberEvery input by key: price, grossMarginPct, startCustomers, organicNew, marketingMonthly, marketingGrowthPct, cac, churnPct, fixedMonthly, hireMonthly, hireFrom, setupCost, startingCash, fundingAmount, fundingMonth. Money in major units of the currency; percentages as numbers.
scenariosobjectThe low and high cases: multipliers on price, CAC, churn and organic growth; points on gross margin.
scenarios
lowmap of numberhighmap of number
metamap of objectWhere each input comes from: the assumption ledger.
meta
sourceenumdata: the company's own records (with its D figure and links);assumption: with a confidence and how to test it."data"·"assumption"dataIdstringThe data figure, D1…
linksarray of objectlinks
refstringA record of the company,
<kind>:<id>.labelstring
confidenceenum"low"·"medium"·"high"basisstringWhy this value.
testobjectA one-week test, Opportunities' format.
test
actionstringWhat to do, at most a week of work.
effortDaysintegerAt most 7.
metricenum"replies"·"meetings"·"deals_won"·"invoices"·"revenue"·"post_engagement"·"support_requests"targetintegerwindowDaysinteger7 to 60.
linestringThe success line, in words.
statusenum"open"·"testing"·"confirmed"·"refuted"cardIdstringThe Opportunities card testing it.
resultobjectWhat its test showed, taken back into the plan.
result
verdictstringvaluenumber | nulltargetnumberatstring (date-time)
ledgerarray of objectThe assumption ledger.
ledger
keyenum"price"·"grossMarginPct"·"startCustomers"·"organicNew"·"marketingMonthly"·"marketingGrowthPct"·"cac"·"churnPct"·"fixedMonthly"·"hireMonthly"·"hireFrom"·"setupCost"·"startingCash"·"fundingAmount"·"fundingMonth"valuenumbersourceenum"data"·"assumption"confidenceenum"low"·"medium"·"high"basisstringlinksarray of objectlinks
refstringA record of the company,
<kind>:<id>.labelstring
testobject | nullA one-week test, Opportunities' format.
test
actionstringWhat to do, at most a week of work.
effortDaysintegerAt most 7.
metricenum"replies"·"meetings"·"deals_won"·"invoices"·"revenue"·"post_engagement"·"support_requests"targetintegerwindowDaysinteger7 to 60.
linestringThe success line, in words.
statusenum"open"·"testing"·"confirmed"·"refuted"cardIdstring | nullAn id.
resultobject | nullWhat its test showed.
swingnumber | nullHow far ±20% of it moves break-even, in months.
rankinteger | nullIts place in the sensitivity view, 1 moving break-even most.
firstTestsarray of enumThe assumptions to test first.
editablemap of array of objectEvery prose field a person may edit, by section.
editable
pathstringtextstringAs written, figures as tokens.
firstStepsobjectfirstSteps
atstring | nullbriefsintegeragentsarray of objectWho prepares each first step now.
agents
agentstringwhatstring
versionsarray of objectEvery version, newest first, 60 at most.
versions
numberintegerreasonenum"generated"·"section_regenerated"·"section_edited"·"inputs_changed"·"drafts_chosen"·"test_started"·"test_result"·"restored"·"reviewed"·"ask_scenario"·"demand_result"·"team_plan"sectionenumOne of the ten sections.
"idea"·"identity"·"market"·"economics"·"strategy"·"setup"·"plan"·"risks"·"sustainability"·"funding"·nullcreatedAtstring (date-time)byUserIdstring | nullAn id.
runIdstring | nullAn id.
exportsarray of objectexports
idstringAn id.
versionintegerformatenum"pdf"·"docx"·"xlsx"·"csv"·"summary_pdf"·"pitch_pdf"·"interview_pdf"·"interview_docx"·"formation_pdf"·"legal_pdf"·"legal_docx"·"captable_xlsx"langenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"sizeBytesintegercreatedAtstring (date-time)
sharesarray of objectShared links (where sharing is on).
shares
idstringAn id.
langenum"en"·"de"·"fr"·"es"·"it"·"ja"·"zh-CN"·"ar"expiresAtstring (date-time)revokedAtstring | nullopensintegerlastOpenedAtstring | nullcreatedAtstring (date-time)
schemaWebhookEndpointAn address the company's events are sent to. Its signing secret is never read back.
An address the company's events are sent to. Its signing secret is never read back.
idstringThe address's id.
urlstring (uri)The public https address events are POSTed to.
eventsarray of enumThe events it hears. Empty: every event.
activebooleanWhether deliveries go to it. Switched off by itself after twenty failed deliveries in a row.
failuresintegerDeliveries that failed in a row (every attempt). Reset by a delivery that arrives, or by switching it back on.
lastDeliveryAtstring | nullWhen a delivery was last tried to its end.
lastStatusinteger | nullThe HTTP status the last delivery got; 0 where nothing answered.
createdAtstring (date-time)
Error codes
Every code the API sends, with its English as the API says it and the params it carries. In any language but English, each also shows the Console’s words for it in yours, where its dictionary has them; the API itself always sends English.
storage_limit_upgrade Your files have reached the {limit} included in {plan}, so this one was not kept. Your files are safe and still open. Upgrade to {next} for {nextLimit}, or remove files you no longer need.
limitplannextnextLimitstorage_limit_top Your files have reached the {limit} included in {plan}, so this one was not kept. Your files are safe and still open. Remove files you no longer need, or talk to us about more room.
limitplanlink_owner_admin Only the owner or an admin can connect or disconnect Link, signed in.
link_us_only Link financial insights is available to US customers only.
link_not_set_up Link is not set up on this deployment yet.
link_attempt_expired This Link connection attempt expired. Start it again from Connectors.
link_someone_else This Link connection was started by someone else, or for another company.
link_not_connected Link is not connected.
link_retention_choice Choose 30, 90, 180 or 365 days.
link_not_zugers This Link connection attempt is not one Zuger started.
link_no_financial_data Link did not share any financial data with Zuger. Connect again and allow the accounts you want your agents to read.
link_not_accepted Link did not accept this connection. Start it again from Connectors: the link from Link works once, for ten minutes.
stripe_could_not_do_nothing Stripe could not do that: {reason} Nothing was charged.
reasononly_owner_can_accept_terms Only an owner of this company can accept the Terms for it.
terms_changed_since_page_opened The Terms changed since this page was opened. Read the current Terms, then accept them.
company_signs_single_sign_choose Your company signs in with single sign-on. Choose "Single sign-on" and use your work address.
only_owner_admin_can_change Only the owner or an admin can change where this company's events are sent.
another_stripe_event_company_being Another Stripe event for this company is being applied.
another_stripe_event_company_being_applied Another Stripe event for this company is being applied. Stripe sends this one again.
stripe_not_configured_deployment_so Stripe is not configured on this deployment, so nothing can be charged. Nothing was.
card_has_been_settled_already This card has been settled already. Nothing was charged.
already_so_card_has_nothing You are on {plan} already, so this card has nothing left to do. Nothing was charged.
planplan_changed_since_card_opened Your plan changed since this card opened, and so did the price of a top-up. Ask for a new one from Billing. Nothing was charged.
there_no_card_file_yet There is no card on file yet. Add one in Settings, under Billing. Nothing was charged.
free_plan_has_no_top The Free plan has no top-ups: move up a plan instead. Nothing was charged.
give_company_its_legal_name Give the company its legal name, 2 to 120 characters.
country_two_letter_code_such The country is a two-letter code, such as EE, DE or GB.
currency_three_letter_code_such The currency is a three-letter code, such as EUR.
number_too_long That number is too long.
pack_has_nothing That pack has nothing in it.
stripe_not_configured_deployment_so_priced Stripe is not configured on this deployment, so a priced listing cannot be hired.
billing_not_open_yet_so Billing is not open yet, so a priced listing cannot be charged. Nothing was charged.
seller_leaving_zuger_so_listing The seller is leaving Zuger, so this listing can no longer be hired. Nothing was charged.
seller_has_not_finished_setting The seller has not finished setting up payouts, so this listing cannot be charged yet. Nothing was charged.
priced_listing_charged_payment_method A priced listing is charged to your payment method, and there is none on file yet. Add one in Settings, under Billing, then hire again. Nothing was charged.
priced_listing_invoiced_vat_which A priced listing is invoiced with VAT, which depends on where your company is. Add your billing country with your payment method in Settings, under Billing, then hire again. Nothing was charged.
hire_not_there_any_more That hire is not there any more. Nothing was charged.
not_in_company You are not in this company.
approval_about_money_so_company This approval is about money, so in this company it is decided by the owner. You can read it; someone with that role decides.
approval_about_money_so_company_decided This approval is about money, so in this company it is decided by an owner or an admin. You can read it; someone with that role decides.
approval_about_money_so_company_decided_anyone This approval is about money, so in this company it is decided by anyone in the company. You can read it; someone with that role decides.
only_owner_can_change_persons Only the owner can change a person's role or remove them.
only_owner_admin_can_set Only an owner or an admin can set routines.
only_owner_can_change_sso Only the owner can change single sign-on.
only_owner_can_change_who_decides Only the owner can change who decides approvals.
only_owner_admin_can_change_entities Only the owner or an admin can change the company's legal entities.
only_owner_admin_can_choose_tool_company Only the owner or an admin can choose which company a connected tool belongs to.
only_owner_admin_can_export_data Only the owner or an admin can export the company's data.
agent_not_switched_on_brief {agent} is not switched on for this company yet, so it cannot be briefed.
agentroutines_come_up Routines come with {needed} and up. You are on {plan}.
neededplansay_what_want_done Say what you want done.
brief_too_long_keep_under That brief is too long. Keep it under 4,000 characters.
no_worker_configured_run_brief No worker is configured to run a brief on this deployment.
agent_not_shift_put_shift That agent is not on shift. Put it on shift first, then brief it.
kesch_not_switched_company_yet Kesch is not switched on for this company yet.
one_those_files_not_here One of those files is not here any more. Attach it again.
web_search_not_set_up Web search is not set up on this deployment yet.
confirm_its_first_passkey_password Confirm it’s you first, with your passkey or your password.
signature_has_already_been_used That signature has already been used. Start again.
plan_does_not_cover_company Your plan does not cover this company, so a bank cannot be connected to it. Move up a plan to connect one.
no_such_company No such company.
no_such_account No such account.
unsubscribe_link_does_not_work This unsubscribe link does not work. It may have been copied only in part.
link_was_address_no_longer This link was for an address that is no longer on a Zuger account. Signed in, you can choose under Settings → Notifications.
asked_yourself_zuger_ops_so You asked for this yourself in Zuger OPS, so another owner or admin of this company approves it.
passkey_could_not_verified That passkey could not be verified: {reason}
reasonassertion_missing_its_credential_id The assertion is missing its credential id.
passkey_not_any_account That passkey is not on any account.
passkey_could_not_sign_try That passkey could not sign you in. Try again, or use a code by email.
top_up_50_200_runs A top-up is 50 or 200 Runs.
free_plan_has_no_top_ups The Free plan has no top-ups: move up a plan instead.
top_up_card_could_not The top-up card could not be opened: Dom, who keeps billing cards, is not on shift. Put Dom back on shift under Agents and ask again. Nothing was charged.
stripe_not_configured_deployment Stripe is not configured on this deployment.
there_nothing_stripe_company_yet There is nothing at Stripe for this company yet: the portal opens after the first payment.
no_such_request No such request.
request_has_been_decided_already This request has been decided already, or has lapsed.
request_has_been_decided_already_2 This request has been decided already.
approve_deny Approve or deny.
request_lapsed_nobody_decided_within This request lapsed: nobody decided it within 72 hours.
approve_passkey Approve with your passkey.
passkey_not_account That passkey is not on this account.
zuger_can_already_read_something Zuger can already read something here. End that access first; one is open at a time.
there_no_open_grant_id There is no open grant by that id.
does_not_look_like_email That does not look like an email address.
contact_fields_not_right Some of that did not look right. Check the fields and try again.
contact_check_failed That check did not pass. Try again.
contact_try_again That did not go through. Try again in a minute.
link_has_run_out_ask This link has run out. Ask again on the status page, and a new one is sent.
link_not_valid This link is not valid.
choose_contract_review Choose the contract to review.
no_such_notice No such notice.
notice_stays_until_ends_cannot This notice stays until it ends: it cannot be dismissed.
say_on_or_off Say on or off.
only_passkey_account_has_no This is your only passkey and the account has no password. Set a password in Settings → Account first, or add another passkey, then remove this one.
no_such_approval No such approval.
only_something_approved_can_marked Only something you approved can be marked as done.
there_nothing_carry_out_here There is nothing for you to carry out here.
no_such_brief No such brief.
audit_ready_not_plan Audit-ready is not on this plan.
santis_has_days_history_sweep Säntis has {daysSoFar} of the {daysNeeded} days of history a sweep needs.
daysSoFardaysNeededno_worker_configured_run_sweep No worker is configured to run a sweep on this deployment.
no_such_finding No such finding.
not_set_up_deployment {channel} is not set up on this deployment.
channelno_such_link No such link.
only_owner_decides_what_may Only the owner decides what may leave Zuger into a chat.
choose_links_full Choose LINKS or FULL.
file_larger_than_10_mb That file is larger than 10 MB.
deletion_has_already_been_asked Deletion has already been asked for.
type_companys_name_confirm Type the company's name, {name}, to confirm.
nameno_deletion_waiting No deletion is waiting.
choose_what_asking_access_correction Choose what you are asking for: access, a correction, erasure, a copy to take elsewhere, an objection, or something else.
message_characters_most Your message is {n} characters; at most {max}.
nmaxasked_already_zuger_answers You asked for this already, on {date}. Zuger answers by {due}.
dateduehave_five_requests_waiting_already You have five requests waiting already. Zuger answers those first.
link_has_run_out_write That link has run out. Write to support@zuger.ai and we send a new one.
link_not_valid_2 That link is not valid.
link_was_used_already_request This link was used already: your request is confirmed.
request_answered_already This request is answered already.
download_link_has_run_out This download link has run out. Ask Zuger for a new one: write to support@zuger.ai.
download_link_not_valid This download link is not valid.
link_another_account_sign_person This link is for another account. Sign in as the person it was sent to.
link_was_used_already_works This link was used already: it works once. Ask Zuger for a new one if you need the file again.
newer_link_was_sent_since A newer link was sent since: use the latest email.
runs_one_company_runs_up {plan} runs one company. {needed} runs up to {entities} from one back office; four or more, talk to us.
planneededentitiesruns_companies_all_use {plan} runs {cap} companies, and all {cap2} are in use.
plancapcap2there_already_company_legal_name There is already a company with that legal name here.
company_has_tools_runs_approvals That company has tools, Runs or approvals behind it, so it is kept for the record. Rename it instead, or move its tools first.
no_such_connection No such connection.
view_across_companies_comes The view across companies comes with {needed}. You are on {plan}.
neededplanstripe_not_configured_deployment_so_payouts Stripe is not configured on this deployment, so payouts cannot be set up.
say_which_country_seller_two Say which country the seller is in, as a two-letter code such as EE or DE.
payouts_not_set_up_yet Payouts are not set up yet.
set_up_single_sign_first Set up single sign-on first.
nobody_has_signed_through_yet Nobody has signed in through it yet. Sign in with single sign-on once yourself, see that it works, then make it the only way in.
single_sign_comes Single sign-on comes with {needed}. You are on {plan}.
neededplanconfirm_own_email_address_first Confirm your own email address first (Settings, under Account). Single sign-on covers your mail domain, and that has to be shown to be yours.
single_sign_covers_companys_own Single sign-on covers a company's own mail domain. {domain} is a public mail service, so it cannot be claimed.
domainpaste_client_id_identity_provider Paste the client ID your identity provider gave you.
issuer_could_not_reached_check That issuer could not be reached. Check the address.
deployment_has_no_vault_configured This deployment has no vault configured, so a client secret cannot be stored. Use a public client with PKCE, or configure the vault.
client_secret_too_long That client secret is too long.
another_company_already_uses_single Another company already uses {domain} for single sign-on. A mail domain belongs to one company.
domainsingle_sign_not_set_up Single sign-on is not set up.
no_single_sign_set_up No single sign-on is set up for that address. Log in with your password or a passkey.
no_single_sign_required_address No single sign-on is required for that address.
sign_has_expired_was_already That sign-in has expired or was already used. Start again.
sign_did_not_start_browser That sign-in did not start in this browser. Start again from the door.
single_sign_no_longer_set Single sign-on is no longer set up for this company.
companys_single_sign_covers_outside This company's single sign-on covers {domain}. {email} is outside it.
domainemailnot_company_yet_ask_owner {email} is not in this company yet. Ask an owner or an admin to invite you, then sign in again.
emaildelegated_approvals_come Delegated approvals come with {needed}. You are on {plan}.
neededplancannot_change_own_role You cannot change your own role.
person_not_company That person is not in this company.
owners_role_not_changed_here An owner's role is not changed here.
cannot_remove_yourself You cannot remove yourself.
owner_cannot_removed An owner cannot be removed.
there_no_email_provider_configured There is no email provider configured on this deployment, so an invitation could not be delivered.
only_owner_admin_can_invite Only an owner or an admin can invite people.
only_owner_can_make_someone Only the owner can make someone an admin. Invite them as a member, and the owner can change their role.
person_already_company That person is already in this company.
address_already_has_zuger_account That address already has a Zuger account with another company. One account belongs to one company for now.
no_such_memory No such memory.
no_such_listing No such listing.
cannot_review_own_companys_listing You cannot review your own company's listing.
company_sells_so_review_would You are in the company that sells this, so your review would be of your own work.
reviews_come_companies_hired_hire Reviews come from companies that hired it. Hire it first, then say how it went.
have_not_reviewed You have not reviewed that.
no_such_review No such review.
own_review_can_change_remove That is your own review. You can change it or remove it.
say_why Say why: {list}.
listonly_zuger_can_hide_review Only Zuger can hide a review or put one back.
comments_come_companies_hired_seller Comments come from companies that hired it, and from the seller.
enough_comments_one_review That is enough comments on one review.
listings_hold_zuger_store_so Your listings are on hold in the Zuger Store, so nothing new can be published until Zuger lifts the hold. Write to support@zuger.ai to ask about it.
listings_priced_euro Listings are priced in euro.
agent_listed_zuger_only That agent is listed by Zuger only.
priced_listing_least_1_month A priced listing is at least €1 a month; 0 makes it free.
pack_holds_two_eight_listings A pack holds two to eight of your listings.
pack_can_only_hold_own A pack can only hold your own live agents and skills.
sell_price_set_up_payouts To sell at a price, set up payouts first (Settings, under Skills). A free listing needs nothing.
own_listing That is your own listing.
already_hired That is already hired.
there_no_payment_waiting_confirmed There is no payment waiting to be confirmed for that listing.
payment_has_not_been_confirmed The payment has not been confirmed, so nothing was hired and nothing was charged.
not_hired That is not hired.
came_paid_there_remove_pack That came with {pack}, and is paid for there. Remove the pack to let it go.
packstripe_not_configured_deployment_so_charge Stripe is not configured on this deployment, so the charge for this hire cannot be stopped from here.
part_pack_take_pack_down That is part of your pack {name}. Take the pack down first.
namenot_one_live_listings That is not one of your live listings.
companys_own_listing That is this company's own listing.
already_hired_already_waiting_decision That is already hired, or already waiting for a decision.
only_owner_admin_can_export Only an owner or an admin can export the audit log.
audit_log_export_comes Audit log export comes with {planA} and {planB}. You are on {plan}.
planAplanBplanagent_not_shift_put_shift_first That agent is not on shift. Put it on shift first, then give it a routine.
give_routine_name_2_80 Give the routine a name of 2 to 80 characters.
say_what_routine_should_do Say what the routine should do, in 4 to 2,000 characters.
company_keeps_up_25_routines A company keeps up to 25 routines. Remove one you no longer need first.
no_such_routine No such routine.
connections_not_configured_deployment_no Connections are not configured on this deployment. No token could be stored safely.
zuger_does_not_connect Zuger does not connect to {provider}.
provideradd_legal_entity_first_aggregator Add a legal entity first: the aggregator is chosen from its country.
no_open_banking_aggregator_covers No open-banking aggregator covers {country} yet.
countryzuger_does_not_use Zuger does not use {adapterId}.
adapterIdbank_link_was_not_started That bank link was not started by this company.
connections_not_configured_deployment Connections are not configured on this deployment.
connection_was_started_someone_else This connection was started by someone else, or for another company.
connection_attempt_expired_start_again This connection attempt expired. Start it again — it takes a moment.
linkedin_did_not_name_page LinkedIn did not name a Page you administer. Sign in as an administrator of the company’s Page, and try again.
x_did_not_say_which X did not say which account this is. Try again in a minute.
github_did_not_say_who GitHub did not say who connected. Install the Gotthard app on your repositories, and try again.
linear_did_not_name_workspace Linear did not name the workspace. Try again in a minute.
has_no_sync_connector_yet {provider} has no sync connector yet.
providerreconnect_first_sync_needs_live Reconnect it first; a sync needs a live grant.
no_worker_configured_sync_deployment No worker is configured to sync on this deployment.
only_owner_admin_can_disconnect Only the owner or an admin can disconnect a tool.
code_not_right_has_run That code is not right, or it has run out. Ask for a new one.
email_password_do_not_match That email and password do not match.
link_has_expired_ask_new That link has expired. Ask for a new one in Settings, under Account.
link_not_valid_ask_new That link is not valid. Ask for a new one in Settings, under Account.
link_was_different_address_ask That link was for a different address. Ask for a new one in Settings, under Account.
there_no_email_provider_configured_deployment There is no email provider configured on this deployment, so a confirmation could not be sent.
password_not_right That password is not right.
use_passkey_password Use your passkey or your password.
passkey_could_not_confirm_its That passkey could not confirm it’s you. Try again.
client_name_needed_name_person client_name is needed: the name the person will see when the app asks to connect.
redirect_uris_must_list_one redirect_uris must list one to ten addresses: https, http on this machine, or the app's own scheme.
connected_apps_public_clients_token Connected apps are public clients: token_endpoint_auth_method must be "none".
no_app_registered_under_client No app is registered under that client_id.
redirect_uri_not_one_app That redirect_uri is not one the app registered.
registration_too_long_shorten That registration is too long: shorten the addresses, or list fewer of them.
response_type_must_code response_type must be "code".
code_challenge_s256_needed_connected A code_challenge (S256) is needed: connected apps prove every sign-in with PKCE.
only_member_company_can_connect Only a member of the company can connect an app to it.
not_member_company Not a member of this company.
app_not_connected That app is not connected.
only_person_who_connected_app Only the person who connected an app, or an owner or admin, can disconnect it.
example_data_already_loaded_remove Example data is already loaded. Remove it first if you want a fresh month.
example_data_company_nothing_connected Example data is for a company with nothing connected yet: it would sit next to real figures. Disconnect the tools first, or try it in a second company.
file_empty The file is empty.
file_too_large_export_one That file is too large. Export one month at a time, or split it.
example_data_loaded_remove_under Example data is loaded. Remove it under Connectors first, then upload the real statement.
there_files_here_already_remove There are {n} files here already. Remove some you no longer need, then add this one.
nno_such_file No such file.
no_such_run No such run.
run_not_waiting_answer This Run is not waiting for an answer.
agent_not_shift_put_shift_first_then That agent is not on shift. Put it on shift first, then answer.
no_worker_configured_carry_work No worker is configured to carry the work on on this deployment.
question_has_already_been_answered This question has already been answered.
twenty_live_keys_limit_revoke Twenty live keys is the limit. Revoke one you no longer use.
deployment_has_no_vault_so This deployment has no vault, so a signing secret cannot be kept. Webhooks are off.
ten_webhook_addresses_limit_remove Ten webhook addresses is the limit. Remove one first.
no_such_webhook No such webhook.
webhook_switched_off_switch_first That webhook is switched off. Switch it on first.
no_worker_configured_deliver_webhooks No worker is configured to deliver webhooks on this deployment.
no_such_live_key No such live key.
company_requires_single_sign_so Your company requires single sign-on, so your address stays on its domain. Ask the owner if it needs to change.
address_already_has_account That address already has an account.
there_no_email_provider_configured_deployment_so There is no email provider configured on this deployment, so a recovery link could not be delivered.
invite_no_longer_valid_ask This invite is no longer valid. Ask for a new one.
not_invite That is not an invite.
stripe_not_configured_deployment_so_no Stripe is not configured on this deployment, so no payment can be taken. Nothing was charged and nothing was stored.
founder_plan_free_so_there The Founder plan is free, so there is nothing to pay for. Choose it as a downgrade instead.
not_sold_yearly {plan} is not sold yearly.
plannot_sold_monthly {plan} is not sold monthly.
planthere_no_subscription_row_attach There is no subscription row to attach a plan to.
plan_already_paid_being_confirmed A plan is already paid for and is being confirmed: it shows here within a few minutes. Nothing more was charged.
billing_needs_country_invoice_goes Billing needs the country the invoice goes to.
does_not_look_like_vat That does not look like a VAT number. Leave it out to be charged VAT, or check it.
vat_number_belongs_another_country That VAT number belongs to another country than the one the invoice goes to. Use the number registered there, or leave it out to be charged VAT.
stripe_not_configured_deployment_so_there Stripe is not configured on this deployment, so there is no card to change.
there_no_subscription_row_attach_payment There is no subscription row to attach a payment method to.
there_no_payment_method_being There is no payment method being added for this company.
choose_country_list Choose the country from the list.
card_form_not_companys That card form is not this company's.
stripe_has_not_confirmed_card Stripe has not confirmed that card. Nothing was saved; try again.
there_no_subscription_change There is no subscription to change.
already_on_plan You are already on {plan}.
planthere_no_paid_subscription_change There is no paid subscription to change yet.
change_would_billed_yearly_plan This change would be billed yearly, as your plan is. Choose the Yearly price to make it. Nothing was charged.
change_would_billed_monthly_plan This change would be billed monthly, as your plan is. Choose the Monthly price to make it. Nothing was charged.
stripe_not_configured_deployment_so_billing Stripe is not configured on this deployment, so billing cannot change.
there_no_paid_plan_keep There is no paid plan to keep. Choose a plan first.
nothing_scheduled_change_plan_renews Nothing is scheduled to change: your plan renews as it is.
there_no_paid_subscription_change_yet There is no paid subscription to change yet. Choose a plan first.
already_billed_yearly {plan} is already billed yearly.
planalready_billed_monthly {plan} is already billed monthly.
planalready_scheduled_end_period_keep {plan} is already scheduled from the end of this period. Keep your plan first (Billing → Keep), or switch to yearly once that change has applied.
planonly_owner_admin_can_decide Only the owner or an admin can decide an Unseal request.
only_owner_admin_can_end Only the owner or an admin can end an Unseal grant.
only_owner_admin_can_publish Only the owner or an admin can publish or take down a listing.
only_owner_admin_can_remove Only the owner or an admin can remove something hired from the Zuger Store.
only_owner_admin_can_load Only the owner or an admin can load example data.
only_owner_admin_can_remove_example Only the owner or an admin can remove example data.
only_owner_admin_can_upload Only the owner or an admin can upload a statement.
only_owner_admin_can_remove_uploaded Only the owner or an admin can remove uploaded statements.
only_owner_admin_can_make Only the owner or an admin can make or revoke an API key.
only_owner_admin_can_rename Only the owner or an admin can rename the company.
confirm_email_address_first_then Confirm your email address first, then set up payouts. The link is in Settings, under Account.
confirm_email_address_first_then_invite Confirm your email address first, then invite people. The link is in Settings, under Account.
confirm_email_address_first_then_post Confirm your email address first, then post your review. The link is in Settings, under Account.
confirm_email_address_first_then_report Confirm your email address first, then report a review. The link is in Settings, under Account.
confirm_email_address_first_then_comment Confirm your email address first, then comment. The link is in Settings, under Account.
confirm_email_address_first_then_publish Confirm your email address first, then publish in the Zuger Store. The link is in Settings, under Account.
confirm_email_address_first_then_make Confirm your email address first, then make a key. The link is in Settings, under Account.
confirm_email_address_first_then_add Confirm your email address first, then add a webhook. The link is in Settings, under Account.
no_such_chase No such chase.
chase_closed_invoice_paid_settled This chase is closed: the invoice is paid or settled.
not_one_six_promise_pay That is not one of the six: promise_to_pay, dispute, hardship, already_paid, stop_contact, other.
paste_reply_say_what_was Paste the reply, or say what it was.
replies_recorded_person_now Replies are recorded by a person for now.
date_paid_date_like_2026 The date paid by is a date, like 2026-10-20.
chase_not_paused This chase is not paused.
chase_changed_meanwhile_look_again This chase changed meanwhile. Look again.
interest_rate_percentage_year_0 The interest rate is a percentage a year, from 0 to 30.
legal_wording_can_firm_reminder Legal wording can be on for the firm reminder, the final notice, or both.
threshold_amount_owed_more_than The threshold is an amount owed, more than nothing.
threshold_needs_its_currency_like The threshold needs its currency, like CHF or EUR.
nothing_change Nothing to change.
only_owner_admin_can_change_what Only the owner or an admin can change what Kesch’s letters say.
matterhorn_not_switched_company_yet Matterhorn is not switched on for this company yet.
no_such_channel No such channel.
whole_number_1 A whole number from 1 to {max}.
maxon_or_off On or off.
no_such_post No such post.
being_published_right_now It is being published right now.
only_scheduled_post_can_withdrawn Only a scheduled post can be withdrawn.
changed_meanwhile_look_again It changed meanwhile. Look again.
connected_matterhorn_which_not_switched {provider} is connected for Matterhorn, which is not switched on for this company yet.
provideronly_owner_admin_can_change_social Only the owner or an admin can change a social channel.
only_owner_admin_can_change_brand Only the owner or an admin can change the brand voice.
only_owner_admin_can_withdraw Only the owner or an admin can withdraw a post someone else approved.
moleson_not_switched_company_yet Moléson is not switched on for this company yet.
only_these_can_go_alone Only these can go alone: faq, order_status, hours, shipping.
each_https_origin_like_https Each is an https origin, like https://www.example.com, with no path. Twenty at most.
colour_rrggbb A colour as #RRGGBB.
only_one_own_verified_domains Only one of your own verified domains (Settings → Sending).
not_switched_company_yet {channel} is not switched on for this company yet.
channelauto_mode_not_switched_company Auto mode is not switched on for this company yet.
no_such_notion_page_among No such Notion page among those shared with Zuger.
no_such_drive_file No such Drive file.
address_own_website_like_https An address on your own website, like https://www.example.com/help.
choose_websites_domain_first_one Choose your website’s domain first: one of your verified domains.
only_https_addresses_www Only https addresses on {domain} or www.{domain2}.
domaindomain2source_upload_notion_page_drive A source is an upload, a Notion page, a Drive file or a website address.
too_long That is too long.
no_such_source No such source.
no_such_conversation No such conversation.
no_such_customer No such customer.
write_reply Write the reply.
characters_4000_at_most 4,000 characters at most.
customer_asked_not_written_again This customer asked not to be written to again.
no_such_contact No such contact.
whatsapp_moleson_not_switched_company WhatsApp for Moléson is not switched on for this company yet.
connecting_companys_own_whatsapp_number Connecting a company’s own WhatsApp number is not set up on this deployment yet (Zuger must be a Meta Tech Provider).
no_whatsapp_number_connected No WhatsApp number is connected.
only_owner_admin_can_change_customer Only the owner or an admin can change customer support.
only_owner_admin_can_change_support Only the owner or an admin can change a support channel.
only_owner_admin_can_choose Only the owner or an admin can choose what Moléson answers from.
only_owner_admin_can_link Only the owner or an admin can link a customer to a contact.
only_owner_admin_can_connect Only the owner or an admin can connect the company’s WhatsApp number.
only_owner_admin_can_disconnect_companys Only the owner or an admin can disconnect the company’s WhatsApp number.
financial_year_ends_day_written The financial year ends on a day written MM-DD, such as 12-31.
yes_no_not_said_null Yes, no, or not said (null).
vat_period_monthly_quarterly_semi The VAT period is MONTHLY, QUARTERLY, SEMI_ANNUAL or ANNUAL.
payroll_yes_no Payroll is yes or no.
incorporation_date_date_like_2024 The incorporation date is a date, like 2024-06-15.
pilatus_not_switched_company_yet Pilatus is not switched on for this company yet.
no_such_obligation No such obligation.
already_marked_filed This is already marked as filed.
marked_not_applicable This is marked as not applicable.
obligation_changed_meanwhile_look_again This obligation changed meanwhile. Look again.
only_obligation_nothing_prepared_can Only an obligation with nothing prepared can be marked as not applicable.
only_owner_admin_can_mark Only the owner or an admin can mark a filing as done.
only_owner_admin_can_mark_obligation Only the owner or an admin can mark an obligation as not applicable.
legal_form_c_corp_llc The legal form is C_CORP or LLC.
state_us_de_delaware The state is US-DE (Delaware).
us_formation_not_switched_company_yet US formation with Pilatus is not switched on for this company yet.
recording_formation_not_available Recording a formation is not available here.
no_such_pack No such pack.
company_already_recorded_formed This company is already recorded as formed.
take_pack_first_then_record_formed Take the pack in your approvals first, then record the company as formed once Stripe Atlas says so.
formation_date_date_like_2026 The formation date is a date, like 2026-11-10.
formation_date_not_future The formation date cannot be in the future.
entity_type_c_corp_llc The entity type is C_CORP or LLC.
pack_changed_meanwhile_look_again This pack changed meanwhile. Look again.
choose_pdf_or_word Choose PDF or Word.
only_owner_admin_can_record_formed Only the owner or an admin can record a company as formed.
titlis_not_switched_company_yet Titlis is not switched on for this company yet.
playbook_changed_meanwhile_look_again The playbook changed meanwhile. Look again.
titlis_not_shift_hire_zuger Titlis is not on shift. Hire it from the Zuger Store first.
titlis_reviews_contract_uploaded_notion Titlis reviews a contract you uploaded. Notion and Drive sync titles only: upload the file itself.
no_such_contract_date No such contract date.
already_marked_done This is already marked as done.
date_changed_meanwhile_look_again This date changed meanwhile. Look again.
only_date_nobody_acted_can Only a date nobody acted on can be marked as not applicable.
only_owner_admin_can_change_playbook Only the owner or an admin can change the playbook.
only_owner_admin_can_mark_contract Only the owner or an admin can mark a contract date as done.
only_owner_admin_can_mark_contract_date Only the owner or an admin can mark a contract date as not applicable.
gotthard_not_switched_company_yet Gotthard is not switched on for this company yet.
opportunities_not_switched_on Opportunities are not switched on for this company yet.
only_owner_admin_change_opportunities Only the owner or an admin can change Opportunities.
choose_weekly_monthly_request_off Choose weekly, monthly, on request or off.
choose_one_level_idea Choose at least one level of idea.
dom_already_working_opportunities Dom is already working on an Opportunities brief. It will be here when it is done.
no_such_idea No such idea.
venture_plans_not_switched_on Venture plans are not switched on for this company yet.
venture_captable_limit A plan keeps ten funding scenarios at most. Delete one first.
venture_legal_kind Choose a founders’ agreement, an IP assignment, a mutual NDA or an advisor agreement.
venture_launch_month Choose a month from the last three years, not in the future.
venture_captable_founder Give at least one founder with shares.
venture_brand_drafting Matterhorn is still drafting names.
no_such_venture_draft No such draft.
no_such_venture_scenario No such scenario.
owner_admin_launch_plan Only the owner or an admin can mark a plan launched.
owner_admin_legal_draft Only the owner or an admin can prepare a draft for the founders’ lawyer.
venture_domains_recent The domains were looked up a moment ago.
venture_jobs_no_role The plan has no role to write a job post for. Add one to the team plan first.
venture_brand_no_names There are no names to look up yet.
venture_draft_not_ready This draft is not ready yet.
venture_jobs_drafting Zermatt is still drafting the job posts.
venture_founders_none Name at least one founder.
venture_founders_over The founders’ shares add up to more than 100%.
venture_founders_cliff A cliff cannot be longer than the vesting.
venture_team_month A role starts in a month of the plan.
venture_team_cost A role’s monthly cost is a figure from 0.
venture_demand_not_switched_on The demand check is not switched on for this company yet.
venture_landing_drafting The landing page is being drafted.
venture_landing_already_up This plan already has a landing page up. End it before drafting another.
venture_landing_waits_approval A landing page waits for your approval. Approve or reject it first.
venture_no_landing This plan has no landing page.
venture_landing_not_up This landing page is not up.
venture_survey_needs_landing A survey goes to a landing page’s waitlist: put one up first.
venture_waitlist_none_confirmed Nobody has confirmed their address on the waitlist yet.
venture_survey_pending A survey is being drafted or waits for your approval.
venture_no_landing_yet This plan has no landing page yet.
venture_demand_nothing_new Nothing new to take into the plan yet: answers about the price come from the waitlist’s form and the survey.
venture_ask_question Ask a question about the plan.
venture_ask_still_answering Dom is still answering your last question about this plan.
no_such_venture_question No such question.
venture_ask_no_change This answer changes no input, so there is nothing to save.
venture_ask_plan_changed The plan changed since this question was answered. Ask again on the newest version.
venture_grants_need_web Grant deadlines are looked up only for a plan made with web research. The starter list of official programmes is on the plan.
no_such_venture_deadline No such deadline waiting.
venture_already_company This plan is already a company here.
venture_company_name_needed Give the new company’s legal name.
venture_company_country_needed Choose the country the company is formed in.
owner_admin_landing_page Only the owner or an admin can put up a landing page.
owner_admin_end_landing Only the owner or an admin can end a landing page.
owner_admin_send_survey Only the owner or an admin can send a survey.
owner_admin_add_deadline Only the owner or an admin can add a deadline to the calendar.
owner_admin_company_from_plan Only the owner or an admin can make a company from a Venture plan.
venture_plans_need_pro Venture plans come with Pro, Max and Ultra. Move up a plan to make one.
no_such_venture_plan No such Venture plan.
venture_plan_changed_meanwhile The plan changed while you were editing it. Open it again to see the newest version.
venture_plan_still_drafting Dom is still writing this plan. It will be here when it is done.
venture_section_running Dom is rewriting a section of this plan. Try again when it is done.
venture_plan_held This plan waits for Bernina’s review. Release it in your approvals first.
venture_plan_no_version This plan has no version to change yet.
venture_plan_already_drafting Dom is already writing a Venture plan for this idea. It will be here when it is done.
no_such_venture_version No such version.
no_such_venture_section No such section.
say_what_to_change Say what to change.
venture_not_editable_here That is not a part of this section you can edit.
venture_write_something Write something, or regenerate the section.
venture_number_not_in_model A number in your words is not one of the plan’s figures. Change the model’s inputs, or name a figure the model has.
choose_one_draft Choose one of the drafts.
venture_input_not_number One of the inputs is not a number the model can take.
no_such_venture_assumption No such assumption with a test.
venture_assumption_testing This assumption is already being tested.
venture_idea_gone The idea this plan was made from is gone, so its tests cannot be followed.
venture_first_steps_running The first steps are already being prepared.
venture_rating_range A rating is from 1 to 5.
venture_export_format Choose PDF, Word, Excel, CSV, the one-page summary or the pitch outline.
venture_no_version_export This plan has no version to export yet.
no_such_venture_export No such export.
venture_sharing_off Sharing Venture plans is not switched on for this company.
venture_link_gone This link does not open a plan. It may have run out or been withdrawn.
only_owner_admin_delete_venture Only the owner or an admin can delete a Venture plan.
venture_version_number A version is a whole number from 1.
first_test_prepared_stays Its first test is being prepared; it stays as it is.
save_or_not_for_you Save it, or say it is not for you.
first_test_already_prepared Its first test is already being prepared.
choose_alert_mode Choose how alerts reach you: off, in the next brief, or a short brief now.
choose_revenue_kind Choose recurring, one-off or either.
margin_floor_whole_percent A margin floor is a whole percent from 0 to 95.
test_budget_amount_range A test budget is an amount from 0 to 1,000,000.
test_budget_needs_currency A test budget needs its currency.
eight_markets_at_most Eight markets or regions at most.
only_tested_idea_won_dropped Only an idea whose first test was prepared can be marked won or dropped.
tested_mark_won_or_dropped It was tested: mark it won or dropped.
say_whether_would_act Say whether you would act on it.
one_eight_languages One of the eight languages.
being_posted_right_now It is being posted right now.
only_approved_finding_waiting_posted Only an approved finding waiting to be posted can be withdrawn.
only_github_linear_have_gotthards Only GitHub and Linear have Gotthard’s permission.
connected_write_permission_gotthard_which {provider} is connected with write permission for Gotthard, which is not switched on for this company yet.
provideronly_owner_admin_can_change_engineering Only the owner or an admin can change an engineering channel.
only_owner_admin_can_withdraw_finding Only the owner or an admin can withdraw a finding someone else approved.
only_owner_admin_can_give Only the owner or an admin can give Gotthard permission to post.
zermatt_not_switched_company_yet Zermatt is not switched on for this company yet.
no_such_candidate No such candidate.
candidate_was_erased This candidate was erased.
file_not_one_uploaded_company That file is not one uploaded to this company. Upload it first.
give_role_title Give the role a title.
write_job_description_upload_so Write the job description, or upload it, so Zermatt assesses against what you wrote.
country_two_letters_like_ch A country is two letters, like CH, EE or AE.
employee_contractor An employee or a contractor.
interview_lasts_15_minutes_4 An interview lasts 15 minutes to 4 hours.
open_paused_closed Open, paused or closed.
no_such_role No such role.
choose_role_they_applied Choose the role they applied for.
their_name_they_gave Their name, as they gave it.
not_email_address That is not an email address.
country_two_letters A country is two letters.
not_time_zone_like_europe That is not a time zone, like Europe/Zurich.
write_note Write the note.
choose_stage Choose a stage.
choose_least_one_day Choose at least one day.
hours_like_09_00_17 Hours are like 09:00 and 17:00, the start before the end.
candidates_kept_days Candidates are kept {min} to {max} days.
minmaxno_such_interview No such interview.
invitation_was_already_sent_write This invitation was already sent. Write to the candidate yourself to change it.
invitation_no_longer_waiting This invitation is no longer waiting.
invitation_being_sent_now_was This invitation is being sent now, or was sent.
only_owner_admin_can_add Only the owner or an admin can add a role.
only_owner_admin_can_change_role Only the owner or an admin can change a role.
only_owner_admin_can_erase Only the owner or an admin can erase a candidate.
only_owner_admin_can_change_hiring Only the owner or an admin can change the hiring settings.
sending_own_domain_not_switched Sending from your own domain is not switched on for this company yet.
use_companys_own_domain_zugers Use your company’s own domain. Zuger’s is never a sending domain for another company.
reply_address_not_email_address The reply address is not an email address.
replies_go_company_never_zuger Replies go to your company, never to Zuger.
company_already_has_sending_domain This company already has a sending domain. Remove it first to use another.
set_up_sending_domain_first Set up a sending domain first.
resend_could_not_reached_try Resend could not be reached. Try again in a minute.
there_no_sending_domain_remove There is no sending domain to remove.
verify_domain_first_publish_records Verify the domain first: publish the records, then check again.
confirm_email_address_first_then_send Confirm your email address first, then send yourself a test. The link is in Settings, under Account.
one_test_every_ten_minutes One test every ten minutes. The last one is on its way.
companys_name_cannot_sent_rename The company’s name cannot be sent as it is. Rename the company in Settings, under Account.
resend_did_not_take_test Resend did not take the test. Check the domain’s status and try again.
sending_own_domain_not_switched_company Sending from your own domain is not switched on for this company yet. Reject it, or wait until it is.
candidate_no_longer_records_so That candidate is no longer in your records, so nothing can be sent to them.
contact_no_longer_records_so That contact is no longer in your records, so nothing can be sent to them.
message_cannot_sent This message cannot be sent.
country_two_letters_like_ch_ae A country is two letters, like CH or AE.
not_time_zone_like_europe_zurich That is not a time zone, like Europe/Zurich or Asia/Dubai.
ar_aging_not_switched_company AR aging is not switched on for this company yet.
only_owner_admin_can_set_up Only the owner or an admin can set up the sending domain.
only_owner_admin_can_check Only the owner or an admin can check the sending domain.
only_owner_admin_can_remove_sending Only the owner or an admin can remove the sending domain.
only_owner_admin_can_test Only the owner or an admin can test the sending domain.
not_hostname_write_pay_example That is not a hostname. Write it as pay.example.com.
use_subdomain_own_domain_such Use a subdomain of your own domain, such as pay.example.com, not the domain itself.
use_companys_own_domain_debtor Use your company’s own domain. A debtor portal is never on Zuger’s.
address_subdomain_points_not_own That is the address your subdomain points at, not your own subdomain.
host_zugers_own That host is Zuger’s own.
debtor_portal_not_switched_company The debtor portal is not switched on for this company yet.
custom_hostnames_not_set_up Custom hostnames are not set up on this deployment yet (Cloudflare for SaaS).
company_already_has_portal_subdomain This company already has a portal subdomain. Remove it first to use another.
hostname_already_use That hostname is already in use.
add_portals_subdomain_first Add your portal’s subdomain first.
there_no_portal_subdomain_remove There is no portal subdomain to remove.
colour_written_rrggbb_like_0a5c36 A colour is written as #RRGGBB, like #0a5c36.
logo_file_base64 The logo is the file as base64.
logo_most_256_kb A logo is at most 256 KB.
logo_png_jpeg_webp_picture A logo is a PNG, JPEG or WebP picture.
there_no_logo_remove There is no logo to remove.
only_owner_admin_can_set_up_debtor Only the owner or an admin can set up the debtor portal.
only_owner_admin_can_check_debtor Only the owner or an admin can check the debtor portal.
only_owner_admin_can_remove_debtor Only the owner or an admin can remove the debtor portal’s subdomain.
only_owner_admin_can_change_how Only the owner or an admin can change how the debtor portal looks.
limit_must_positive_whole_number "limit" must be a positive whole number.
tell_us_name_between_2 Tell us your name — between 2 and 80 characters.
keep_company_name_under_120 Keep the company name under 120 characters.
name_needs_between_2_120 A name needs to be between 2 and 120 characters.
sign_could_not_completed The sign-in could not be completed.
entityid_company_id_null "entityId" is a company id, or null.
role_admin_member "role" is ADMIN or MEMBER.
status_not_one_i_recognise "status" is not one I recognise.
verdict_must_confirmed_dismissed_corrected "verdict" must be confirmed, dismissed or corrected.
decision_must_approved_rejected "decision" must be APPROVED or REJECTED.
no_such_route No such route.
brief_between_1_2_000 A brief is between 1 and 2,000 characters.
kind_must_skill_agent_pack kind must be SKILL, AGENT or PACK.
name_must_2_80_characters name must be 2–80 characters.
blurb_must_10_400_characters blurb must be 10–400 characters.
listing_free_up_1_000 A listing is free or up to €1,000 a month. priceMinor is a whole number of cents.
agent_listing_names_agentkind_goes An agent listing names the agentKind it goes on shift as.
documents_list_document_ids "documents" is a list of document ids.
brief_can_carry_up_five A brief can carry up to five files.
paused_must_true_false "paused" must be true or false.
not_push_endpoint That is not a push endpoint.
name_key_between_2_60 Name the key — between 2 and 60 characters.
language_one_of A language is one of {list}.
listname_between_1_80_characters A name is between 1 and 80 characters.
text_could_not_read_just The text could not be read just now. Try again in a moment, or read it on zuger.ai.
there_no_such_page_ask There is no such page. Ask for terms, privacy or security.
plan_not_one_i_recognise "plan" is not one I recognise.
interval_month_year "interval" is month or year.
country_two_letter_code "country" is a two-letter code.
payowed_amount_owed_was_shown "payOwed" is the amount owed as it was shown.
setupintentid_id_stripe_gave_card "setupIntentId" is the id Stripe gave the card form.
card_details_never_sent_zuger Card details are never sent to Zuger. They go from Stripe's fields to Stripe.
endpoint_stripe This endpoint is for Stripe.
raw_body_was_not_preserved The raw body was not preserved; the signature cannot be verified.
no_route No route for {method} {path}.
methodpathno_api_key_can_call No API key can call this. It needs a person, signed in.
key_does_not_hold_scope This key does not hold the {scope} scope.
scopebody_must_json_object The body must be a JSON object.
field_required "{field}" is required.
fieldsession_not_attached_company_yet This session is not attached to a company yet. Finish signing up first.
too_many_requests_try_again Too many requests. Try again shortly.
address_has_malformed_escape The address has a malformed escape.
not_allowed_here {method} is not allowed here.
methodroutine_runs_every_day_every A routine runs every day, every week or every month.
schedule_has_no_next_time That schedule has no next time.
not_domain_write_example_com That is not a domain. Write it as example.com or mail.example.com.
address_before_may_use_letters The address before the @ may use letters, digits, dots and dashes, like billing or accounts.
company_has_no_name_send The company has no name to send in.
sender_company_itself_its_name The sender is the company itself: its name cannot say it is sent by or on behalf of someone else.
companys_message_sent_its_own A company's message is sent in its own name, never Zuger's.
zugers_own_domain_never_companys Zuger's own domain is never a company's sending domain.
playbook_list_positions The playbook is a list of positions.
not_playbook_position "{position}" is not a playbook position.
positionposition_there_twice The position "{id}" is there twice.
idon_is_yes_or_no On is yes or no.
position_flags_blocks A position flags or blocks.
where_rule_comes_one_line Where a rule comes from is one line of 160 characters at most.
countries_two_letter_codes_such Countries are two-letter codes, such as CH or DE.
whole_number A whole number from {min} to {max}.
minmaxmost_characters At most {n} characters.
none_english_german_french_spanish One of English, German, French, Spanish, Italian, Japanese, Chinese or Arabic.
formal_informal Formal or informal.
list_terms A list of terms.
list_words A list of words.
stripe_has_no_price_run Stripe has no price {lookupKey}. Run npm run stripe:seed against this account.
lookupKeyfree_plan_not_sold_has The Free plan is not sold: it has no price.
zuger_has_extended_paid_period Zuger has extended your paid period to {until}. A bigger plan or yearly billing can be chosen from then; until then, a top-up adds Runs. Nothing was charged.
untilissuer_plain_https_address_without The issuer is a plain https address, without a query.
identity_providers_configuration_could_not The identity provider's configuration could not be read ({status}). Check the issuer address.
statusidentity_provider_answered_different_issuer The identity provider answered for a different issuer than the one configured.
identity_provider_did_not_complete The identity provider did not complete the sign-in. Try again.
identity_providers_signing_keys_could The identity provider's signing keys could not be read.
identity_provider_sent_something_not The identity provider sent something that is not an ID token.
id_token_could_not_read The ID token could not be read.
id_token_signed_way_zuger The ID token is signed in a way Zuger does not accept.
id_token_was_signed_key The ID token was signed with a key the identity provider does not publish.
id_tokens_signature_does_not The ID token's signature does not verify.
id_token_was_issued_someone The ID token was issued by someone else.
id_token_was_issued_different The ID token was issued for a different application.
id_token_has_expired_try The ID token has expired. Try again.
id_token_dated_future The ID token is dated in the future.
id_token_does_not_belong The ID token does not belong to this sign-in attempt.
id_token_names_nobody The ID token names nobody.
identity_provider_does_not_say The identity provider does not say that address is verified.
telegram_companys_customers_its_own Telegram for a company’s customers (its own bot, or Telegram Business) is not built yet.
instagram_direct_messages_not_built Instagram direct messages are not built yet (they need Meta’s Instagram messaging permission for each company).
messenger_not_built_yet_needs Messenger is not built yet (it needs Meta’s pages_messaging permission for each company’s Page).
inbound_email_not_built_yet Inbound email is not built yet: zuger.ai has no MX record and no inbound route exists.
posting_github_linear_not_switched Posting to GitHub and Linear is not switched on for this company yet. Reject it, or wait until it is.
connection_was_prepared_no_longer The connection this was prepared for is no longer connected with Gotthard’s permission. Reconnect it in Settings, under Engineering tools, and ask Gotthard again.
connection_needs_reconnecting_settings_under This connection needs reconnecting in Settings, under Engineering tools, before anything can be posted.
switched_channel_off_settings_under You switched this channel off in Settings, under Engineering tools. Switch it back on first, or reject it.
publishing_x_linkedin_not_switched Publishing to X and LinkedIn is not switched on for this company yet. Reject it, or wait until it is.
account_post_was_written_no The account this post was written for is no longer connected. Reconnect it in Settings, under Social accounts, and ask Matterhorn again.
account_needs_reconnecting_settings_under This account needs reconnecting in Settings, under Social accounts, before anything can be published to it.
switched_channel_off_settings_under_social You switched this channel off in Settings, under Social accounts. Switch it back on first, or reject the post.
time_post_has_passed_reject The time to post has passed. Reject it and ask Matterhorn for a new time.
address_message_no_longer_contacts The address on this message is no longer the contact’s, so it cannot be sent.
contact_asked_never_contacted_again This contact asked never to be contacted again, so nothing is sent to them.
contact_marked_consumer_zuger_sends This contact is marked as a consumer. Zuger sends to businesses only.
verify_sending_domain_first_settings Verify your sending domain first, in Settings, under Sending domain.
message_offers_write_off_debt This message offers to write off the debt or issue a credit note. No agent may offer either.
candidate_no_longer_process_was This candidate is no longer in the process, or was erased, so nothing is sent to them.
message_reads_like_marketing_nothing This message reads like marketing. Nothing like it is sent to a candidate.
message_decides_about_candidate_offer This message decides about the candidate (an offer, a salary, a rejection). Say that yourself; no agent does.
sending_customers_not_switched_company Sending to customers is not switched on for this company yet. Reject it, or wait until it is.
channel_switched_off_settings_under This channel is switched off in Settings, under Customer support. Switch it back on first, or reject it.
too_many_wrong_attempts_sign Too many wrong attempts: sign-in with a password or a code is paused for this account for 15 minutes. A passkey still works, and so does a recovery link by email.
someone_company_also_company_sells Someone in your company is also in the company that sells this, so it cannot be hired from here. The Zuger Store is between companies that are not each other.
account_suspended_write_support_zuger This account is suspended. Write to support@zuger.ai.
pack_puts_one_more_agent This pack puts {extra} more agent on shift, and {plan} runs {cap} at once. Move up a plan, or let one go first.
extraplancappack_puts_more_agents This pack puts {extra} more agents on shift, and {plan} runs {cap} at once. Move up a plan, or let one go first.
extraplancappack_puts_one_more_agent_raised This pack puts {extra} more agent on shift, and {plan}, as Zuger raised it until {until}, runs {cap} at once. Move up a plan, or let one go first.
extraplanuntilcappack_puts_more_agents_raised This pack puts {extra} more agents on shift, and {plan}, as Zuger raised it until {until}, runs {cap} at once. Move up a plan, or let one go first.
extraplanuntilcapplan_runs_one_agent_on_shift {plan} runs {cap} agent at once, and it is on shift. Move up a plan, or let one go first.
plancapplan_runs_agents_on_shift {plan} runs {cap} agents at once, and they are on shift. Move up a plan, or let one go first.
plancapplan_runs_one_agent_on_shift_raised {plan}, as Zuger raised it until {until}, runs {cap} agent at once, and it is on shift. Move up a plan, or let one go first.
planuntilcapplan_runs_agents_on_shift_raised {plan}, as Zuger raised it until {until}, runs {cap} agents at once, and they are on shift. Move up a plan, or let one go first.
planuntilcappriced_listing_cannot_charged_yet A priced listing cannot be charged yet. {blockers} Nothing was charged.
blockersblockerscategory_decided_by_owner {category} approvals are decided by the owner in this company. You can read it; someone with that role decides.
categorycategorycategory_decided_by_owner_or_admin {category} approvals are decided by an owner or an admin in this company. You can read it; someone with that role decides.
categorycategorycategory_decided_by_anyone {category} approvals are decided by anyone in the company in this company. You can read it; someone with that role decides.
categorycategorypasskey_signature_did_not_check That passkey signature did not check out.
passkey_signature_did_not_check_because That passkey signature did not check out: {failure}
failurefailurenot_found Not found.
sign_in_first Sign in first.
not_on_api_address Not on this address: it answers what an API key can call, listed at /v1/openapi.json.
api_address_needs_key On this address every request is signed with an API key (Authorization: Bearer zk_live_…). Make one in the Console, under Developers.
something_went_wrong Something went wrong on our side.
restarting_try_again_shortly Restarting. Try again shortly.
request_over_time This is taking longer than it should, and it may still finish. Check before you do it again.
stripe_event_still_applying This Stripe event is still being applied. Stripe sends it again, and the repeat is acknowledged once it is done.
request_came_another_site That request came from another site.
only_owner_can_change_currency Only the owner of this company can change the currency it is billed in.
other_currency_not_open_yet Billing in another currency is not open for this company yet. Everything is in EUR.
zuger_bills_in_currencies Zuger bills in {currencies}.
currenciesbilled_in_currency_since_first_payment Your company is billed in {billed} since its first payment, and stays in it: Stripe bills a customer in one currency. Nothing was changed.
billedbilling_currency_changed_since_card Your billing currency changed since this card opened, and so did the price of a top-up. Ask for a new one from Billing. Nothing was charged.
currency_code_or_null "currency" is a three-letter code, or null to follow the billing country.
no_price_in_currency_yet There is no {billed} price for {key} yet. Nothing was charged.
billedkeykya_agent_never_registers_itself An agent never registers itself. Register it signed in, or with your developer company's own API key.
kya_not_developer_company Outside agents are registered by a developer company, and this company is not one.
kya_registration_not_set_up Registering outside agents is not set up on this deployment yet.
kya_key_holds_private_part That key holds its private part. Send the public key only: the private key stays with you.
kya_key_not_ed25519_jwk The public key must be an Ed25519 key as a JWK (kty OKP, crv Ed25519).
kya_key_belongs_another_agent That key belongs to another agent. Give each agent its own key.
kya_agent_name_length Give the agent a name, 2 to 80 characters.
kya_agent_description_length Describe the agent in 1,000 characters or fewer.
kya_agent_does_length Say what the agent does, in 2,000 characters or fewer.
kya_agent_scopes List the scopes the agent declares: one to twenty of Zuger's scopes, never an execute scope.
kya_model_provider_length The model and the provider are yours to name or leave out; each is at most 80 characters.
kya_homepage_on_domain The homepage must be an https address on the agent's proven domain.
kya_not_domain_name That is not a domain name.
kya_zuger_domains_not_provable Zuger's own domains cannot be proven.
kya_choose_proof_method Choose how to prove the domain: dns, well_known or email.
kya_mail_provider_cannot_prove Addresses from that email provider cannot prove a domain.
kya_email_not_at_domain Your confirmed email address is not at that domain.
kya_domains_at_limit This developer company already has {max} domains, the most it may.
maxkya_no_such_domain No such domain.
kya_no_such_agent No such agent.
kya_domain_not_proven That domain is not one this developer company has proven. Prove it first.
kya_agents_at_limit This developer company has registered {max} agents, the most it may. Remove one first.
maxkya_too_many_agents_hour Too many agents registered in the last hour. Try again later.
kya_too_many_agents_day Too many agents registered today. Try again tomorrow.
kya_agent_removed That agent was removed.
kya_key_already_agents That key is the agent's key already.
kya_too_many_key_changes Too many key changes today. Try again tomorrow.
kya_stop_request_gone This stop request is no longer waiting: it lapsed, was withdrawn or was signed already.
kya_stop_not_holding There is no stop by that id that is still holding agents.
kya_stop_person_only An emergency stop is made by a person, signed in, with a passkey. A key or a connected app cannot make one.
kya_stop_owner_or_admin Only the owner or an admin can make an emergency stop or restart one.
kya_stop_choose_scope Choose what to stop: agent, operator (every agent) or skill.
kya_stop_unknown_skill Name a skill Zuger knows, such as publish:social.
kya_stop_name_agent Name the agent to stop.
kya_stop_needs_passkey Confirm the emergency stop with your passkey.
kya_stop_fleet_waiting A stop of the whole fleet is already waiting for a second passkey.
kya_stop_second_someone_else A second passkey must be someone else’s.
kya_stop_withdraw_asker_only Only the person who asked can withdraw this stop request.
kya_stop_setting_owner_only Only the owner can change who signs a stop of the whole fleet.
kya_stop_true_or_false Say true or false.
kya_stop_nobody_second Nobody else in the company could give a second passkey yet. Invite an admin who has a passkey first.
kya_deals_live_gate Deals run in Stripe test mode only until live mode is approved. Nothing was charged.
kya_deals_no_stripe Stripe is not configured on this deployment, so no deal can be authorised. Nothing was charged.
kya_deal_not_found There is no deal by that id here.
kya_deal_seller_not_ready That seller cannot be paid through Stripe yet, so no deal can be made with it. Nothing was charged.
kya_deal_seller_region That seller's Stripe account is in a country deals cannot reach yet (the US, Canada, the UK, the EEA and Switzerland only). Nothing was charged.
kya_deal_seller_agent That agent is not a registered agent that can take a deal now.
kya_deal_self Someone in your company is also in the seller's company, so this deal cannot be made. Deals are between companies that are not each other.
kya_deal_price The price is outside the limits for a deal.
kya_deal_currency Deals are in EUR for now.
kya_deal_hours The hours are outside the limits for a deal.
kya_deal_hash Give the job's hash as 16 to 128 base64url characters.
kya_deal_session The handshake session id is 43 base64url characters.
kya_deal_not_open This deal is not waiting for that any more.
kya_deal_not_delivered Receipt is confirmed once the seller has delivered.
kya_deal_after_receipt Receipt was confirmed and the payment taken. Ask Zuger for a refund instead.
kya_deal_too_late The time for that has passed. The authorisation was let go of and nothing was taken.
kya_deal_person_only A deal is accepted, confirmed or disputed by a person, signed in, with a passkey. A key, a connected app or an agent cannot.
kya_deal_buyer Only a company with a Zuger plan can make a deal.
kya_deal_agent That agent cannot prepare a deal now.
kya_deal_frozen That agent is frozen, so it cannot take part in a deal.
kya_deal_vat_undecided The VAT on this deal cannot be decided, so it cannot be authorised: your company's billing country is not on file, or its VAT is not known. Add the billing country in Settings, under Billing. Nothing was charged.
kya_deal_vat_changed The VAT on this deal is not what you were shown when it was offered, so it was not authorised. Nothing was charged. Ask your agent to offer it again.
kya_deal_needs_passkey Confirm it with your passkey.
kya_sale_no_app A connected app cannot act for a seller. Use your developer company's own API key, or sign in.
kya_sale_owner_or_admin Only the owner or an admin can act for the seller.
link_spend_off Agent purchases through Link are not on for this company.
link_spend_country Agent purchases through Link are available for US and Canada customers only.
link_spend_credential_deferred Zuger buys with Link shared payment tokens only. Virtual cards and Link Pay Tokens are not offered: no card number ever enters Zuger.
link_spend_credential_unknown That is not a Link credential type.
link_spend_purpose That agent cannot prepare this kind of purchase.
link_spend_agent That agent cannot prepare purchases now.
link_spend_seller The purchase does not say who sells it.
link_spend_seller_url The seller's address is not a public https address Zuger can pay through Link.
link_spend_item The purchase does not say what is bought, or its items and totals do not add up to the amount.
link_spend_amount The amount is not a whole positive number of minor units.
link_spend_currency The currency is not a three-letter code, or is not the one the seller asks for.
link_spend_reason The purchase does not say why, or says it in more than 2,000 characters.
link_spend_artefacts A purchase cites at least two of the company's own records, and at most twenty.
link_spend_artefact_missing A record the purchase cites is not one of this company's.
link_spend_challenge The seller's payment request could not be read, or does not take Link (Stripe) payments. Nothing was prepared.
link_spend_card_number A card number is never accepted. Nothing was prepared.
link_spend_not_found There is no agent purchase by that id here.
link_spend_not_cancelable This purchase can no longer be canceled here: it was paid, or has ended.
link_spend_no_executor Zuger cannot carry out Link purchases on this deployment yet. Nothing was sent to Link.
link_spend_person_only Agent purchases are set up and decided by a person, signed in. A key, a connected app or an agent cannot.
link_spend_owner_admin Only the owner or an admin can change agent purchases.
link_spend_owner_raises Only the owner can turn agent purchases on or raise a threshold. An admin can turn them off or lower one.
link_spend_connect_link_first Connect Link in Connectors first.
link_spend_turn_on_first Turn agent purchases on first.
link_spend_attempt_expired This Link connection attempt expired. Start it again from Agent purchases.
link_spend_thresholds A threshold is a whole number of minor units from zero up, per three-letter currency.
link_spend_scope_declined Link did not allow agent payments. Connect again and allow payments if you want your agents to buy.
money_console_person_only Agent money is read by a person of the company, signed in. A key, a connected app or an agent cannot.
money_export_owner_admin Only the owner or an admin can export the agent money record.
money_export_window Choose whole days, from and to (YYYY-MM-DD), at most 366 days apart.
money_export_too_many That period holds more steps than one export can. Choose a shorter one.
money_record_not_found There is no agent money record by that id here.
seller_mpp_kind An order is a Run top-up (50 or 200 Runs) or a Zuger Store listing.
seller_mpp_pack A top-up order is 50 or 200 Runs.
seller_mpp_free_plan The Free plan has no top-ups, so there is nothing to order: move up a plan instead.
seller_mpp_listing That listing cannot be had over an agent payment.
seller_mpp_outside_seller Only listings by Zuger can be had over an agent payment for now.
seller_mpp_hired That is hired already, so it cannot be ordered.
seller_mpp_vat_unknown The billing country is not on record, so the VAT cannot be decided. Add it under Billing first.
seller_mpp_no_customer This company has nothing at Stripe yet. Add a payment method under Billing first.
seller_mpp_minimum This is below the smallest amount an agent payment can be.
seller_mpp_not_ready Zuger cannot take agent payments yet.
seller_mpp_no_order There is no order by that id here.
seller_mpp_open_orders This company has too many orders waiting to be paid. Let one lapse or pay it first.
seller_mpp_person_only Agent payments to Zuger are ordered by a person, signed in. A key, a connected app or an agent cannot.
seller_mpp_owner_only Only the owner of this company can order what Zuger sells (it is a billing change).
money_not_found There is no money draft by that id here.
money_draft_shape A money draft needs its kind, amount, currency, recipient, reason and at least two cited records.
money_draft_kind That kind of money action is not one an agent can prepare.
money_draft_amount The amount is not a whole positive number of minor units (zero only for adding a payee).
money_draft_currency The currency is not a three-letter code, or a conversion names the same currency twice.
money_draft_counterparty The draft does not say who is paid.
money_draft_recipient The recipient's details are missing or not in a form Zuger accepts. Card numbers are never accepted.
money_draft_memo The memo is longer than 500 characters.
money_draft_reason The draft does not say why, or says it in more than 2,000 characters.
money_draft_artefacts A money draft cites at least two of the company's own records, and at most twenty.
money_draft_artefact_missing A record the draft cites is not one of this company's.
money_draft_agent That agent cannot prepare money drafts now.
money_no_limits Set your agent money limits for this currency first, in Agent money limits. Nothing was prepared.
money_over_limit This is more than your agent money limits allow. Nothing was prepared or moved.
money_limit_shape A limit is a whole number of minor units, from zero up, and the 30-day limit is at least the daily one.
money_limit_agent That agent is not one of this company's.
money_limit_owner Only the owner can raise the agent money limits, and an admin can lower them.
money_limit_lower_only An admin can only lower the agent money limits or close a currency. Only the owner can raise one or add one.
money_person_only Agent money limits are set by a person, signed in, with a passkey. A key, a connected app or an agent cannot.
money_draft_route The draft does not say where the money leaves from and goes to in Stripe, or names something that is not a Stripe id.
money_draft_rate A conversion needs the rate it was prepared at and when, and that rate is too old now. Nothing was prepared.
money_invoice_not_payable A payment is prepared only from an approved invoice the company owes, in its currency and for no more than is due.
money_key_sealed Paste the key in the Console: it is sealed in your browser before it leaves, and Zuger’s servers never read it.
money_key_owner Only the owner adds or replaces the Stripe key your approved agent payments are carried out with. An admin can remove it.
money_key_none There is no Stripe key for agent money here.
kya_invoice_not_found There is no invoice by that id here.
kya_invoice_chain_unverified That chain does not check out, so no invoice can be drafted from it.
kya_invoice_chain_open That chain is not closed yet: no person has approved its Receipt. An invoice is drafted from a closed chain.
kya_invoice_no_receipts That chain has no Receipt where money was taken, so there is nothing to invoice.
kya_invoice_exists This chain already has an invoice. Discard it first to draft another.
kya_invoice_number Give the invoice number from your own ledger: 1 to 40 letters, digits, dots, dashes or slashes, starting with a letter or a digit.
kya_invoice_date Give the issue date as YYYY-MM-DD, no later than today.
kya_invoice_due_days Give the days to pay as a whole number from 0 to 120.
kya_invoice_buyer Give the buyer's name (2 to 200 characters) and country (a two-letter code).
kya_invoice_buyer_address Each part of the buyer's address and reference is at most 200 characters.
kya_invoice_vat_category Choose the VAT category your ledger uses: S, Z, E, AE or O.
kya_invoice_vat_rate A standard rate is a percentage above 0 and at most 30, as your ledger has it.
kya_invoice_vat_exempt An exempt invoice names its reason: a VATEX code, or a sentence of at most 200 characters.
kya_invoice_seller_details Your company's legal name and country are not on file yet. Add them in Settings, under Billing, first.
kya_invoice_seller_id An invoice not subject to VAT names your company's registration number. Add your business tax ID in Settings, under Billing, first.
kya_invoice_seller_vat This VAT category needs your company's VAT number, checked with VIES. Add it in Settings, under Billing, first.
kya_invoice_buyer_vat A reverse charge needs the buyer's VAT number, and VIES must confirm it is valid today.
kya_invoice_reverse_charge_scope A reverse charge is for a business buyer in another EU country than yours.
kya_invoice_self_billing_off Self-billing is not offered: it needs a signed self-billing agreement first.
kya_invoice_lang Choose the invoice's language: en, de, fr, es, it, ja, zh or ar.
kya_invoice_invalid The draft did not pass the EN 16931 checks, so it was not kept.
kya_invoice_not_draft This invoice is not a draft any more.
kya_invoice_person_only An invoice is approved or discarded by a person, signed in, with a passkey. A key, a connected app or an agent cannot.
kya_invoice_owner_or_admin Only the owner or an admin can approve or discard an invoice.
kya_invoice_daily_cap Your company has drafted as many invoices as it can today. Try again tomorrow.
kya_invoice_format Choose the file: xml, pdf or json.
kya_invoice_read_person_only Invoices are read by the company's own people, signed in. A key or a connected app cannot read them.
kya_invoice_chain_root Give the chain's root: 43 base64url characters.
kya_chain_person_only The chain is read by the company's own people, signed in. A key or a connected app cannot read it.
kya_chain_not_found There is no chain by that root in this company.
kya_chain_owner_or_admin Only the owner or an admin can disclose a chain's content.
kya_chain_choose_links Choose from 1 to 100 links of this chain to disclose.
kya_chain_link_not_in_chain Every link to disclose must be one of this chain's.
kya_chain_expiry Choose how long the auditor link lasts: from 1 to 720 hours.
kya_chain_needs_passkey Confirm the disclosure with your passkey.
kesch_calls_owner_or_admin Only the owner or an admin can change Kesch’s calls.
kesch_call_not_found No such call.
kesch_call_no_recording This call has no recording.
kesch_calls_verify_number_first Verify your company’s own number first: every call is made from it.
kesch_calls_hours Calling hours are a start and an end, like 09:00 and 18:00, the start first.
kesch_calls_one_language Choose at least one of the eight languages Kesch speaks.
kesch_calls_company_number Give your company’s number with its country code, like +41 44 123 45 67.
kesch_calls_not_set_up Calls are not set up on this deployment yet, so a number cannot be verified.
kesch_calls_add_number_first Add your company’s number first.
kesch_call_retry_reached Only a call that did not reach anyone can be made again.
kesch_call_retry_waiting Kesch is already proposing this call again.
kesch_calls_debtor_number Give the number with its country code, like +41 44 123 45 67.
kesch_calls_line_kind The line is a mobile, a landline, a work number, or not known.
kesch_calls_consent_date The consent’s date is a date in the past, like 2026-03-01.
kesch_calls_batch_decided This list of calls was already decided, or it lapsed.
kesch_calls_switched_off Kesch’s calls are switched off for this company, so nobody can be called.
kya_chain_own_session Only the company's own people, signed in, can disclose: Zuger cannot open the content.
kya_chain_sealed That link's content cannot be opened from here.
kya_chain_no_key Evidence packs cannot be signed yet.
kya_chain_disclosure_gone There is no disclosure for that link, or it has expired.
kya_evidence_person_only Evidence reports are asked for by the company's own people, signed in. A key or a connected app cannot ask for one.
money_treasury_read_owner_admin Only the owner or an admin can turn Stripe Treasury read on or off.
money_say_on_or_off Say on: true or on: false.
money_not_in_country Stripe Treasury read is not available for your Stripe account's country yet.
money_connect_stripe_first Connect Stripe first: Treasury read uses your Stripe connection.
money_reconnect_stripe_first Reconnect Stripe first: its connection needs reconnecting.
money_read_only_grant_only Zuger reads Treasury only over Stripe's read-only grant, and this Stripe connection holds another. Reconnect Stripe with read-only access.
kya_evidence_owner_or_admin Only the owner or an admin can ask for or download an evidence report.
kya_evidence_template Choose a template: internal audit, customer audit or AI governance review.
kya_evidence_period Choose a period of whole days, from its first day to its last.
kya_evidence_period_future A report covers days that have begun: end the period today at the latest.
kya_evidence_period_long A report covers at most {days} days. Choose a shorter period.
dayskya_evidence_agents Choose up to {n} of this company's agents, or none for every agent.
nkya_evidence_roots Choose up to {n} of this company's chains by their root, or none for every chain.
nkya_evidence_no_key Evidence reports cannot be signed yet.
kya_evidence_per_day This company has asked for {n} reports in the last day. Download one of those, or ask again tomorrow.
nkya_evidence_busy A report for this company is still being made. Wait for it, then ask for the next.
kya_evidence_not_found No such evidence report in this company.
kya_evidence_building This report is still being made.
kya_evidence_failed This report could not be made. Ask for it again.
kya_evidence_expired This report's files are gone: they are kept {days} days. Its record and hash stay. Ask for a new one.
dayskya_analytics_person_only Network trends are read by the company's own people, signed in. A key or a connected app cannot read them.
kya_analytics_owner_or_admin Only the owner or an admin can read network trends or change sharing.
kya_analytics_month Choose a month as YYYY-MM, one of the last {n} months.
nkya_room_person_only Data rooms are run by the company's own people, signed in. A key or a connected app cannot run one.
kya_room_owner_or_admin Only the owner or an admin can make a data room, share it or read its access log.
kya_room_not_found No such data room in this company.
kya_room_closed This data room is closed.
kya_room_title Give the room a name of 1 to 120 characters.
kya_room_documents_max A data room holds at most {n} documents.
nkya_room_documents_own Choose documents of this company for the room.
kya_room_document_unread Zuger has not read one of those documents yet, so its text cannot go into a data room. Try again once it has been read.
kya_room_rooms_max This company has {n} open data rooms. Close one before making another.
nkya_room_people_inside People still have access to this data room. Revoke their access before closing it.
kya_room_empty Put at least one document in the room first.
kya_room_grant_name Write the name of the person you are sharing the room with.
kya_room_grant_email Write the email address of the person you are sharing the room with. They open it signed in to Zuger with that address.
kya_room_grant_documents Choose up to {n} of this room's documents to share, or none for all of them.
nkya_room_grant_hours Choose how long the access lasts: from {min} to {max} hours.
minmaxkya_room_grant_export Say whether exports are allowed: yes or no.
kya_room_live_grants {n} people have access to this room. Revoke someone's access before sharing it with another person.
nkya_room_no_chain_key Data rooms cannot record access in the Agent Chain yet, so nothing can be shared.
kya_room_own_session Only the company's own people, signed in, can share a data room: Zuger cannot open the documents.
kya_room_too_large Those documents hold too much text for one share. Choose fewer.
kya_room_grant_not_found No such access to this data room.
kya_room_already_revoked This access has already been revoked.
kya_room_passkey_revoke Confirm the revocation with your passkey.
kya_room_reader_person A data room is read by the person it was shared with, signed in. A key or a connected app cannot read one.
kya_room_gone There is no data room for that link, it is not shared with the account you are signed in with, or the access has ended.
kya_room_unconfirmed Confirm your email address first, then open the data room again. The link is in Settings, under Account.
kya_room_document That document is not in this data room.
kya_room_document_removed That document is no longer in this data room.
kya_room_page That page is not in this document.
kya_room_no_export Exports are not allowed for this access.
kya_room_reads_per_hour This access has been read {n} times in the last hour. Wait a little, then read on.
nkya_room_exports_per_day This access has made {n} exports in the last day. Try again tomorrow.
nkya_room_email_link Say whether Zuger emails them the link: yes or no.
kya_room_copy_of The access you are copying is not one of this room's.
kya_proof_not_found There is no proof by that link.
kya_proof_person_only Proofs on files are read by the company's own people, signed in. A key or a connected app cannot read them.
kya_net_agent_never_lists_itself An agent never lists itself. List it signed in, or with your developer company's own API key.
kya_net_search_length Search for {min} to {max} characters.
minmaxkya_net_unknown_skill That skill is not in Zuger's list of skills.
kya_net_bad_region A region is a two-letter country code, EU or GLOBAL.
kya_net_bad_language A language is a two- or three-letter code, such as en or de.
kya_net_bad_min_rep The least reputation is a whole number from 0 to 1000.
kya_net_bad_tier The tier is zuger, verified or registered.
kya_net_page_size A page holds 1 to {max} agents.
maxkya_net_most_results One search shows at most {max} agents. Narrow it with a skill, a region or a language.
maxkya_net_card_too_large The agent card is larger than {max} bytes.
maxkya_net_card_bad_url Every address in the agent card is https, with no user name, password or fragment ({member}).
memberkya_net_card_no_extension The agent card needs Zuger's KYA extension with the agent's DID, its languages and its regions ({member}).
memberkya_net_card_wrong_did The agent card names another DID. Its KYA extension names this agent's DID.
kya_net_card_off_domain Every address in the agent card is on the agent's proven domain ({member}).
memberkya_net_card_skill_untagged Tag each skill with at least one skill from Zuger's list ({member}).
memberkya_net_card_unsigned The agent card is not signed by the agent's current key. Sign it with the key registered for this agent, kid {kid}.
kidkya_net_card_email The agent card holds an email address. A card is public: take every address out of it.
kya_net_card_id The agent card holds one of Zuger's ids for your company, an agent, a key or a person. A card is public: take it out.
kya_net_card_not_a2a The agent card is not an A2A 1.0 card: {member} is missing, unknown or not as A2A defines it.
memberkya_net_not_listed_did No agent by that DID is listed.
kya_net_report_did Name the agent you are reporting by its DID.
kya_net_report_reason Choose why you are reporting it: illegal, impersonation, fraud, malware, privacy or other.
kya_net_report_explanation Say what is wrong, in {max} characters or fewer.
maxkya_net_report_good_faith Confirm that you make this report in good faith and that it is accurate.
kya_net_agent_not_listable Only an active agent on a proven domain can be listed.
kya_net_send_card Send the agent card as a JSON object in card.
kya_net_agent_not_listed This agent is not listed.
only_owner_admin_can_list_outside Only the owner or an admin can list outside agents.
confirm_email_list_outside_agent Confirm your email address first, then list an outside agent. The link is in Settings, under Account.
only_owner_admin_can_register_outside Only the owner or an admin can register outside agents.
confirm_email_register_outside_agent Confirm your email address first, then register an outside agent. The link is in Settings, under Account.
developer_company_no_work This is a developer company: it registers outside agents, and has no plan, Runs or Zuger agents of its own.
kya_two_passkeys_verified Add a second passkey to your account first: a Verified agent's keys are delegated by an owner with two.
kya_second_passkey_needed This request needs two different passkeys: approve with a second one.
kya_no_such_key_request No such key request.
kya_key_request_decided This key request has been decided already, or has lapsed.
kya_no_such_delegated_key No such delegated key.
kya_delegated_key_not_live That delegated key has been renewed or revoked already.
kya_delegated_key_in_use That key is already in use. Make a new key for each delegation.
kya_agent_frozen That agent is frozen. No key is delegated to it until Zuger has looked into it.
kya_agent_not_active That agent is not active, so no key can be delegated to it.
kya_delegation_scopes Ask only for scopes the agent declared when it was registered.
kya_delegation_replaces A key replaced by rotation must be a live key of the same agent.
kya_key_requests_day Too many key requests for this agent today. Try again tomorrow.
kya_key_requests_waiting This agent has too many key requests waiting. Wait for an owner to decide them.
kya_key_request_unusual This request is unusual for this agent (a new country and a burst of requests), so it was refused. Ask again later from where the agent usually runs.
kya_key_renew_new_delegation This key cannot be renewed: ask for a new delegation.
approve_decline Approve or decline.
kya_standing_window_verified A standing window is for a Verified agent only. A Registered agent's key renews by itself.
kya_standing_window_days Choose a standing window of 1 to 7 days.
kya_agent_never_approves_key An agent never approves its own key. An owner approves it in the Console with a passkey.
kya_store_person_only A listing is Verified by a person, signed in. A key or a connected app cannot apply for it.
kya_store_agent_listings_only Only an agent listing of your own can be Verified.
kya_store_seller_held Your listings are on hold in the Zuger Store, so a listing cannot be Verified until Zuger lifts the hold. Nothing was charged.
kya_store_kyb_required Verified needs Stripe's check of your business first. Set up payouts in Settings, under Skills, and finish Stripe's steps. Nothing was charged.
kya_store_scan_blocked_listing Bernina's check of this listing found something it does not allow, so it cannot be published. Change its name or description and try again.
kya_store_scan_blocked_verify Bernina's check of this listing found something it does not allow, so it cannot be Verified. Nothing was charged.
kya_store_scan_blocked_hire This listing did not pass Bernina's check, so it cannot be hired for now. Nothing was charged.
kya_verified_fee_not_set The Verified fee has not been set yet, so a listing cannot be Verified for now. Nothing was charged.
kya_store_verified_already This listing is Verified until {date}, and can be renewed closer to that day.
datekya_store_fee_not_confirmed The payment has not been confirmed, so the listing is not Verified yet. Nothing was charged.
kya_store_no_fee_waiting There is no Verified fee waiting to be confirmed for this listing.
only_owner_admin_decide_agent_key Only the owner or an admin can decide an outside agent's key.
confirm_email_decide_agent_key Confirm your email address first, then decide an outside agent's key. The link is in Settings, under Account.
wrong_region This company is served from its own region. Send this request to {host}.
hostregion_change_person A change of region is made by the owner, signed in. A key, a connected app or an agent cannot.
region_change_owner Only the owner can choose where this company's data is kept.
region_change_choose Choose the region: zh (Zurich) or ff (Frankfurt).
region_change_already This company's data is already kept in that region.
region_change_waiting A change of region is already waiting for the move. Withdraw it first.
region_change_none There is no change of region waiting.
run_create_limited Too many new requests for this company in the last minute. Try again in a minute.
Values inside params
A value chosen from a short list arrives as its own code, so your app can say it too.
category
MONEY_OUTMoney outFILINGFilingsCONTRACTContractsCUSTOMER_FACINGCustomer-facingDATA_WRITEData changesSCHEDULINGSchedulingINTERNAL_NOTEInternal notesBERNINA_REVIEWBernina reviewsUPGRADE_OFFERPlan upgradesTOPUPTop-ups
state
APPROVEDapprovedREJECTEDrejectedEXPIREDexpiredCANCELLEDcancelledDECIDEDdecided
blockers Several are joined by a space.
registry_code_not_setThe Estonian registry code for Zuger Technologies OÜ is not set. An invoice without it is invalid.vat_number_not_setThe EE VAT number is not set. OSS and reverse charge cannot be applied without it.address_not_setThe registered address is not set. It must appear on every invoice.seller_vat_not_configuredThe seller VAT number is not configured, so no EU invoice can be issued yet.
durations Several are joined by a comma.
1515 minutes601 hour2404 hours
failure
passkey_not_verifiedThat passkey could not be verified.passkey_removedThat passkey has been removed from the account.signature_not_verifiedThat signature could not be verified.signature_usedThat signature has already been used.passkey_not_on_accountThat passkey is not on this account.
part
hourThe hourminuteThe minuteweekdayThe weekdaydayThe day of the month
setting
issuerissuerauthorization_endpointauthorization endpointtoken_endpointtoken endpointjwks_urikeys address
Nothing matches. Try a path, a scope or a code.