Create certification metadata
Create certification metadata without file uploads. Files and badges must be uploaded separately using dedicated endpoints.
AuthorizationBearer <token>
In: header
titlestring
Certification title
Length
1 <= length
description?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
date
expiry_date?string
Expiry date in YYYY-MM-DD format
Match
^\d{4}-\d{2}-\d{2}$
Format
date
validity_months?integer
Validity period in months
Range
1 <= value
state?string
Initial certification state
Default
"valid"
Value in
"valid" | "pending" | "expired" | "inactive"
featured?boolean
Whether certification should be featured
Default
false
show_validity_period_on_card?boolean
Show validity period on card display
Default
true
template?string
Template ID to derive badge and category from
Format
uuid
Response Body
const body = JSON.stringify({
"title": "ISO 27001 Certificate"
})
fetch("https://app.orbiqhq.com/api/v1/certifications", {
body
})
{
"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?