Skip to main content
POST
/
v1
/
groups
/
new
Create Credential Group
curl --request POST \
  --url https://api.thehyperstack.com/v1/groups/new \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "certificate_template": "<string>",
  "badge_template": "<string>",
  "url": "<string>",
  "tags": {},
  "group_code": "<string>",
  "does_expire": true,
  "validity": 123,
  "blockchain": true
}
'
{
  "success": true,
  "group_key": "aBcDeFgHiJkL"
}

​
Description

This endpoint allows you to create a new credential group in Hyperstack. A credential group acts as a template container that organizes credentials by program or course.

​
Headers

​
Authorization
string
required
Bearer YOUR_API_TOKEN — obtainable from Hyperstack Dashboard → Settings → API Access

​
Body Parameters

​
title
string
required
Title of the credential group.
​
description
string
required
Description of the credential group.
​
certificate_template
string
required
The template key for the certificate. At least one of certificate_template or badge_template is required.
​
badge_template
string
required
The template key for the badge. At least one of certificate_template or badge_template is required.
​
url
string
required
External URL associated with the credential group.
​
tags
array[string]
required
Tags related to the credential group.
​
group_code
string
required
A human-readable code for the group (e.g. CERT-2024). Alphanumeric, hyphens, and spaces only. Auto-generated if not provided.
​
does_expire
boolean
required
Indicates whether credentials in this group expire. Defaults to false.
​
validity
number
required
Validity period (in years) if does_expire is true.
​
blockchain
boolean
required
Enables decentralized blockchain anchoring for credentials. Defaults to false.

​
Success Response Fields

​
success
boolean
Indicates whether the group creation was successful. Always true for a 200 response.
​
group_key
string
The unique key (ID) assigned to the newly created credential group.

​
Responses

{
  "success": true,
  "group_key": "aBcDeFgHiJkL"
}

curl -X POST "https://api.thehyperstack.com/v1/groups/new" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Course Completion Certificate",
    "description": "Awarded upon successful completion of the course.",
    "certificate_template": "abcdefg",
    "badge_template": "xyz",
    "url": "https://acme.com/course",
    "tags": ["apple", "mango", "orange"],
    "group_code": "CERT-2024",
    "does_expire": true,
    "validity": 1,
    "blockchain": true
  }'
Last modified on February 22, 2026