Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APITeamCredential

Credential routes: create, get, list

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

Reference for Credential, one group of Credential routes.

Credential.create

Creates a Credential. Verb page.

Text
POST /{namespace}/credentials

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

Inputs

InputTypeRequiredDescription
issuerstringrequiredThe regulator or registry that grants it.
jurisdictionstringrequiredWhere it applies.
standingstringWhether it is in good standing, read fresh on every use.
supplierSupplierThe Credentials a Supplier holds decide which Reserved Acts it may perform; standing is read fresh on every use.
workerWorkerA Worker performs a Reserved Act only while it holds the Credential that authorizes it, in good standing.

Returns

OutputTypeRequiredDescription
credentialCredentialrequiredThe Credential.

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/credentials \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"issuer":"Example issuer","jurisdiction":"US-DE"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "credential": {
    "$id": "https://api.sb/leaseline.app/credentials/credential_Abb9zatRR1",
    "$type": "Credential",
    "issuer": "Example issuer",
    "jurisdiction": "US-DE"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Credential.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Credential.get

Returns one Credential by id. Verb page.

Text
GET /{namespace}/credentials/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
credentialCredentialrequiredThe Credential.

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/credentials/credential_Abb9zatRR1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Credential",
  "$id": "https://api.sb/leaseline.app/credentials/credential_Abb9zatRR1",
  "credential": {
    "$id": "https://api.sb/leaseline.app/credentials/credential_Abb9zatRR1",
    "$type": "Credential",
    "issuer": "Example issuer",
    "jurisdiction": "US-DE"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/credentials/credential_Abb9zatRR1",
    "up": "https://api.sb/leaseline.app/credentials"
  },
  "actions": {
    "verify": "https://api.sb/leaseline.app/credentials/credential_Abb9zatRR1/verify"
  }
}

Credential.list

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

Text
GET /{namespace}/credentials

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
credentialslist of CredentialrequiredOne page of Credentials.

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/credentials?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Credential",
  "credentials": [
    {
      "$id": "https://api.sb/leaseline.app/credentials/credential_Abb9zatRR1",
      "$type": "Credential",
      "issuer": "Example issuer",
      "jurisdiction": "US-DE"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "credential_Abb9zatRR1"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/credentials?limit=20",
    "next": "https://api.sb/leaseline.app/credentials?after=credential_Abb9zatRR1"
  }
}

Credential

Previous

update, delete

Next