Read One Credential Type Version
GET {{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}
Use the GET {{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}} operation to return the specified version of the specified type of credential available for issuance. A credential type corresponds to a card type presented by the compatible wallet app.
Prerequisites
Create Credential Type (automated) or Create Credential Type (managed) to get a credentialTypeID for the endpoint. Refer also to Credential Types.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Bearer {{accessToken}}")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
GET /environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}} HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}")
.method("GET", body)
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}",
"method": "GET",
"timeout": 0,
"headers": {
"Authorization": "Bearer {{accessToken}}"
},
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'GET',
'url': '{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}',
'headers': {
'Authorization': 'Bearer {{accessToken}}'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}"
payload = {}
headers = {
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Authorization' => 'Bearer {{accessToken}}'
));
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "net/http"
url = URI("{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"
response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}/versions/{{credentialTypeVersionID}}")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "GET"
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
200 OK
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/41fc9049-f742-4d5f-8950-e343ade4a48a/versions/21f184c3-c21a-4907-80a8-5749d9b6b960"
}
},
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"credentialType": {
"id": "41fc9049-f742-4d5f-8950-e343ade4a48a"
},
"version": 1,
"snapshot": {
"id": "41fc9049-f742-4d5f-8950-e343ade4a48a",
"createdAt": "2025-02-28T20:48:10.792726159Z",
"updatedAt": "2025-02-28T20:48:10.792726159Z",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"issuer": {
"id": "824c722c-254a-4b2d-9b50-17e2abdf5f8a"
},
"management": {
"mode": "MANAGED"
},
"title": "Title",
"description": "Subtitle",
"cardType": "Title",
"uri": "https://api.pingone.com/v1/distributedid/credentialTypes/41fc9049-f742-4d5f-8950-e343ade4a48a",
"version": {
"number": 1,
"uri": "https://api.pingone.com/v1/distributedid/credentialTypes/41fc9049-f742-4d5f-8950-e343ade4a48a/v1",
"id": "21f184c3-c21a-4907-80a8-5749d9b6b960"
},
"metadata": {
"name": "Alphanumeric Text Example",
"description": "Alphanumeric Text Attribute",
"textColor": "#253746",
"cardColor": "#9997bf",
"backgroundImage": "",
"logoImage": "",
"bgOpacityPercent": 20,
"fields": [
{
"id": "Alphanumeric Text -> Account",
"title": "Account",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "Value",
"required": true
},
{
"id": "Alphanumeric Text -> Name",
"title": "Name",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "Value",
"required": true
},
{
"id": "Alphanumeric Text -> Number",
"title": "Number",
"isVisible": true,
"type": "Alphanumeric Text",
"value": "Value",
"required": true
}
],
"version": 4
},
"onDelete": {
"revokeIssuedCredentials": true
},
"visualizationTemplateData": {
"showTitle": true,
"displayFields": [
{
"showFieldName": false,
"dataFieldName": "Account"
},
{
"showFieldName": false,
"dataFieldName": "Name"
}
]
}
},
"id": "21f184c3-c21a-4907-80a8-5749d9b6b960",
"createdAt": "2025-02-28T20:48:10.792Z"
}