Read Credential Verification Credential Data
GET {{apiPath}}/environments/{{envID}}/presentationSessions/{{credentialVerificationID}}/credentialData
Use the GET {{apiPath}}/environments/{{envID}}/presentationSessions/{{credentialVerificationID}}/credentialData
request to return the credential data of the credential from the specified verification of a credential.
Note: If a credential has not yet been shared, when status
is INITIAL
or WAITING
, then credentialData.data
returns as an empty array.
Prerequisites
Create Credential Verification Presentation Session (OPENID4VP) or Create Credential Verification Presentation Session (NATIVE) to get a credentialVerificationID
for the endpoint. See also PingOne Credentials, especially Credential Verifications.
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/presentationSessions/31cf41d7-2440-4dd8-b3b0-1bbf3dff135a/credentialData"}},"id":"108b8e45-f5db-4d9c-8c2f-2c4b98abfbc5","status":"VERIFICATION_SUCCESSFUL","applicationInstance":{"id":"0a75a85a-f7d1-4d69-91ec-ed0e663989a4"},"credentialData":[{"type":"VerifiedEmployee","data":[{"key":"CardImage","value":"\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=\"#FFFFFF\" height=\"476\" rx=\"10\" ry=\"10\" width=\"736\" x=\"2\" y=\"2\"\u003e\u003c/rect\u003e\u003cimage href=\"\" opacity=\"20\" height=\"476\" rx=\"10\" ry=\"10\" width=\"736\" x=\"2\" y=\"2\"\u003e\u003c/image\u003e\u003ctext fill=\"#000000\" font-weight=\"450\" font-size=\"30\" x=\"160\" y=\"80\"\u003eVerifiedEmployee\u003c/text\u003e\u003ctext fill=\"#000000\" font-size=\"25\" font-weight=\"300\" x=\"160\" y=\"120\"\u003eWorkplace Credential for interoperability - v2\u003c/text\u003e\u003cimage href=\"\" 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\u003ctext fill=\"#000000\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"230\"\u003edisplayName: Gaurav Khot\u003c/text\u003e\u003ctext fill=\"#000000\" font-weight=\"500\" font-size=\"20\" x=\"190\" y=\"272\"\u003egivenName: Gaurav\u003c/text\u003e\u003c/g\u003e\u003c/svg\u003e"},{"key":"displayName","value":"John Doe"},{"key":"givenName","value":"John"},{"key":"mail","value":"johndoe@example.com"},{"key":"surname","value":"Doe"}],"issuerId":"9536b3bf-556c-4ed5-a357-5da900ce17d1","issuerName":"Issuer Name","issuerLogo":"R0lGODlhIAAgAPEAAAAAAAAAM8wzMwAAACH/C05FVFNDQVBFMi4wAwEAAAAh/jpQaW5neSBQaW5neSBQaW5neSBQaW5neQpQSU5HWSBQSU5HWSBQSU5HWSAKUElOR1lQSU5HWVBJTkdZACH5BAkKAAEALAAAAAAgACAAAAKDjI+py+0Po5wSiIuzFtPufx0Z44GbOCbAyrauG2jLS8OxrAo1zd0pYuHpXJyQw0PMsH6Nkgn30D0vK0xE+lwaowHnprVVhEJejbYnTpXNTAR0DWK8p22U1QD/oOzo7vPG1+dwYjAGxbUQJyHodjgYluD4eJdGYSJmqUgRqbnp+QkaUAAAOw=="}]}