Credentials

Send a credential

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

Currently, the only supported deliveryMethod is email. Certifier will send an email to the recipient using the email template configured for the group (credential template) the credential belongs to.

If you are looking for an all-in-one solution that simultaneously creates, issues, and sends a credential, check the Create, issue, and send a credential endpoint.

post/v1/credentials/{id}/send

Path parameters

idstring required

The unique ID of the credential

Example:01hz2f0c9ryvzajg20jqh9taab

The unique ID of the credential

Headers

Certifier-Versionstring required

API version header. Required for all requests.

Example:2022-10-26

API version header. Required for all requests.

Request body

deliveryMethod'email' required

The way you want to deliver the credential. The only available deliveryMethod for now is email

Example request

{
  "deliveryMethod": "email"
}

Response

Credential sent successfully

idstring required

The unique credential's identifier

publicIdstring uuid required

The external unique credential's identifier (used in the digital wallet to generate a URL, e.g. https://credsverse.com/credentials/{publicId})

groupIdstring required

The unique identifier of the group (credential template).

status'draft' | 'scheduled' | 'issued' | 'expired' required

The status of the credential

issueDatestring required

The date of your credential's issuance. Formatted as an ISO 8601 date string (YYYY-MM-DD)

expiryDatestring nullable required

The date of your credential's expiration. Formatted as an ISO 8601 date string (YYYY-MM-DD)

attributesobject required

The key-value object of the credential's attributes. Currently this can only be the recipient.name, configured on a per-credential basis

customAttributesobject required

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

createdAtstring date-time required

The date and time when this credential was created. Formatted as an ISO 8601 date and time string

updatedAtstring date-time required

The date and time when this credential was updated. Formatted as an ISO 8601 date and time string

Example response

{
  "id": "01hz2f0c9ryvzajg20jqh9taab",
  "publicId": "124a8110-1af5-4747-9308-e9d06bd1852a",
  "groupId": "01g90279gp5sbmfek7wymcsvec",
  "status": "draft",
  "recipient": {
    "id": "01jmerb62apgachxwx6db76c7s",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "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"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.