Skip to main content
GET
View Credential

Description

Returns one credential and its current status. Drafts work too. POST works too.

Headers

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

Path Parameters

string
required
ID of the credential.

Success Response Fields

boolean
true when the credential was found.
string
ID of the credential.
string
Public page of the credential.
object
The recipient’s name and email.
object
The group’s title, key and code.
string
The issue date of the credential (ISO 8601, UTC). If no issue date was set, the time it was published or created.
string | null
When the credential expires (ISO 8601, UTC). null when it never expires.
object
The credential’s custom attribute values, such as {"custom_grade": "A"}.
string
The current status. Hyperstack checks these in order and gives the first that is true:
  • suspended: the credential is suspended.
  • expired: the expiry date has passed.
  • active: the credential is published.
  • revoked: the credential is revoked.
  • unpublished: a draft, or still being published.
string
"public" or "private".
string
Only for a credential that has a language: its code, such as fr. An automatic credential has no language field.
array
The evidence that the public credential page shows: your items, then the recipient’s items that are not hidden. Each item has the item fields id, kind, title, narrative, url, host, href, file_name, file_type, file_size, by and hidden. A file’s href is its full address.The list is empty while the credential is unpublished, revoked or suspended, and when it has no evidence. To get every item, hidden ones too, use List evidence.

Responses

Last modified on November 12, 2026