VerifycateDeveloper Docs

Scopes

API key permission scopes for certificates and templates

When you create an API key you can attach permission scopes. The server checks the key on every authenticated request (APIKeyGate).

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, correction, and request-form paths
certificates:writeNon-GET methods on those same paths
templates:readGET on paths containing /template
templates:writeNon-GET methods on paths containing /template

Inference is path-based:

  • Paths containing /template need templates:read or templates:write.
  • Paths containing /certificate, /issues, /corrections, or /requests need certificates:read or certificates:write.
  • Other authenticated workspace routes (for example /recipients) require a full-access key (empty permissions). A key limited to certificates:* alone cannot call them.

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 .../recipientsFull access only
Template draft / publish / forktemplates:read / templates:write (not in this v1 reference)