Skip to content

Credential

A Credential is a standing authority a regulator grants a person or entity to perform certain acts in a jurisdiction.

Properties

PropertyTypeRequiredDescription
issuerstringrequiredThe regulator or registry that grants it.
jurisdictionstringrequiredWhere it applies.
standingstringWhether it is in good standing, read fresh on every use.

Object

JSON
{
  "$id": "https://api.sb/patentpad.com/credentials/credential_1",
  "$type": "Credential",
  "issuer": "Example issuer",
  "jurisdiction": "US-DE",
  "standing": "Example standing"
}

Relationships

  • A Credential has many Attestations: the Credential the signing Worker held when it signed. attestations, inverse signedUnder.
  • A Credential authorizes many Reserved Acts: a Credential lets its holder perform the Reserved Acts the law keeps for it, in its jurisdiction. authorizes, inverse requires.
  • A Credential is held by one Worker: a Worker performs a Reserved Act only while it holds the Credential that authorizes it, in good standing. heldBy, inverse holds.
  • A Credential is held by supplier one Supplier: the Credentials a Supplier holds decide which Reserved Acts it may perform; standing is read fresh on every use. heldBySupplier, inverse holds.

Verbs

  1. createCreates a Credential.
    POST /{namespace}/credentialsdoCredential.created
  2. getReturns one Credential by id.
    GET /{namespace}/credentials/{id}readNo Event
  3. listReturns Credentials, newest first, one page at a time.
    GET /{namespace}/credentialsreadNo Event
  4. updateChanges the given properties of a Credential.
    PATCH /{namespace}/credentials/{id}doCredential.updated
  5. deleteDeletes a Credential; its history is kept.
    DELETE /{namespace}/credentials/{id}doCredential.deleted
  6. verifyVerify confirms a Credential with the authority that issued it and records when it expires.
    POST /{namespace}/credentials/{credential}/verifydoCredential.verified

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Credential.createYesYesNoNo
Credential.getYesYesYesYes
Credential.listYesYesYesYes
Credential.updateYesYesNoNo
Credential.deleteYesYesNoNo
Credential.verifyYesYesNoNo

Call it

Text
Verify the latest credential.

Example

A state appraiser license is a Credential. A Supplier holding it performs appraisals in that state until the license lapses.