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.

Note: 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 to get a credentialTypeID for the endpoint. See also PingOne Credentials, especially Credential Types.

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/credentialTypes/fdec0a97-5d61-426c-8a38-caffaeb63559"}},"id":"fdec0a97-5d61-426c-8a38-caffaeb63559","createdAt":"2024-03-20T13:08:51.406Z","updatedAt":"2024-03-20T13:08:51.406Z","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"issuer":{"id":"824c722c-254a-4b2d-9b50-17e2abdf5f8a"},"management":{"mode":"AUTOMATED"},"title":"Wallet Developers","description":"PingOne Credentials","cardType":"Driver License","uri":"https://api.pingone.com/v1/distributedid/credentialTypes/fdec0a97-5d61-426c-8a38-caffaeb63559","version":{"number":1,"uri":"https://api.pingone.com/v1/distributedid/credentialTypes/fdec0a97-5d61-426c-8a38-caffaeb63559/v1"},"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 -\u003e Logo","title":"Logo","isVisible":true,"type":"Alphanumeric Text","value":"R0lGODlhIAAgAPEAAAAAAAAAM8wzMwAAACH/C05FVFNDQVBFMi4wAwEAAAAh/jpQaW5neSBQaW5neSBQaW5neSBQaW5neQpQSU5HWSBQSU5HWSBQSU5HWSAKUElOR1lQSU5HWVBJTkdZACH5BAkKAAEALAAAAAAgACAAAAKDjI+py+0Po5wSiIuzFtPufx0Z44GbOCbAyrauG2jLS8OxrAo1zd0pYuHpXJyQw0PMsH6Nkgn30D0vK0xE+lwaowHnprVVhEJejbYnTpXNTAR0DWK8p22U1QD/oOzo7vPG1+dwYjAGxbUQJyHodjgYluD4eJdGYSJmqUgRqbnp+QkaUAAAOw==","required":false},{"id":"Directory Attribute -\u003e Street Address","title":"Street Address","isVisible":true,"type":"Directory Attribute","attribute":"streetAddress","required":true},{"id":"Directory Attribute -\u003e City","title":"City","isVisible":true,"type":"Directory Attribute","attribute":"locality","required":true},{"id":"Directory Attribute -\u003e State","title":"State","isVisible":true,"type":"Directory Attribute","attribute":"region","required":true},{"id":"Directory Attribute -\u003e Zip Code","title":"Zip Code","isVisible":true,"type":"Directory Attribute","attribute":"postalCode","required":true},{"id":"Directory Attribute -\u003e User Photo Base64","title":"User Photo Base64","isVisible":true,"type":"Directory Attribute","attribute":"image.href","fileSupport":"BASE64_STRING","required":true},{"id":"Directory Attribute -\u003e User Photo","title":"User Photo","isVisible":true,"type":"Directory Attribute","attribute":"image.href","fileSupport":"INCLUDE_FILE","required":true},{"id":"Directory Attribute -\u003e User Photo Reference","title":"User Photo Reference","isVisible":true,"type":"Directory Attribute","attribute":"image.href","fileSupport":"REFERENCE_FILE","required":true}],"version":5},"cardDesignTemplate":"\u003csvg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 740 480\"\u003e\u003cg\u003e\u003crect fill=\"none\" width=\"736\" height=\"476\" stroke=\"#808993\" stroke-width=\"3\" rx=\"10\" ry=\"10\" x=\"2\" y=\"2\"\u003e\u003c/rect\u003e\u003crect fill=\"${cardColor}\" height=\"476\" rx=\"10\" ry=\"10\" width=\"736\" x=\"2\" y=\"2\"\u003e\u003c/rect\u003e\u003cimage href=\"${backgroundImage}\" opacity=\"${bgOpacityPercent}\" height=\"476\" rx=\"10\" ry=\"10\" width=\"736\" x=\"2\" y=\"2\"\u003e\u003c/image\u003e\u003ctext fill=\"${textColor}\" font-weight=\"450\" font-size=\"30\" x=\"160\" y=\"80\"\u003e${cardTitle}\u003c/text\u003e\u003ctext fill=\"${textColor}\" font-size=\"25\" font-weight=\"300\" x=\"160\" y=\"120\"\u003e${cardSubtitle}\u003c/text\u003e\u003cimage href=\"${logoImage}\" x=\"42\" y=\"43\" height=\"90px\" width=\"90px\"\u003e\u003c/image\u003e\u003cline xmlns=\"http://www.w3.org/2000/svg\" y2=\"160\" x2=\"695\" y1=\"160\" x1=\"42.5\" stroke=\"#808993\"\u003e\u003c/line\u003e\u003cimage href=\"data:image/jpeg;base64,${fields[0].value}\" x=\"42.5\" y=\"180\" rx=\"80px\" ry=\"80px\" height=\"130px\" width=\"130px\"\u003e\u003c/image\u003e\u003ctext fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"230\"\u003e${fields[1].title}: ${fields[1].value}\u003c/text\u003e\u003ctext fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"272\"\u003e${fields[2].title}: ${fields[2].value}\u003c/text\u003e\u003ctext fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"314\"\u003e${fields[3].title}: ${fields[3].value}\u003c/text\u003e\u003ctext fill=\"${textColor}\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"356\"\u003e${fields[4].title}: ${fields[4].value}\u003c/text\u003e\u003c/g\u003e\u003c/svg\u003e","onDelete":{"revokeIssuedCredentials":true}}