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

Credential routes: verify

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

Reference for Credential, one group of Credential routes.

Credential.verify

Verify confirms a Credential with the authority that issued it and records when it expires. Verb page.

Text
POST /{namespace}/credentials/{credential}/verify

Path: credential. Emits Credential.verified.

Inputs

InputTypeRequiredDescription
credentialCredentialrequiredThe Credential to check.

Returns

OutputTypeRequiredDescription
credentialCredentialrequiredThe verified Credential.

Refuses when

CheckErrorFixThen call
The input does not match the schema of the operation.invalid-inputRead the schema of the operation, then send every required field with the right type.None.
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/credentials/credential_Abb9zatRR1/verify \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
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.verify",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Mandate

Next