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

TypeScript Definitions

Use the request body type in TypeScript.

title*string

Certification title

Length1 <= length

slug?string

URL-friendly certification identifier

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}$

Formatdate

expiry_date?string

Expiry date in YYYY-MM-DD format

Match^\d{4}-\d{2}-\d{2}$

Formatdate

validity_months?integer

Validity period in months

Range1 <= value

state?string

Initial certification state

Default"valid"

Value in

"valid"
"expired"

featured?boolean

Whether certification should be featured

Defaultfalse

show_validity_period_on_card?boolean

Show validity period on card display

Defaulttrue

template?string

Template ID to derive badge and category from

Formatuuid

variant_options?array<>

Variant option IDs to assign to this item (default locale only).

Response Body

`application/json`

curl -X POST "https://app.orbiqhq.com/api/v1/certifications" \  -H "Authorization: Bearer $ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{  "title": "ISO 27001",  "description": "Information security management certification",  "issue_date": "2025-01-15"}'

{  "success": true,  "data": {    "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",    "uploadUrls": {      "document": "string",      "badge": "string"    }  }}

How is this guide?

Authorization

Request Body

Response Body

201application/json

400application/json

401

409application/json

500

`application/json`

`application/json`

`application/json`