View Credential
curl --request GET \
--url https://api.thehyperstack.com/v1/credential/{document_id}/view \
--header 'Authorization: <authorization>'import requests
url = "https://api.thehyperstack.com/v1/credential/{document_id}/view"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.thehyperstack.com/v1/credential/{document_id}/view', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.thehyperstack.com/v1/credential/{document_id}/view",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.thehyperstack.com/v1/credential/{document_id}/view"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.thehyperstack.com/v1/credential/{document_id}/view")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.thehyperstack.com/v1/credential/{document_id}/view")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"success": true,
"document_id": "6f1c2a8e-3b4d-4e5f-9a7b-1c2d3e4f5a6b",
"document_url": "https://hyperstack.id/credential/6f1c2a8e-3b4d-4e5f-9a7b-1c2d3e4f5a6b",
"recipient": { "name": "Jane Doe", "email": "jane.doe@example.com" },
"group": { "title": "Cloud Security Fundamentals", "key": "Kq7Zp2LmX9aB", "code": "CSF-2026" },
"issued_on": "2026-03-15T10:30:04.903512Z",
"valid_until": "2028-03-15T10:30:04Z",
"metadata": { "custom_grade": "A" },
"status": "active",
"privacy": "public",
"evidence": [
{
"id": "k3T9vQx2LmP8sR4w",
"kind": "link",
"title": "Capstone project repo",
"narrative": "The app's code, with a README that explains how to run it.",
"url": "https://github.com/janedoe/stockroom",
"host": "github.com",
"href": "https://github.com/janedoe/stockroom",
"file_name": "",
"file_type": "",
"file_size": 0,
"by": "issuer",
"hidden": false
}
]
}
{
"success": false,
"error": "Document does not exists in your account"
}
{
"detail": "Invalid token or organization not found"
}
Credentials
View Credential
GET
/
v1
/
credential
/
{document_id}
/
view
View Credential
curl --request GET \
--url https://api.thehyperstack.com/v1/credential/{document_id}/view \
--header 'Authorization: <authorization>'import requests
url = "https://api.thehyperstack.com/v1/credential/{document_id}/view"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.thehyperstack.com/v1/credential/{document_id}/view', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.thehyperstack.com/v1/credential/{document_id}/view",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.thehyperstack.com/v1/credential/{document_id}/view"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.thehyperstack.com/v1/credential/{document_id}/view")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.thehyperstack.com/v1/credential/{document_id}/view")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"success": true,
"document_id": "6f1c2a8e-3b4d-4e5f-9a7b-1c2d3e4f5a6b",
"document_url": "https://hyperstack.id/credential/6f1c2a8e-3b4d-4e5f-9a7b-1c2d3e4f5a6b",
"recipient": { "name": "Jane Doe", "email": "jane.doe@example.com" },
"group": { "title": "Cloud Security Fundamentals", "key": "Kq7Zp2LmX9aB", "code": "CSF-2026" },
"issued_on": "2026-03-15T10:30:04.903512Z",
"valid_until": "2028-03-15T10:30:04Z",
"metadata": { "custom_grade": "A" },
"status": "active",
"privacy": "public",
"evidence": [
{
"id": "k3T9vQx2LmP8sR4w",
"kind": "link",
"title": "Capstone project repo",
"narrative": "The app's code, with a README that explains how to run it.",
"url": "https://github.com/janedoe/stockroom",
"host": "github.com",
"href": "https://github.com/janedoe/stockroom",
"file_name": "",
"file_type": "",
"file_size": 0,
"by": "issuer",
"hidden": false
}
]
}
{
"success": false,
"error": "Document does not exists in your account"
}
{
"detail": "Invalid token or organization not found"
}
Description
Returns one credential and its current status. Drafts work too.POST works too.
Headers
Your API key:
Bearer YOUR_API_KEY. Create a key in the Studio under Settings → Developers.Path Parameters
Success Response Fields
The issue date of the credential (ISO 8601, UTC). If no issue date was set, the time it was published or created.
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.
Only for a credential that has a language: its code, such as
fr. An automatic credential has no language field.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
{
"success": true,
"document_id": "6f1c2a8e-3b4d-4e5f-9a7b-1c2d3e4f5a6b",
"document_url": "https://hyperstack.id/credential/6f1c2a8e-3b4d-4e5f-9a7b-1c2d3e4f5a6b",
"recipient": { "name": "Jane Doe", "email": "jane.doe@example.com" },
"group": { "title": "Cloud Security Fundamentals", "key": "Kq7Zp2LmX9aB", "code": "CSF-2026" },
"issued_on": "2026-03-15T10:30:04.903512Z",
"valid_until": "2028-03-15T10:30:04Z",
"metadata": { "custom_grade": "A" },
"status": "active",
"privacy": "public",
"evidence": [
{
"id": "k3T9vQx2LmP8sR4w",
"kind": "link",
"title": "Capstone project repo",
"narrative": "The app's code, with a README that explains how to run it.",
"url": "https://github.com/janedoe/stockroom",
"host": "github.com",
"href": "https://github.com/janedoe/stockroom",
"file_name": "",
"file_type": "",
"file_size": 0,
"by": "issuer",
"hidden": false
}
]
}
{
"success": false,
"error": "Document does not exists in your account"
}
{
"detail": "Invalid token or organization not found"
}
curl "https://api.thehyperstack.com/v1/credential/6f1c2a8e-3b4d-4e5f-9a7b-1c2d3e4f5a6b/view" \
-H "Authorization: Bearer YOUR_API_KEY"
Last modified on November 12, 2026
Was this page helpful?

