Send 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.
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.
Authorization
BearerAuth 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
The unique ID of the credential
Header Parameters
API version header. Required for all requests.
"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
application/json
curl -X POST "https://example.com/v1/credentials/string/send" \ -H "Certifier-Version: 2022-10-26" \ -H "Content-Type: application/json" \ -d '{ "deliveryMethod": "email" }'{ "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"}Search credentials POST
1. [Introduction](#introduction) * [Example Request](#example-request) 2. [Filtering](#filtering) * [Logical Operators](#logical-operators) * [AND](#and) * [OR](#or) * [NOT](#not) * [Field Types & Comparison Operators](#field-types--comparison-operators) * [String Fields](#string-fields) * [UUID Fields](#uuid-fields) * [Enum Fields](#enum-fields) * [Date Fields (YYYY-MM-DD)](#date-fields-yyyy-mm-dd) * [DateTime Fields (ISO 8601)](#datetime-fields-iso-8601) * [Handling Null Values](#handling-null-values) * [In Operator Limitation for Null Values](#in-operator-limitation-for-null-values) 3. [Credentials Searchable Fields](#credentials-searchable-fields) * [Core Fields](#core-fields) * [Recipient Fields](#recipient-fields) * [Temporal Fields](#temporal-fields) 4. [Sorting](#sorting) * [Credentials Sortable Properties](#credentials-sortable-properties) 5. [Pagination](#pagination) 6. [Complete Example](#complete-example) 7. [Tips and Advanced Use](#tips-and-advanced-use) * [Implicit AND](#implicit-and) * [Top-Level Logical Operators](#top-level-logical-operators) * [Filter Condition Objects](#filter-condition-objects) * [Comparison Operator Expressions](#comparison-operator-expressions)
Update a credential PATCH
Use this endpoint to update a credential.