Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APILegal & trustAgreement

Agreement routes: sign, terminate

The Agreement Verbs sign, terminate as api.sb routes, with inputs, result, refusals and an example.

Reference for Agreement, one group of Agreement routes.

Agreement.sign

Sign executes an Agreement for one Party and records the signature, the signer and the time. Verb page.

Text
POST /{namespace}/agreements/{agreement}/sign

Path: agreement. Emits Agreement.signed.

Inputs

InputTypeRequiredDescription
agreementAgreementrequiredThe Agreement to sign.

Returns

OutputTypeRequiredDescription
agreementAgreementrequiredThe Agreement, in force once every party signs.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY/sign \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "agreement": {
    "$id": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
    "$type": "Agreement",
    "status": "signed"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Agreement.sign",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Agreement.terminate

Terminate ends an Agreement under its own term, records the reason and the date, and keeps the signed record. Verb page.

Text
POST /{namespace}/agreements/{agreement}/terminate

Path: agreement. Body, as JSON: the other inputs. Emits Agreement.terminated.

Inputs

InputTypeRequiredDescription
agreementAgreementrequiredThe Agreement in force.
reasontextrequiredThe term it ends under and why.

Returns

OutputTypeRequiredDescription
agreementAgreementrequiredThe terminated Agreement, kept forever.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record changed since it was read, so the write would overwrite a newer version.conflictRead the record again, then retry the write against its current state.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY/terminate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Example reason"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "agreement": {
    "$id": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
    "$type": "Agreement",
    "status": "terminated"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Agreement.terminate",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update

Previous

Attestation

Next