API Reference

The credential object

The sample object

{
    "id": "01hz2f0c9ryvzajg20jqh9taab",
    "publicId": "124a8110-1af5-4747-9308-e9d06bd1852a",
    "groupId": "3f9717d0ecd9f5202c1cb77c",
    "status": "draft",
    "recipient": {
        "name": "John Doe",
        "email": "john.doe@example.com"
    },
    "issueDate": "2022-01-01",
    "expiryDate": "2023-01-01",
    "customAttributes": {
    	"custom.mentor": "Jane Doe"
    },
    "createdAt": "2022-01-01T00:00:00.000Z",
    "updatedAt": "2022-01-01T00:00:00.000Z"
}

Detailed information

PropertyTypeExample valueDescription
idstring"01hz2f0c9ryvzajg20jqh9taab"The unique credential's identifier.
publicIdstring"124a8110-1af5-4747-9308-e9d06bd1852a"The external unique credential's identifier (used in the digital wallet to generate a URL).
groupIdstring"01g90279gp5sbmfek7wymcsvec"The unique group's identifier.
statusstring"draft"The status of the credential is draft, scheduled, issued or expired.
recipient.namestring"John Doe"The name of the credential’s recipient.
recipient.emailstring"john.doe@example.com"The email of the credential’s recipient.
issueDatestring"2022-01-01"The date of your credential's issuance. Formatted as an ISO 8601 date string.
expiryDatestring or null"2023-01-01"The date of your credential's expiration. Formatted as an ISO 8601 date string.
customAttributesobject{"custom.mentor": "Jane Doe"}The key-value object of your custom attributes, where key is your attribute's tag and value is the text value you want to store. Make sure the attribute you want to use exists in your account. You can create attributes here.
createdAtstring"2022-01-01T00:00:00.000Z"The date and time when this credential was created. Formatted as an ISO 8601 date and time string.
updatedAtstring"2022-01-01T00:00:00.000Z"The date and time when this credential was updated. Formatted as an ISO 8601 date and time string.