View Credential

curl --request GET \
  --url https://api.thehyperstack.com/v1/credential/{document_id}/view

const options = {method: 'GET'};

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",
]);

$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)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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)

response = http.request(request)
puts response.read_body

{
  "success": true,
  "document_id": "j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
  "document_url": "https://hyperstack.id/credential/j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
  "recipient": { "name": "John Doe", "email": "john@example.com" },
  "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"
}

{
  "success": false,
  "error": "Document does not exists in your account"
}

{
  "detail": "Invalid token or organization not found"
}

GET

credential

{document_id}

view

View Credential

curl --request GET \
  --url https://api.thehyperstack.com/v1/credential/{document_id}/view

const options = {method: 'GET'};

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",
]);

$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)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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)

response = http.request(request)
puts response.read_body

{
  "success": true,
  "document_id": "j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
  "document_url": "https://hyperstack.id/credential/j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
  "recipient": { "name": "John Doe", "email": "john@example.com" },
  "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"
}

{
  "success": false,
  "error": "Document does not exists in your account"
}

{
  "detail": "Invalid token or organization not found"
}

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

string

required

Bearer YOUR_API_TOKEN — obtainable from Hyperstack Dashboard → Settings → API Access

Path Parameters

string

required

The unique ID (key) of the credential to retrieve.

Success Response Fields

boolean

Indicates whether the credential retrieval was successful.

string

The unique ID of the credential.

string

The URL where the credential can be accessed.

object

Object containing name and email of the recipient.

object

Object containing title, key, and code of the credential group.

string

ISO 8601 timestamp of when the credential was issued.

string

ISO 8601 expiry timestamp. null if the credential does not expire.

object

Custom attribute values stored with the credential.

string

The current status of the credential. Possible values: "active", "suspended", "expired", "revoked", "unpublished".

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": "john@example.com" },
  "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"
}

{
  "success": false,
  "error": "Document does not exists in your account"
}

{
  "detail": "Invalid token or organization not found"
}

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

API Guide

Credential Groups

Credentials

Recipients

Webhooks

View Credential

Description

Headers

Path Parameters

Success Response Fields

Responses

​Description

​Headers

​Path Parameters

​Success Response Fields

​Responses

Description

Headers

Path Parameters

Success Response Fields

Responses