Create a credential interaction
Don't see what you need?
This API is still growing. If an endpoint, parameter, or filter you need isn't here yet — or you just have a question — tell us. We read every message and regularly add new capabilities based on real use cases from customers like you.
Creates a new credential interaction event.
If you are distributing the credential links independently and wish to track events as originating from the recipient, be sure to include the ?recipient=true parameter. Without this parameter, we won't be able to mark this person as the recipient, and their actions will be marked under the guest actor category.
This approach may not capture every scenario. For example, if a recipient opens a link with ?recipient=true on one device, then shares the link without the parameter (or opens it on a different device without the stored flag), those subsequent views will be categorized as guest. Similarly, if the user clears their LocalStorage or uses an incognito session, the system can no longer confirm that they are the recipient.
Authorization
BearerAuth Provide your access token in the Authorization header with Bearer auth-scheme. You can view and manage your access tokens in the Certifier Dashboard.
In: header
Header Parameters
API version header. Required for all requests.
"2022-10-26"Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/credential-interactions" \ -H "Certifier-Version: 2022-10-26" \ -H "Content-Type: application/json" \ -d '{ "credentialId": "string", "eventType": "credential_viewed", "triggeredBy": "recipient", "triggeredAt": "2019-08-24T14:15:22Z" }'{ "id": "string", "credentialId": "string", "eventType": "credential_viewed", "triggeredBy": "recipient", "triggeredAt": "2019-08-24T14:15:22Z"}