API v1 ReferenceCertifications
Create certification metadata
Create certification metadata without file uploads. Files and badges must be uploaded separately using dedicated endpoints.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
title*string
Certification title
Length
1 <= lengthdescription?string
Certification description
description_markdown?string
Markdown-formatted description
issue_date?string
Issue date in YYYY-MM-DD format
Match
^\d{4}-\d{2}-\d{2}$Format
dateexpiry_date?string
Expiry date in YYYY-MM-DD format
Match
^\d{4}-\d{2}-\d{2}$Format
datevalidity_months?integer
Validity period in months
Range
1 <= valuestate?string
Initial certification state
Default
"valid"Value in
"valid" | "pending" | "expired" | "inactive"featured?boolean
Whether certification should be featured
Default
falseshow_validity_period_on_card?boolean
Show validity period on card display
Default
truetemplate?string
Template ID to derive badge and category from
Format
uuidResponse Body
application/json
application/json
curl -X POST "https://app.orbiqhq.com/api/v1/certifications" \ -H "Content-Type: application/json" \ -d '{ "title": "ISO 27001 Certificate", "description": "Information Security Management System certification", "issue_date": "2025-01-15", "validity_months": 36, "featured": true }'{
"success": true,
"data": {
"documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
"uploadUrls": {
"document": "/api/v1/certifications/cert-123/document",
"badge": "/api/v1/certifications/cert-123/badge"
}
}
}{
"error": "Invalid input: title: title_required"
}Empty
Empty
How is this guide?