The Dock Certs connector lets your AI agent act in each user's Dock Certs account. Each user connects their own Dock Certs access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.
- Tools
- 59
- What they doRead · write · destructive
- 28 · 21 · 1028 read21 write10 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Dock Certs connection
In AgentKit > Connections, create a Dock Certs connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'dockcerts'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Dock Certs:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'dockcerts_account_profile_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "dockcerts"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Dock Certs:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="dockcerts_account_profile_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Dock Certs credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooldockcerts_account_profile_getGet the Truvera account profile of the API key's owner.Read-onlyGet Account Profile
Get the Truvera account profile of the API key's owner. Returns the account's name, email, plan and settings. Use it to confirm which account the connection uses.
Inputs
This tool takes no inputs.
dockcerts_account_stats_getGet usage statistics for the account.Read-onlyGet Account Stats
Get usage statistics for the account. Returns counts such as credentials issued, DIDs, schemas and verifications. Use it for usage reporting.
Inputs
This tool takes no inputs.
dockcerts_credential_getGet one issued credential's metadata, and its contents if it was persisted.Read-onlyGet Credential
Get one issued credential's metadata, and its contents if it was persisted. Returns the credential id, type, issuer, subject reference, revocation info and, for persisted credentials, the credential JSON. Use credentials_list to find credential IDs.
Inputs
credential_idstringrequired- Full ID of the credential, a URI such as https://creds.truvera.io/5c2b1e9a..., URL-encoded because it is placed in the URL path (encode : as %3A and / as %2F). Get it from credentials_list or credential_issue. Example: https%3A%2F%2Fcreds.truvera.io%2F5c2b1e9a8f7d6c5b4a39281706f5e4d3c2b1a0f9e8d7c6b5a4938271605f4e3d.
passwordstring- Deprecated. Supplying this parameter to retrieve decrypted persisted credential contents is deprecated and should not be used. Refer to the cloud wallet documentation for the recommended approach. Example: my-strong-passphrase.
dockcerts_credential_verifyVerify a verifiable credential or presentation, given as JSON (or a JWT string inside a JSON string).Read-onlyVerify Credential
Verify a verifiable credential or presentation, given as JSON (or a JWT string inside a JSON string). Returns verified true or false and the results of each check. Use it to check a credential a holder has shared.
Inputs
credentialobjectrequired- The verifiable credential or presentation JSON to verify, as issued (with its proof). Send the whole object. Example: {"@context": ["https://www.w3.org/2018/credentials/v1"], "type": ["VerifiableCredential"], "issuer": "did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11"...
dockcerts_credentials_listList the credentials your account has issued, with paging and an optional filter.Read-onlyList Credentials
List the credentials your account has issued, with paging and an optional filter. Returns each credential's id, type, subject reference, issuer, revocation and creation dates. Use credential_get for one credential.
Inputs
filterstring- Filter by specific Credential ID, Subject Ref, Subject ID, Issuer, Type, Created Date or Issue Date. Example: AlumniCredential.
limitinteger- How many items to return at one time (max 100). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
subject_idstring- Filter credentials by an exact credential subject ID (holder DID). Useful for finding all credentials issued to a specific holder. Example: did:key:z6MkqBcwvYurNSSqyBkxavv4fkaq2iu3v3YGMbdyfa4bVNxD.
dockcerts_did_getResolve one DID.Read-onlyGet DID
Resolve one DID. Returns its DID document with verification methods, controller and service endpoints. Use dids_list to see your DIDs.
Inputs
didstringrequired- A DID. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
dockcerts_dids_listList the DIDs your account controls.Read-onlyList DIDs
List the DIDs your account controls. Returns each DID's fully resolved DID document. Use did_get for one DID.
Inputs
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
typestring- The type of DID for filtering. Example: cheqd.
dockcerts_job_getGet the status of an asynchronous blockchain job, such as a DID creation or a revocation.Read-onlyGet Job
Get the status of an asynchronous blockchain job, such as a DID creation or a revocation. Returns the job id, status (todo, in_progress, finalized or error) and its result. Poll it after tools that return a job id.
Inputs
job_idstringrequired- A Job id. Example: 1234.
dockcerts_openid_issuers_listList your OpenID4VCI issuer configurations.Read-onlyList OpenID Issuers
List your OpenID4VCI issuer configurations. Returns each issuer's id, credential options and auth provider settings. Use openid_credential_offer_create to issue through one.
Inputs
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
dockcerts_profile_getGet the issuer profile of a DID.Read-onlyGet Issuer Profile
Get the issuer profile of a DID. Returns its DID, name, description and logo. Use profiles_list to find profiles.
Inputs
didstringrequired- A DID. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
dockcerts_profiles_listList the issuer profiles (name, description and logo attached to a DID).Read-onlyList Issuer Profiles
List the issuer profiles (name, description and logo attached to a DID). Returns each profile's DID, name, description and logo. Use profile_get for one profile.
Inputs
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
dockcerts_proof_request_getGet one proof request.Read-onlyGet Proof Request
Get one proof request. Returns its definition, verified flag and the presentation the holder submitted. Use it to check a verification's outcome.
Inputs
proof_request_idstringrequired- Proof request UUID. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
dockcerts_proof_requests_listList your proof requests.Read-onlyList Proof Requests
List your proof requests. Returns each request's id, name, verified flag and creation time. Use proof_request_get for one request.
Inputs
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
dockcerts_proof_template_getGet one proof template.Read-onlyGet Proof Template
Get one proof template. Returns its name, request definition, verifier DID and expiration. Use proof_templates_list to find template IDs.
Inputs
proof_template_idstringrequired- Proof template UUID. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
dockcerts_proof_template_history_listList the proof requests created from a proof template.Read-onlyList Proof Template History
List the proof requests created from a proof template. Returns each request's id, verified flag, presentation and creation time. Filter with verified=true to see successful verifications.
Inputs
proof_template_idstringrequired- Proof template UUID. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
verifiedboolean- Whether the presentation was verified or not. Example: true.
dockcerts_proof_templates_listList your proof (verification) templates.Read-onlyList Proof Templates
List your proof (verification) templates. Returns each template's id, name, request definition and expiration. Use proof_template_request_create to start a verification from one.
Inputs
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
dockcerts_registries_listList the revocation registries your account created.Read-onlyList Revocation Registries
List the revocation registries your account created. Returns each registry's id, type, policy and add-only flag. Use registry_get for one registry.
Inputs
didstring- DID exists in policy filter. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
typestring- Registry type filter. Example: StatusList2021Entry.
dockcerts_registry_getGet one revocation registry.Read-onlyGet Revocation Registry
Get one revocation registry. Returns its id, type, policy, add-only flag and revoked entries. Use registries_list to find registry IDs.
Inputs
registry_idstringrequired- Registry Id. Example: 0x3d1f0b0c4f2a8e6b9c7d5e3f1a2b4c6d8e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b.
dockcerts_revocation_status_getCheck whether a credential is revoked in a registry.Read-onlyGet Revocation Status
Check whether a credential is revoked in a registry. Returns true when revoked and false otherwise. The registry and revocation IDs are in the credential's credentialStatus.
Inputs
registry_idstringrequired- Revocation registry id. Example: 0x3d1f0b0c4f2a8e6b9c7d5e3f1a2b4c6d8e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b.
revocation_idstringrequired- Credential revocation id. Example: 21.
dockcerts_schema_getGet one credential schema by its ID.Read-onlyGet Schema
Get one credential schema by its ID. Returns the schema's name, description, properties and required fields. Use schemas_list to find schema IDs.
Inputs
schema_idstringrequired- ID of the schema, a URI such as https://schema.truvera.io/AlumniCredential-V1.json, URL-encoded because it is placed in the URL path (encode : as %3A and / as %2F). Get it from schemas_list or schema_create. Example: https%3A%2F%2Fschema.truvera.io%2FAlumniCredential-V1.json.
dockcerts_schemas_listList the credential schemas your account created.Read-onlyList Schemas
List the credential schemas your account created. Returns each schema's id, name, JSON schema and creation date. Use schema_get for one schema.
Inputs
include_ecosystemsboolean- Whether to include ecosystems or not. Defaults to true. Example: false.
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
dockcerts_template_getGet one credential design template.Read-onlyGet Design Template
Get one credential design template. Returns its id, name, HTML and CSS. Use templates_list to find template IDs.
Inputs
template_idstringrequired- The template ID. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
dockcerts_templates_listList your credential design templates (HTML and CSS used to render PDFs and web views of credentials).Read-onlyList Design Templates
List your credential design templates (HTML and CSS used to render PDFs and web views of credentials). Returns each template's id, name, HTML and CSS. Pass a template id as template in credential_issue.
Inputs
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
dockcerts_trust_registries_listList the trust registries (ecosystems) your account owns.Read-onlyList Trust Registries
List the trust registries (ecosystems) your account owns. Returns each registry's id, name, convener DID and governance framework. Use trust_registry_get for one registry.
Inputs
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
dockcerts_trust_registry_getGet one trust registry.Read-onlyGet Trust Registry
Get one trust registry. Returns its name, description, convener, logo, ecosystem URL and governance framework. Use trust_registries_list to find registry IDs.
Inputs
registry_idstringrequired- A trust registry id. Example: 6f1e2d3c-4b5a-6978-8a9b-0c1d2e3f4a5b.
dockcerts_trust_registry_participants_listList the participants (issuers and verifiers) of a trust registry, optionally filtered by schema or DID.Read-onlyList Trust Registry Participants
List the participants (issuers and verifiers) of a trust registry, optionally filtered by schema or DID. Returns each participant's id, DID, role, status and schemas. Use it to check who may issue a credential type.
Inputs
registry_idstringrequired- A trust registry id. Example: 6f1e2d3c-4b5a-6978-8a9b-0c1d2e3f4a5b.
didstring- Filter participants by DID. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
schema_idstring- A schema id. Example: https://schema.truvera.io/AlumniCredential-V1.json.
dockcerts_webhook_getGet one webhook.Read-onlyGet Webhook
Get one webhook. Returns its url, events, status and description. Use webhooks_list to find webhook IDs.
Inputs
webhook_idstringrequired- Webhook ID. Example: 8a6f2b1c-3d4e-5f6a-7b8c-9d0e1f2a3b4c.
dockcerts_webhooks_listList the account's webhooks.Read-onlyList Webhooks
List the account's webhooks. Returns each webhook's id, url, events, status and description. Use webhook_get for one webhook.
Inputs
limitinteger- How many items to return at one time (max 64). Defaults to 64. Example: 64.
offsetinteger- How many items to offset by for pagination. Defaults to 0. Example: 0.
dockcerts_credential_issueIssue (sign) a verifiable credential from an issuer DID, optionally emailing it or sending it to the holder's DID.WriteIssue Credential
Issue (sign) a verifiable credential from an issuer DID, optionally emailing it or sending it to the holder's DID. Returns the signed credential JSON, or a JWT when format=jwt. Create the issuer DID with did_create first; set revocable=true to be able to revoke it later.
Inputs
credentialobjectrequired- Format to create credentials with the API. Example: {"name": "Alumni Credential", "type": ["VerifiableCredential", "AlumniCredential"], "issuer": "did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11", "subj...
algorithmstring- Optional. Specifies which signing algorithm to use to sign the issued credential. Defaults to ed25519 for jsonld/jwt and secp256r1 (ES256) for sdjwt. For ZKP credentials use dockbbs. If omitted and the credential references a Truvera schema with $metadata.variant, the value from the schema is used. Example: dockbbs.
distributeboolean- Whether to distribute the credential or not based on subject DID or email address. Not required for OpenID flows. Defaults to false. Example: false.
formatstring- Specifies the output format of the credential, either jsonld, jwt or sdjwt. Defaults to jsonld. If omitted and the credential references a Truvera schema with $metadata.variant, the value from the schema is used. Example: jsonld.one of
jsonldjwtsdjwt passwordstring- Password used to encrypt the credential if you choose to store it. The same password must be used to retrieve the credential contents. Truvera does not store this password. Example: my-strong-passphrase.
persistboolean- Whether to store an encrypted version of this credential with us. Defaults to false, if true you must supply password. When choosing to persist a credential containing Personally Identifiable Information (PII), consider the implications for data storage regulatory compliance. Example: false.
recipient_didstring- The holder's DID for DID distribution, optional. Not required for OpenID flows. Example: did:key:z6MkqBcwvYurNSSqyBkxavv4fkaq2iu3v3YGMbdyfa4bVNxD.
recipient_emailstring- The holder's email for email distribution, optional. Not required for OpenID flows. Example: jane@example.com.
revocableboolean- Whether the credential can be revoked or not. If true the revocation registry will be automatically provisioned. If omitted and the credential references a Truvera schema with $metadata.variant, the value from the schema is used; otherwise the credential is not revocable. Example: true.
templatestring- The credential template UUID, only required for PDF and web rendering customization. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
dockcerts_credential_revokeRevoke an issued credential through its revocation registry, so verification fails.WriteRevoke Credential
Revoke an issued credential through its revocation registry, so verification fails. Returns the blockchain job, whose status you can check with job_get. Only credentials issued with revocable=true can be revoked.
- Idempotent
Inputs
credential_idstringrequired- Full ID of the credential, a URI such as https://creds.truvera.io/5c2b1e9a..., URL-encoded because it is placed in the URL path (encode : as %3A and / as %2F). Get it from credentials_list or credential_issue. Example: https%3A%2F%2Fcreds.truvera.io%2F5c2b1e9a8f7d6c5b4a39281706f5e4d3c2b1a0f9e8d7c6b5a4938271605f4e3d.
dockcerts_credential_unrevokeReinstate a revoked credential so it verifies again.WriteUnrevoke Credential
Reinstate a revoked credential so it verifies again. Returns the blockchain job, whose status you can check with job_get. Only works on registries that are not add-only.
- Idempotent
Inputs
credential_idstringrequired- Full ID of the credential, a URI such as https://creds.truvera.io/5c2b1e9a..., URL-encoded because it is placed in the URL path (encode : as %3A and / as %2F). Get it from credentials_list or credential_issue. Example: https%3A%2F%2Fcreds.truvera.io%2F5c2b1e9a8f7d6c5b4a39281706f5e4d3c2b1a0f9e8d7c6b5a4938271605f4e3d.
dockcerts_did_createCreate a new DID with an auto-generated keypair, to issue or verify credentials from.WriteCreate DID
Create a new DID with an auto-generated keypair, to issue or verify credentials from. Returns the DID and a job id; the DID is ready when job_get reports the job finalized. Use did_get to read the resolved DID document.
Inputs
controllerstring- DID as fully qualified, typically. did:cheqd:. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
didstring- DID as fully qualified, typically. did:cheqd:. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
didcomm_service_urlstring- Optional custom DIDComm service endpoint URL. If not provided, a default URL will be generated using the server URL and DID. This is not supported for did:key. Example: https://api.example.com/messaging/did:cheqd:testnet:abc123/receive.
include_didcomm_serviceboolean- Whether to include a DIDComm service endpoint in the DID document. Defaults to true. Set to false to create a DID without DIDComm service endpoint. Example: true.
key_typestring- Type of public key for DID (NOTE: secp256k1, sr25519 are deprecated; secp256r1 is supported for ES256/JWK flows). Example: ed25519.one of
ed25519bjjsecp256r1secp256k1sr25519 typestring- Type. Defaults to cheqd. Example: cheqd.one of
cheqddockkey
dockcerts_openid_credential_offer_createGenerate an OpenID4VCI credential offer URL for an OpenID issuer, for a holder's wallet to claim a credential.WriteCreate OpenID Credential Offer
Generate an OpenID4VCI credential offer URL for an OpenID issuer, for a holder's wallet to claim a credential. Returns the offer URL to show as a link or QR code. Create the issuer with openid_issuer_create first.
Inputs
issuer_idstringrequired- The OpenID issuer UUID. Example: b1c2d3e4-f5a6-4b7c-8d9e-0f1a2b3c4d5e.
request_parametersobject- Optional extra request parameters passed to the federated OpenID provider, such as login hint. Example: {"login_hint": "jane@example.com"}
dockcerts_openid_issuer_createCreate an OpenID4VCI issuer configuration that wallets can claim credentials from.WriteCreate OpenID Issuer
Create an OpenID4VCI issuer configuration that wallets can claim credentials from. Returns the issuer with its id. Use openid_credential_offer_create to generate an offer URL for it.
Inputs
credential_optionsobjectrequired- Credential Options. Example: {"credential": {"type": ["AlumniCredential"], "issuer": "did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11"}}
auth_providerobject- OpenID provider configuration. Example: {"url": "https://login.example.com", "clientId": "abc", "clientSecret": "secret"}
claim_mapobject- Key/value pair mapping for OpenID claims to JSON-LD terms. Can be null/undefined if no 3rd party claims to pull. Example: {"name": "name"}
single_useboolean- Whether or not to expire this issuer (and all URLs related to it) after one credential is issued. Defaults to false. Example: false.
dockcerts_profile_createCreate an issuer profile for a DID, so credentials it issues show your name and logo.WriteCreate Issuer Profile
Create an issuer profile for a DID, so credentials it issues show your name and logo. Returns the profile. Create the DID with did_create first.
Inputs
didstringrequired- A DID. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
namestringrequired- Issuer name shown on credentials issued by this DID. Example: Example University.
descriptionstring- Short description of the issuer. Example: Issuer of alumni credentials.
logostring- Issuer logo as an image URL or base64 data URI. Example: https://www.example.edu/logo.png.
dockcerts_profile_updateUpdate the name, description or logo of a DID's issuer profile.WriteUpdate Issuer Profile
Update the name, description or logo of a DID's issuer profile. Returns the updated profile. Use profile_get to read the current values.
Inputs
didstringrequired- A DID. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
descriptionstring- Short description of the issuer. Example: Issuer of alumni credentials.
logostring- Issuer logo as an image URL or base64 data URI. Example: https://www.example.edu/logo.png.
namestring- Issuer name shown on credentials. Example: Example University.
dockcerts_proof_request_createCreate a proof request directly, without a template.WriteCreate Proof Request
Create a proof request directly, without a template. Returns the proof request with its id and the qr URL the holder's wallet opens. Use proof_template_request_create when the same check repeats.
Inputs
namestringrequired- Proof request name. Example: Alumni Credential.
attributesobject- Requested attribute specifications of proof request. Example: {"alumniOf": {}}
cedar_verification_policystring- Optional Cedar policy to run on verification. Example: permit(principal, action, resource);.
delegation_requirementsobject- Delegation requirements keyed by PEX input descriptor id. Example: {"alumni": {"rootIssuers": ["did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11"]}}
didstring- A DID. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
noncestring- Nonce or challenge for the presentation to match. Example: 1234567890.
requestobject- The actual details of the proof request. Example: {"input_descriptors": [{"id": "alumni", "constraints": {"fields": [{"path": ["$.credentialSubject.alumniOf"]}]}}]}
templatestring- The unique identifier for the template. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
dockcerts_proof_template_createCreate a proof template that describes which credentials and fields a holder must present.WriteCreate Proof Template
Create a proof template that describes which credentials and fields a holder must present. Returns the template with its id. Use proof_template_request_create to create proof requests from it.
Inputs
namestringrequired- Proof request name. Example: Alumni Credential.
cedar_verification_policystring- Optional Cedar policy to run on verification. Example: permit(principal, action, resource);.
delegation_requirementsobject- Delegation requirements keyed by PEX input descriptor id. Example: {"alumni": {"rootIssuers": ["did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11"]}}
didstring- A DID. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
expiration_timeobject- Expiration time as interval object. Example: {"amount": 1, "unit": "months"}
requestobject- The actual details of the proof request. Example: {"input_descriptors": [{"id": "alumni", "constraints": {"fields": [{"path": ["$.credentialSubject.alumniOf"]}]}}]}
dockcerts_proof_template_request_createCreate a proof request from a proof template, to send to a holder.WriteCreate Proof Request from Template
Create a proof request from a proof template, to send to a holder. Returns the proof request with its id and the qr URL the holder's wallet opens. Use proof_request_get to check whether it was verified.
Inputs
proof_template_idstringrequired- Proof template UUID. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
didstring- The DID that will be used as the verifier DID in the proof request. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
noncestring- A unique nonce value used in the proof request. Example: 123456.
dockcerts_proof_template_updateUpdate a proof template's name, request definition, verifier DID or expiration.WriteUpdate Proof Template
Update a proof template's name, request definition, verifier DID or expiration. Returns the updated template. Pass name again, as Truvera requires it.
Inputs
namestringrequired- Proof request name. Example: Alumni Credential.
proof_template_idstringrequired- Proof template UUID. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
cedar_verification_policystring- Optional Cedar policy to run on verification. Example: permit(principal, action, resource);.
delegation_requirementsobject- Delegation requirements keyed by PEX input descriptor id. Example: {"alumni": {"rootIssuers": ["did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11"]}}
didstring- A DID. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
expiration_timeobject- Expiration time as interval object. Example: {"amount": 1, "unit": "months"}
requestobject- The actual details of the proof request. Example: {"input_descriptors": [{"id": "alumni", "constraints": {"fields": [{"path": ["$.credentialSubject.alumniOf"]}]}}]}
dockcerts_registry_createCreate a revocation registry for revocable credentials.WriteCreate Revocation Registry
Create a revocation registry for revocable credentials. Returns the registry id and a job id. Usually not needed: credential_issue with revocable=true creates one automatically.
Inputs
add_onlyboolean- Add Only. Example: true.
policyarray- Only one policy supported as of now called OneOf. Example: ["did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11"]
typestring- Type. Defaults to StatusList2021Entry. Example: StatusList2021Entry.one of
CredentialStatusList2017StatusList2021EntryDockVBAccumulator2022
dockcerts_registry_revocation_updateRevoke or unrevoke one or more credentials in a revocation registry in one call.WriteRevoke or Unrevoke in Registry
Revoke or unrevoke one or more credentials in a revocation registry in one call. Returns the blockchain job id. Use credential_revoke for a single credential by ID.
Inputs
registry_idstringrequired- Registry Id. Example: 0x3d1f0b0c4f2a8e6b9c7d5e3f1a2b4c6d8e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b.
actionstring- Action. Defaults to revoke. Example: revoke.one of
revokeunrevoke credential_idsarray- Credential IDs. Example: ["https://creds.truvera.io/5c2b1e9a"]
dockcerts_schema_createCreate a credential JSON schema that defines the fields of a credential type.WriteCreate Schema
Create a credential JSON schema that defines the fields of a credential type. Returns the schema id (a URI) and a job id. Use the schema id in the credential's schema field when issuing.
Inputs
additional_propertiesboolean- Specifies whether additional properties outside the defined schema are allowed. Example: true.
descriptionstring- A brief description of the schema. Example: Truvera Schema Example.
json_schema_versionstring- The schema version, generally following the JSON-schema specification. Example: http://json-schema.org/draft-07/schema#.
metadataobject- Truvera metadata stored with the schema. Example: {"version": 1}
namestring- Name of the schema. Example: Alumni Credential.
propertiesobject- The properties that define the schema. Example: {"id": {"type": "string"}, "emailAddress": {"type": "string", "format": "email"}, "alumniOf": {"type": "string"}}
requiredarray- Required fields within the schema. Example: ["emailAddress", "alumniOf"]
typestring- Defines the type of schema. Usually 'object'. Example: object.
dockcerts_template_createCreate a credential design template from HTML and CSS.WriteCreate Design Template
Create a credential design template from HTML and CSS. Returns the template with its id. Use its id as template in credential_issue.
Inputs
cssstringrequired- The CSS content of the template. Example: .cred { font-family: sans-serif; }
htmlstringrequired- The HTML content of the template. Example: <div class="cred">{{ credentialSubject.name }}</div>.
namestringrequired- The name of the template. Example: Alumni Credential.
dockcerts_template_updateUpdate a credential design template's name, HTML and CSS.WriteUpdate Design Template
Update a credential design template's name, HTML and CSS. Returns the updated template. Pass all three fields.
Inputs
cssstringrequired- The CSS content of the template. Example: .cred { font-family: sans-serif; }
htmlstringrequired- The HTML content of the template. Example: <div class="cred">{{ credentialSubject.name }}</div>.
namestringrequired- The name of the template. Example: Alumni Credential.
template_idstringrequired- A template ID. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
dockcerts_trust_registry_createCreate a trust registry (ecosystem) with a convener DID and governance framework.WriteCreate Trust Registry
Create a trust registry (ecosystem) with a convener DID and governance framework. Returns the trust registry with its id. Requires a Truvera Custom plan.
Inputs
convenerstringrequired- DID as fully qualified, typically. did:cheqd:. Example: did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59.
descriptionstringrequired- Trust registry description. Example: Registry of accredited universities.
ecosystem_urlstringrequired- Ecosystem URL. Example: https://ecosystem.truvera.io.
governance_frameworkstringrequired- Trust registry governance framework. Example: https://ecosystem.example.com/governance.
governance_framework_versionstringrequired- Trust registry governance framework version. Example: 1.0.0.
logo_urlstringrequired- Logo URL. Example: https://logo.truvera.io/trust-registry.
namestringrequired- Trust registry name. Example: Example Education Ecosystem.
dockcerts_trust_registry_updateUpdate a trust registry's name, description, logo, URLs and governance framework.WriteUpdate Trust Registry
Update a trust registry's name, description, logo, URLs and governance framework. Returns the updated trust registry. Pass every field again, as Truvera requires them.
Inputs
descriptionstringrequired- Trust registry description. Example: Registry of accredited universities.
ecosystem_urlstringrequired- Trust registry ecosystem URL. Example: https://ecosystem.truvera.io.
governance_frameworkstringrequired- Trust registry governance framework. Example: https://ecosystem.example.com/governance.
governance_framework_versionstringrequired- Trust registry governance framework version. Example: 1.0.0.
logo_urlstringrequired- Trust registry logo URL. Example: https://logo.truvera.io/trust-registry.
namestringrequired- Trust registry name. Example: Example Education Ecosystem.
registry_idstringrequired- A trust registry id. Example: 6f1e2d3c-4b5a-6978-8a9b-0c1d2e3f4a5b.
dockcerts_webhook_createCreate a webhook that posts account events (for example credential_issued) to a URL.WriteCreate Webhook
Create a webhook that posts account events (for example credential_issued) to a URL. Returns the webhook with its id. Set status=1 to enable it.
Inputs
eventsarrayrequired- Events. Example: ["credential_issued", "credential_revoke"]
urlstringrequired- The URL to send the webhook to. Example: https://webhook.example.io.
descriptionstring- The description of the webhook. Example: My webhook.
statusinteger- The status of the webhook (0 = disabled, 1 = enabled). Example: 0.one of
01
dockcerts_webhook_updateUpdate a webhook's URL, events, status or description.WriteUpdate Webhook
Update a webhook's URL, events, status or description. Returns the updated webhook. Pass url and events again, as Truvera requires them.
Inputs
eventsarrayrequired- Events. Example: ["credential_issued", "credential_revoke"]
urlstringrequired- The URL to send the webhook to. Example: https://webhook.example.io.
webhook_idstringrequired- Webhook ID. Example: 8a6f2b1c-3d4e-5f6a-7b8c-9d0e1f2a3b4c.
descriptionstring- The description of the webhook. Example: My webhook.
statusinteger- The status of the webhook (0 = disabled, 1 = enabled). Example: 0.one of
01
dockcerts_credential_deleteDelete an issued credential's stored metadata and contents from Truvera.DestructiveDelete Credential
Delete an issued credential's stored metadata and contents from Truvera. Returns a confirmation. Deleting does not revoke it; use credential_revoke to invalidate it for verifiers.
- Idempotent
Inputs
credential_idstringrequired- Full ID of the credential, a URI such as https://creds.truvera.io/5c2b1e9a..., URL-encoded because it is placed in the URL path (encode : as %3A and / as %2F). Get it from credentials_list or credential_issue. Example: https%3A%2F%2Fcreds.truvera.io%2F5c2b1e9a8f7d6c5b4a39281706f5e4d3c2b1a0f9e8d7c6b5a4938271605f4e3d.
passwordstring- Deprecated. Supplying this parameter to retrieve decrypted persisted credential contents is deprecated and should not be used. Refer to the cloud wallet documentation for the recommended approach. Example: my-strong-passphrase.
dockcerts_did_deleteDelete a DID from your account and deactivate it.DestructiveDelete DID
Delete a DID from your account and deactivate it. Returns a confirmation. Credentials issued by the DID can no longer be verified against it.
- Idempotent
Inputs
didstringrequired- A DID. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
from_blockchainboolean- Whether to delete the DID from the blockchain (true) or just from the user's account (false). Defaults to true for backward compatibility. Example: true.
dockcerts_profile_deleteDelete the issuer profile of a DID.DestructiveDelete Issuer Profile
Delete the issuer profile of a DID. Returns a confirmation. The DID itself is not deleted.
- Idempotent
Inputs
didstringrequired- A DID. Example: did:cheqd:mainnet:ac2b9027-ec1a-4ee2-aad1-2f4a7e5b3c11.
dockcerts_proof_request_deleteDelete a proof request.DestructiveDelete Proof Request
Delete a proof request. Returns a confirmation. A holder can no longer respond to it.
- Idempotent
Inputs
proof_request_idstringrequired- Proof request UUID. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
dockcerts_proof_template_deleteDelete a proof template.DestructiveDelete Proof Template
Delete a proof template. Returns a confirmation. Existing proof requests are not deleted.
- Idempotent
Inputs
proof_template_idstringrequired- Proof template UUID. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
dockcerts_registry_deleteDelete a revocation registry.DestructiveDelete Revocation Registry
Delete a revocation registry. Returns a job id. Credentials that rely on it can no longer be checked for revocation.
- Idempotent
Inputs
registry_idstringrequired- Registry Id. Example: 0x3d1f0b0c4f2a8e6b9c7d5e3f1a2b4c6d8e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b.
dockcerts_schema_deleteDelete a credential schema from your account.DestructiveDelete Schema
Delete a credential schema from your account. Returns a confirmation. Credentials already issued are not changed.
- Idempotent
Inputs
schema_idstringrequired- ID of the schema, a URI such as https://schema.truvera.io/AlumniCredential-V1.json, URL-encoded because it is placed in the URL path (encode : as %3A and / as %2F). Get it from schemas_list or schema_create. Example: https%3A%2F%2Fschema.truvera.io%2FAlumniCredential-V1.json.
dockcerts_template_deleteDelete a credential design template.DestructiveDelete Design Template
Delete a credential design template. Returns a confirmation. Credentials already issued are not changed.
- Idempotent
Inputs
template_idstringrequired- A template ID. Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e.
dockcerts_trust_registry_deleteDelete a trust registry and its participants.DestructiveDelete Trust Registry
Delete a trust registry and its participants. Returns a confirmation. This cannot be undone.
- Idempotent
Inputs
registry_idstringrequired- A trust registry id. Example: 6f1e2d3c-4b5a-6978-8a9b-0c1d2e3f4a5b.
dockcerts_webhook_deleteDelete a webhook so it stops receiving events.DestructiveDelete Webhook
Delete a webhook so it stops receiving events. Returns a confirmation. To pause it instead, set status=0 with webhook_update.
- Idempotent
Inputs
webhook_idstringrequired- Webhook ID. Example: 8a6f2b1c-3d4e-5f6a-7b8c-9d0e1f2a3b4c.
No tools match.