PingOne Platform APIs

Read One Credential Type

     

GET {{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}

Use the GET {{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}} operation to return the specified type of credential available for issuance. A credential type corresponds to a card type presented by the compatible wallet app.

Delete a Credential Type performs a soft delete. That is, the credential type is marked as deleted but is not removed. This permits credentials issued to user wallets to reference the now-deleted credential type without failure. After deletion, the credential type can be queried with this request, which returns in its body deletedAt with the timestamp of its deletion.

Prerequisites

Create a credential type (automated) or Create a credential type (managed) to get a credentialTypeID for the endpoint. Refer also to Credential Types.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}")
{
  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}}"
  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}} 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}}")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/credentialTypes/{{credentialTypeID}}",
  "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}}',
  '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}}"

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}}');
$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}}")

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}}")!,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/10acdfe3-f0e9-42f3-b64b-fc2bed22fe7b"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "credentialIssuerProfile": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialIssuerProfile"
        },
        "issuanceRules": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/10acdfe3-f0e9-42f3-b64b-fc2bed22fe7b/issuanceRules"
        }
    },
    "id": "10acdfe3-f0e9-42f3-b64b-fc2bed22fe7b",
    "createdAt": "2025-05-12T19:44:02.569Z",
    "updatedAt": "2025-05-12T19:44:50.192Z",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "issuer": {
        "id": "913c21bb-0570-426b-97c4-e4d56e8861a5"
    },
    "management": {
        "mode": "AUTOMATED"
    },
    "title": "Wallet Developers",
    "description": "PingOne Credentials",
    "cardType": "Driver License",
    "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/10acdfe3-f0e9-42f3-b64b-fc2bed22fe7b",
    "version": {
        "number": 1,
        "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/10acdfe3-f0e9-42f3-b64b-fc2bed22fe7b/v1",
        "id": "ea3f5903-75ca-4280-91e8-a53811d7a282"
    },
    "metadata": {
        "name": "Wallet Developers",
        "description": "PingOne Credentials",
        "textColor": "#000000",
        "cardColor": "#FFFFFF",
        "backgroundImage": "data:image/jpeg;base64,R0lGODlhIAAgAPEAAAAAAAAAM8wzMwAAACH/C05FVFNDQVBFMi4wAwEAAAAh+QQJCgABACwAAAAAIAAgAAACc4yPqcvtD6OcNIiLsxZg7o91EgiKShYA6sq27Ymm7swumsHRLgfHOXuZ8RKkn6YVHBU3pscRUIRGntDSxSJoZICfzoZBLWFjvRBJdLMtQ4d0edkkE9dJDz1bQXzyNiK/1/bXRoaRd2d4SHGHJ0gi+Ai5UAAAOw==",
        "logoImage": "",
        "bgOpacityPercent": 20,
        "fields": [
            {
                "id": "Alphanumeric Text -> Logo",
                "title": "Logo",
                "isVisible": true,
                "type": "Alphanumeric Text",
                "value": "R0lGODlhIAAgAPEAAAAAAAAAM8wzMwAAACH/C05FVFNDQVBFMi4wAwEAAAAh/jpQaW5neSBQaW5neSBQaW5neSBQaW5neQpQSU5HWSBQSU5HWSBQSU5HWSAKUElOR1lQSU5HWVBJTkdZACH5BAkKAAEALAAAAAAgACAAAAKDjI+py+0Po5wSiIuzFtPufx0Z44GbOCbAyrauG2jLS8OxrAo1zd0pYuHpXJyQw0PMsH6Nkgn30D0vK0xE+lwaowHnprVVhEJejbYnTpXNTAR0DWK8p22U1QD/oOzo7vPG1+dwYjAGxbUQJyHodjgYluD4eJdGYSJmqUgRqbnp+QkaUAAAOw==",
                "required": false
            },
            {
                "id": "Directory Attribute -> Street Address",
                "title": "Street Address",
                "isVisible": true,
                "type": "Directory Attribute",
                "attribute": "streetAddress",
                "required": true
            },
            {
                "id": "Directory Attribute -> City",
                "title": "City",
                "isVisible": true,
                "type": "Directory Attribute",
                "attribute": "locality",
                "required": true
            },
            {
                "id": "Directory Attribute -> State",
                "title": "State",
                "isVisible": true,
                "type": "Directory Attribute",
                "attribute": "region",
                "required": true
            },
            {
                "id": "Directory Attribute -> Zip Code",
                "title": "Zip Code",
                "isVisible": true,
                "type": "Directory Attribute",
                "attribute": "postalCode",
                "required": true
            },
            {
                "id": "Directory Attribute -> User Photo Base64",
                "title": "User Photo Base64",
                "isVisible": true,
                "type": "Directory Attribute",
                "attribute": "image.href",
                "fileSupport": "BASE64_STRING",
                "required": true
            },
            {
                "id": "Directory Attribute -> User Photo",
                "title": "User Photo",
                "isVisible": true,
                "type": "Directory Attribute",
                "attribute": "image.href",
                "fileSupport": "INCLUDE_FILE",
                "required": true
            },
            {
                "id": "Directory Attribute -> User Photo Reference",
                "title": "User Photo Reference",
                "isVisible": true,
                "type": "Directory Attribute",
                "attribute": "image.href",
                "fileSupport": "REFERENCE_FILE",
                "required": true
            }
        ],
        "version": 5
    },
    "deletedAt": "2025-05-12T19:44:50.192Z",
    "cardDesignTemplate": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 740 480\"><g><rect fill=\"none\" width=\"736\" height=\"476\" stroke=\"#808993\" stroke-width=\"3\" rx=\"10\" ry=\"10\" x=\"2\" y=\"2\"></rect><rect fill=\"${cardColor}\" height=\"476\" rx=\"10\" ry=\"10\" width=\"736\" x=\"2\" y=\"2\"></rect><image href=\"${backgroundImage}\" opacity=\"${bgOpacityPercent}\" height=\"476\" rx=\"10\" ry=\"10\" width=\"736\" x=\"2\" y=\"2\"></image><text fill=\"${textColor}\" font-weight=\"450\" font-size=\"30\" x=\"160\" y=\"80\">${cardTitle}</text><text fill=\"${textColor}\" font-size=\"25\" font-weight=\"300\" x=\"160\" y=\"120\">${cardSubtitle}</text><image href=\"${logoImage}\" x=\"42\" y=\"43\" height=\"90px\" width=\"90px\"></image><line xmlns=\"http://www.w3.org/2000/svg\" y2=\"160\" x2=\"695\" y1=\"160\" x1=\"42.5\" stroke=\"#808993\"></line><image href=\"data:image/jpeg;base64,${fields[0].value}\" x=\"42.5\" y=\"180\" rx=\"80px\" ry=\"80px\" height=\"130px\" width=\"130px\"></image><text fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"230\">${fields[1].title}: ${fields[1].value}</text><text fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"272\">${fields[2].title}: ${fields[2].value}</text><text fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"314\">${fields[3].title}: ${fields[3].value}</text><text fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"356\">${fields[4].title}: ${fields[4].value}</text></g></svg>",
    "onDelete": {
        "revokeIssuedCredentials": true
    },
    "expiration": {
        "type": "HARD",
        "after": {
            "duration": 1826,
            "timeUnit": "DAYS"
        }
    }
}