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

Consent routes: create, get, list

The Consent Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Consent, one group of Consent routes.

Consent.create

Creates a Consent. Verb page.

Text
POST /{namespace}/consents

Body, as JSON: the inputs. Emits Consent.created.

Inputs

InputTypeRequiredDescription
basisstringrequiredThe lawful basis, such as consent or contract. Never randomized.
regionstringThe jurisdiction whose rules apply. Never randomized.
withdrawnAtdatetimeWhen the person withdrew it. Never randomized.
contactContactA Contact grants Consents, each for one Purpose, with its basis and expiry.
purposePurposeThe Purpose the Consent permits processing for, and nothing beyond it.

Returns

OutputTypeRequiredDescription
consentConsentrequiredThe Consent.

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.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/consents \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"basis":"Example basis"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "consent": {
    "$id": "https://api.sb/leaseline.app/consents/consent_lMkrg7nUGY",
    "$type": "Consent",
    "basis": "Example basis"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Consent.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Consent.get

Returns one Consent by id. Verb page.

Text
GET /{namespace}/consents/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Consent.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
consentConsentrequiredThe Consent.

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.

Example

Terminal
curl https://api.sb/leaseline.app/consents/consent_lMkrg7nUGY \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Consent",
  "$id": "https://api.sb/leaseline.app/consents/consent_lMkrg7nUGY",
  "consent": {
    "$id": "https://api.sb/leaseline.app/consents/consent_lMkrg7nUGY",
    "$type": "Consent",
    "basis": "Example basis"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/consents/consent_lMkrg7nUGY",
    "up": "https://api.sb/leaseline.app/consents"
  },
  "actions": {
    "withdraw": "https://api.sb/leaseline.app/consents/consent_lMkrg7nUGY/withdraw"
  }
}

Consent.list

Returns Consents, newest first, one page at a time. Verb page.

Text
GET /{namespace}/consents

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
consentslist of ConsentrequiredOne page of Consents.

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.

Example

Terminal
curl "https://api.sb/leaseline.app/consents?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Consent",
  "consents": [
    {
      "$id": "https://api.sb/leaseline.app/consents/consent_lMkrg7nUGY",
      "$type": "Consent",
      "basis": "Example basis"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "consent_lMkrg7nUGY"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/consents?limit=20",
    "next": "https://api.sb/leaseline.app/consents?after=consent_lMkrg7nUGY"
  }
}

Consent

Previous

update

Next