API

Certifyx API documentation

Use the public API host for customer integrations and the internal API host for platform automations.

Public API

https://api.certifyx.club/v1

Internal API

https://api-internal.certifyx.club/v1

Verification

https://verify.certifyx.club

Authentication

Send API keys as Bearer tokens from your server. Sandbox keys start with sk_sandbox_; production keys start with sk_live_.

Authorization: Bearer sk_sandbox_xxx

Endpoints

GET/v1/healthPublic API health check.

POST/v1/certificates/issueIssue one certificate.

POST/v1/certificates/bulkQueue a certificate batch.

GET/v1/certificates/{certificateId}Read certificate status.

POST/v1/certificates/{certificateId}/revokeRevoke a certificate.

GET/v1/verify/{certificateId}Server-side verification.

GET/v1/templatesList certificate templates.

POST/v1/webhooksRegister webhook endpoints.

Issue example

curl -X POST https://api.certifyx.club/v1/certificates/issue \
  -H "Authorization: Bearer sk_sandbox_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "recipientName": "Aina Rahman",
    "recipientEmail": "aina@example.com",
    "title": "Safety Training Certificate",
    "publicMetadata": { "trainerName": "Certifyx Academy" },
    "privateMetadata": { "deviceId": "tablet-042" }
  }'

API