Skip to content

by Startups.Studio

Legal & trust Consent

Consent.create

POST /{namespace}/consents

Creates a Consent.

Noun: Consent
Mode: do
Event: Consent.created

You, to your agent

Add a consent to Kiln Bakery.

curl -X POST https://api.sb/kilnbakery.com/consents \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"basis":"Example basis"}'

import { $ } from 'startup-builder'

const consent = await $.Consent.create({ basis: 'Example basis' })

npx startup-builder do Consent.create --json '{"basis":"Example basis"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Consent.create({ basis: 'Example basis' })"
  }
}

Create makes a new Consent from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`basis`	`string`	required	The lawful basis, such as consent or contract. Never randomized.
`region`	`string`		The jurisdiction whose rules apply. Never randomized.
`withdrawnAt`	`datetime`		When the person withdrew it. Never randomized.
`contact`	Contact		A Contact grants Consents, each for one Purpose, with its basis and expiry.
`purpose`	Purpose		The Purpose the Consent permits processing for, and nothing beyond it.

Outputs

Output	Type	Required	Description
`consent`	Consent	required	The Consent.

Effects

Emits Consent.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Consent.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Consent

Previous Page

Consent.get

Next Page