PingOne Platform APIs

Read All Credential Types

     

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

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

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

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

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

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")!,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"
        }
    },
    "_embedded": {
        "items": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/39b671c7-3acf-4eee-a6b5-2da589fa520c"
                    }
                },
                "id": "39b671c7-3acf-4eee-a6b5-2da589fa520c",
                "createdAt": "2024-01-29T17:12:50.722Z",
                "updatedAt": "2024-01-29T17:12:50.722Z",
                "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/39b671c7-3acf-4eee-a6b5-2da589fa520c",
                "version": {
                    "number": 1,
                    "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/39b671c7-3acf-4eee-a6b5-2da589fa520c/v1",
                    "id": "85ab7fe8-a94d-4496-a2f9-c1e989c17240"
                },
                "onDelete": {
                    "revokeIssuedCredentials": true
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/4a2a418b-8588-47fd-82fc-931948af52dc"
                    }
                },
                "id": "4a2a418b-8588-47fd-82fc-931948af52dc",
                "createdAt": "2025-02-20T15:55:42.021Z",
                "updatedAt": "2025-02-20T15:55:42.021Z",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "issuer": {
                    "id": "913c21bb-0570-426b-97c4-e4d56e8861a5"
                },
                "management": {
                    "mode": "MANAGED"
                },
                "title": "Card Developers",
                "description": "PingOne Credentials",
                "cardType": "Card Developers",
                "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/4a2a418b-8588-47fd-82fc-931948af52dc",
                "version": {
                    "number": 1,
                    "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/4a2a418b-8588-47fd-82fc-931948af52dc/v1",
                    "id": "24b4a23e-dc8f-4eb1-b46a-d1d8e6d9eb25"
                },
                "onDelete": {
                    "revokeIssuedCredentials": true
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/6d20e9c2-9102-42d1-a1fc-74eed31d65d8"
                    }
                },
                "id": "6d20e9c2-9102-42d1-a1fc-74eed31d65d8",
                "createdAt": "2023-03-15T13:00:44.875Z",
                "updatedAt": "2023-03-15T13:12:22.670Z",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "issuer": {
                    "id": "913c21bb-0570-426b-97c4-e4d56e8861a5"
                },
                "management": {
                    "mode": "AUTOMATED"
                },
                "title": "Credential type title",
                "description": "Credential type description",
                "cardType": "Credential type title",
                "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/6d20e9c2-9102-42d1-a1fc-74eed31d65d8",
                "version": {
                    "number": 1,
                    "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/6d20e9c2-9102-42d1-a1fc-74eed31d65d8/v1",
                    "id": "72eca36e-1168-4ffa-83e1-0594bc6355fe"
                },
                "onDelete": {
                    "revokeIssuedCredentials": true
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/7c87f18a-32f5-4e3a-8d48-8ce19f412d39"
                    }
                },
                "id": "7c87f18a-32f5-4e3a-8d48-8ce19f412d39",
                "createdAt": "2023-03-15T15:23:42.450Z",
                "updatedAt": "2023-03-15T15:25:00.417Z",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "issuer": {
                    "id": "913c21bb-0570-426b-97c4-e4d56e8861a5"
                },
                "management": {
                    "mode": "AUTOMATED"
                },
                "title": "Credential type title",
                "description": "Credential type description",
                "cardType": "Credential type title",
                "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/7c87f18a-32f5-4e3a-8d48-8ce19f412d39",
                "version": {
                    "number": 1,
                    "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/7c87f18a-32f5-4e3a-8d48-8ce19f412d39/v1",
                    "id": "d9dc2f2f-41dd-47c6-8e47-39f2bf3134ce"
                },
                "onDelete": {
                    "revokeIssuedCredentials": true
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/a71a9664-5cb1-40bd-8393-701ef26a7e2b"
                    }
                },
                "id": "a71a9664-5cb1-40bd-8393-701ef26a7e2b",
                "createdAt": "2023-01-25T20:09:44.540Z",
                "updatedAt": "2023-01-25T20:09:44.540Z",
                "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/a71a9664-5cb1-40bd-8393-701ef26a7e2b",
                "version": {
                    "number": 1,
                    "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/a71a9664-5cb1-40bd-8393-701ef26a7e2b/v1",
                    "id": "264fb2db-44af-40c5-b83e-10b104713ee1"
                },
                "onDelete": {
                    "revokeIssuedCredentials": true
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/bddcb95d-9019-4110-ad45-6f7167b299ea"
                    }
                },
                "id": "bddcb95d-9019-4110-ad45-6f7167b299ea",
                "createdAt": "2025-02-20T15:49:23.669Z",
                "updatedAt": "2025-02-20T15:49:23.669Z",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "issuer": {
                    "id": "913c21bb-0570-426b-97c4-e4d56e8861a5"
                },
                "management": {
                    "mode": "MANAGED"
                },
                "title": "Card Developers",
                "description": "PingOne Credentials",
                "cardType": "Card Developers",
                "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/bddcb95d-9019-4110-ad45-6f7167b299ea",
                "version": {
                    "number": 1,
                    "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/bddcb95d-9019-4110-ad45-6f7167b299ea/v1",
                    "id": "3a99f7cc-e09f-4f6c-9def-5f04cb3c95a8"
                },
                "onDelete": {
                    "revokeIssuedCredentials": true
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/e2b12b1e-6f41-43e9-b491-43970bed83fe"
                    }
                },
                "id": "e2b12b1e-6f41-43e9-b491-43970bed83fe",
                "createdAt": "2023-07-27T14:04:22.133Z",
                "updatedAt": "2023-07-27T14:04:22.133Z",
                "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/e2b12b1e-6f41-43e9-b491-43970bed83fe",
                "version": {
                    "number": 1,
                    "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/e2b12b1e-6f41-43e9-b491-43970bed83fe/v1",
                    "id": "e2b833c3-c87e-4df2-a769-436f68fb438a"
                },
                "onDelete": {
                    "revokeIssuedCredentials": true
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/edc25883-a7f8-44e3-83eb-3c15a7b58de4"
                    }
                },
                "id": "edc25883-a7f8-44e3-83eb-3c15a7b58de4",
                "createdAt": "2024-01-29T17:31:22.722Z",
                "updatedAt": "2024-03-29T13:50:24.059Z",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "issuer": {
                    "id": "913c21bb-0570-426b-97c4-e4d56e8861a5"
                },
                "management": {
                    "mode": "MANAGED"
                },
                "title": "Card Developers",
                "description": "PingOne Credentials",
                "cardType": "Card Developers",
                "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/edc25883-a7f8-44e3-83eb-3c15a7b58de4",
                "version": {
                    "number": 1,
                    "uri": "https://api.pingone.com/v1/distributedid/credentialTypes/edc25883-a7f8-44e3-83eb-3c15a7b58de4/v1",
                    "id": "1e8af218-e8be-426f-ba67-2b86db3190a7"
                },
                "onDelete": {
                    "revokeIssuedCredentials": true
                }
            }
        ]
    },
    "size": 8
}