VerifycateDeveloper Docs

Scopes

API key permission scopes for certificates and templates

When you create an API key you can attach permission scopes. Each API operation declares its API-key policy, and centralized authorization enforces that policy after the route is matched.

Full access

An empty permissions list grants full access to every workspace API route the key can call. Prefer this for internal automation; use narrower scopes for least privilege.

Available scopes

ScopeAllows
certificates:readGET on certificate, issue, recipient, correction, and request-form paths
certificates:writeNon-GET methods on those same paths
templates:readGET on certificate-template and email-template paths
templates:writeNon-GET methods on certificate-template and email-template paths

Policies are operation-based:

  • Template and email-template operations declare templates:read or templates:write.
  • Certificate, issue, recipient, correction, and request-form operations declare certificates:read or certificates:write.
  • Administrative operations such as API-key management explicitly require a full-access key.
  • Authenticated operations without an API-key policy reject API-key callers by default.

Missing permission returns 403 with code missing_permission.

Examples

CallScope needed
GET .../certificatescertificates:read (or full access)
POST .../certificates/{id}/issuescertificates:write (or full access)
POST .../certificates/{id}/sendcertificates:write (or full access)
GET .../requestscertificates:read (or full access)
POST .../requests/{id}/approvecertificates:write (or full access)
GET .../correctionscertificates:read (or full access)
POST .../corrections/{id}/approvecertificates:write (or full access)
GET .../recipientscertificates:read (or full access)
Template draft / publish / forktemplates:read / templates:write (not in this v1 reference)