The credential object

The sample object

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

Detailed information

Property	Type	Example value	Description
`id`	`string`	`"01hz2f0c9ryvzajg20jqh9taab"`	The unique credential's identifier.
`publicId`	`string`	`"124a8110-1af5-4747-9308-e9d06bd1852a"`	The external unique credential's identifier (used in the digital wallet to generate a URL).
`groupId`	`string`	`"01g90279gp5sbmfek7wymcsvec"`	The unique group's identifier.
`status`	`string`	`"draft"`	The status of the credential is `draft`, `scheduled`, `issued` or `expired`.
`recipient`	`object` or `null`	`{ "id": "01jmerb62apgachxwx6db76c7s", "name": "John Doe","email": "[email protected])" }`	The recipient object (if an email was provided).
`recipient.id`	`string`	`"01jmerb62apgachxwx6db76c7s"`	The credential recipient’s unique identifier.
`recipient.name`	`string`	`"John Doe"`	The name of the credential’s recipient.
`recipient.email`	`string`	`"[email protected]"`	The email of the credential’s recipient.
`issueDate`	`string`	`"2022-01-01"`	The date of your credential's issuance. Formatted as an ISO 8601 date string.
`expiryDate`	`string` or `null`	`"2023-01-01"`	The date of your credential's expiration. Formatted as an ISO 8601 date string.
`attributes`	`object`	`{"recipient.name": "John Doe"}`	The key-value object of the credential's attributes. Currently this can only be the `recipient.name`, configured on a per-credential basis.
`customAttributes`	`object`	`{"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.
`createdAt`	`string`	`"2022-01-01T00:00:00.000Z"`	The date and time when this credential was created. Formatted as an ISO 8601 date and time string.
`updatedAt`	`string`	`"2022-01-01T00:00:00.000Z"`	The date and time when this credential was updated. Formatted as an ISO 8601 date and time string.