Skip to main content
GET
https://api.thehyperstack.com
/
v1
/
credential
/
{document_id}
/
view
View Credential
curl --request GET \
  --url https://api.thehyperstack.com/v1/credential/{document_id}/view
{
  "success": true,
  "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" },
  "status": "active",
  "privacy": "public"
}

​
Description

This endpoint allows you to view an existing credential issued to a recipient. The credential key is passed as a URL path parameter.

​
Headers

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

​
Path Parameters

​
document_id
string
required
The unique ID (key) of the credential to retrieve.

​
Success Response Fields

​
success
boolean
Indicates whether the credential retrieval was successful.
​
document_id
string
The unique ID of the credential.
​
document_url
string
The URL where the credential can be accessed.
​
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 was issued.
​
valid_until
string
ISO 8601 expiry timestamp. null if the credential does not expire.
​
metadata
object
Custom attribute values stored with the credential.
​
status
string
The current status of the credential. Possible values: "active", "suspended", "expired", "revoked", "unpublished".
​
privacy
string
Visibility of the credential — "public" or "private".

​
Responses

{
  "success": true,
  "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" },
  "status": "active",
  "privacy": "public"
}

curl -X GET "https://api.thehyperstack.com/v1/credential/j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx/view" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
“status”: “active”, “privacy”: “public” }
Last modified on February 22, 2026