Skip to main content
POST
https://api.thehyperstack.com
/
v1
/
credentials
/
generate
Generate Credential (Draft)
curl --request POST \
  --url https://api.thehyperstack.com/v1/credentials/generate \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient": {},
  "recipient.name": "<string>",
  "recipient.email": "<string>",
  "group_key": "<string>",
  "custom_attributes": {}
}
'
{
  "success": true,
  "status": "draft",
  "document_id": "j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
  "document_url": "https://hyperstack.id/credential/j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
  "recipient": { "name": "John Doe", "email": "[email protected]" },
  "group": { "title": "Cloud Certification", "key": "GcI6H5b66a3v", "code": "CC-2024" },
  "issued_on": "2024-03-15T10:30:00Z",
  "valid_until": null,
  "metadata": { "custom_location": "Mars" },
  "privacy": "public"
}

​
Description

This endpoint allows you to create a credential in draft state without immediately publishing it. The credential can be reviewed and published later using the Publish Credential endpoint.

​
Headers

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

​
Body Parameters

​
recipient
object
required
Information about the recipient of the credential.
​
recipient.name
string
required
Full name of the recipient.
​
recipient.email
string
required
Email address of the recipient.
​
group_key
string
required
The unique key of the credential group in which this credential will be generated.
​
custom_attributes
object
required
Key-value pairs of custom attributes to embed in the credential. Keys must match the custom fields (prefixed with custom_) configured for your account.

​
Success Response Fields

​
success
boolean
Indicates whether the credential was successfully generated.
​
document_id
string
The unique ID of the newly created draft credential.
​
document_url
string
URL where the credential will be accessible once published.
​
status
string
Publication status of the credential. Will be "draft" for this endpoint.
​
recipient
object
Object containing name and email of the recipient.
​
group
object
Object containing title, key, and code of the credential group.
​
issued_on
string
ISO 8601 timestamp of when the credential record was created.
​
valid_until
string
ISO 8601 expiry timestamp. null if the credential does not expire.
​
metadata
object
Custom attribute values stored with the credential.
​
privacy
string
Visibility of the credential — "public" or "private".

​
Responses

{
  "success": true,
  "status": "draft",
  "document_id": "j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
  "document_url": "https://hyperstack.id/credential/j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
  "recipient": { "name": "John Doe", "email": "[email protected]" },
  "group": { "title": "Cloud Certification", "key": "GcI6H5b66a3v", "code": "CC-2024" },
  "issued_on": "2024-03-15T10:30:00Z",
  "valid_until": null,
  "metadata": { "custom_location": "Mars" },
  "privacy": "public"
}

curl -X POST "https://api.thehyperstack.com/v1/credentials/generate" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": {
      "name": "John Doe",
      "email": "[email protected]"
    },
    "group_key": "GcI6H5b66a3v",
    "custom_attributes": {
      "custom_location": "Mars"
    }
  }'
Last modified on February 22, 2026