Skip to main content
POST
Issue certificate or badge

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Xerobi-Version
string
required

API version in YYYY-MM-DD format

Example:

"2026-01-01"

Body

application/json

Request payload for issuing a new credential

recipient
object
required

Information about the credential recipient

template_id
string
required

ID of the template to use for this credential

Example:

"tmpl_1234567890abcdef"

metadata
object

Additional custom data to include with the credential

Example:
expire_at
string<date-time> | null

Optional expiration date for the credential

Example:

"2028-12-01T00:00:00Z"

Response

Credential issued successfully

Response containing issued credential information

id
string

Unique identifier for the issued credential

Example:

"cred_1234567890abcdef"

status
enum<string>

Current status of the credential

Available options:
issued,
revoked
Example:

"issued"

verify_url
string<uri>

Public URL for verifying this credential

Example:

"https://verify.hixbe.com/cred_1234567890abcdef"