Certifier API
Credentials

Update a credential

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.

PATCH
/v1/credentials/{id}

Use this endpoint to update a credential.

Authorization

BearerAuth
AuthorizationBearer <token>

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

Path Parameters

id*string

The unique ID of the credential

Header Parameters

Certifier-Version*string

API version header. Required for all requests.

Default"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

application/json

curl -X PATCH "https://example.com/v1/credentials/string" \  -H "Certifier-Version: 2022-10-26" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "publicId": "f72dfe8e-6cfd-43c2-b1cb-95adbf313789",  "groupId": "string",  "status": "draft",  "recipient": {    "id": "string",    "name": "string",    "email": "user@example.com"  },  "issueDate": "string",  "expiryDate": "string",  "attributes": {    "property1": null,    "property2": null  },  "customAttributes": {    "property1": null,    "property2": null  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Send a credential POST

Use this endpoint to send a published credential to a recipient. You can only send credentials with `status = "issued"`.

Delete a credential DELETE

Use this endpoint to permanently delete a credential. This cannot be undone.