The credential object

The sample object

{
    "id": "91079f196ef7b10185920d09",
    "publicId": "124a8110-1af5-4747-9308-e9d06bd1852a",
    "groupId": "3f9717d0ecd9f5202c1cb77c",
    "status": "unpublished",
    "recipient": {
        "name": "John Doe",
        "email": "[email protected]"
    },
    "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

Property	Type	Example value	Description
`id`	`string`	`"91079f196ef7b10185920d09"`	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`	`"3f9717d0ecd9f5202c1cb77c"`	The unique group's identifier.
`status`	`string`	`"unpublished"`	The status of the credential is either `unpublished` or `published`.
`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.
`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.
`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.