Skip to main content
POST
Issue Credential

Description

Issues a credential to a recipient in a credential group, and publishes it at once. Publishing runs in the background and takes a few seconds. When it is done, the recipient gets an email (unless the group’s notifications are off), and Hyperstack sends a credential.issued webhook if you subscribed to one. Publishing may use a credit. A recipient already covered by a credit uses none. The legacy path POST /v1/credential/issue does the same. To create a credential without publishing it, use Generate Credential.

Headers

string
required
Your API key: Bearer YOUR_API_KEY. Create a key in the Studio under Settings → Developers.

Body Parameters

object
required
Who gets the credential.
string
required
Key of the group to issue the credential in.
object
Values for your custom attributes, such as {"custom_grade": "A"}. Each key is the merge tag of an attribute, without brackets. You find them in the Studio under Settings → Attributes.Only attributes whose value belongs to Each credential are saved. Other keys are ignored. Values are saved as text.
array[object]
Optional evidence for the new credential: up to 10 items, each a link or a text. Files can’t be sent here: add them afterwards with Add evidence.Needs credential evidence on your plan (Premium or Enterprise). Without it, the call returns 403 with feature_unavailable. Every item is checked first: if one is not valid, the call returns an error such as invalid_url, and no credential is made. More than 10 items returns 403 with limit_items.
string
The credential’s language: one of your organization’s languages (its default language and its More languages in Settings → Language). Send a code such as fr, or a language’s name in English or in itself, such as French or Français. Any case works.Its email goes in this language when the group’s email template has a translation in it. Its LinkedIn title, Open Badges name and description, and the group text on its design use the group’s translation in it.Optional. Leave it out, or send null or "", for automatic: Hyperstack picks the language as it does for credentials issued in the Studio. Any other value, or a language that isn’t one of your organization’s, returns 400 with invalid_language, and no credential is made.

Success Response Fields

boolean
true when the credential was created.
string
"published": the credential is being published. To see when it is live, call View Credential and look for the status active.
string
ID of the new credential. Use it in the other credential endpoints.
string
Public page of the credential.
object
The recipient’s name and email, as saved.
object
The group’s title, key and code.
string
When the credential was created (ISO 8601, UTC).
string | null
null in this response. If the group’s credentials expire, the expiry date is set when the credential is published.
object
The custom attribute values that were saved.
string
"public" or "private", from the group’s settings.
array
Only when you sent evidence: the items added, in the shape of the evidence item fields.
string
Only when you sent language: the language’s code, such as fr.

Responses

By default a group allows one credential per recipient email, and a second one returns 409. To allow more, change the group’s settings in the Studio.
Last modified on November 13, 2026