Certify

Manually certifies a user against a course, learning path, or other supported resource, returning the resulting certificate record

Manually certifies a user against a course, learning path, or other supported resource, returning the resulting certificate record.

POSThttps://example.thoughtindustries.com/incoming/v2/users/:id/certify

Example request

curl -X POST "https://example.thoughtindustries.com/incoming/v2/users/:id/certify" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "resourceType": "string",
  "resourceId": "00000000-0000-0000-0000-000000000000",
  "expirationDate": "string"
}'

Parameters

Name	Type	Required	Location	Description
`id`	`uuid`	Yes	path	Unique identifier of the user to certify.
`resourceType`	`CertificateResourceType`	Yes	body	The type of resource the certificate is issued against (e.g., course, learning path).
`resourceId`	`uuid`	Yes	body	Unique identifier of the resource the certificate is issued against.
`expirationDate`	`ISO 8601 timestamp`	No	body	Date and time at which the certificate expires, as an ISO 8601 timestamp.
`sendEmail`	`boolean`	No	body	When `true`, sends a certificate notification email to the user.
`issuedAt`	`ISO 8601 timestamp`	No	body	Date and time the certificate was issued, as an ISO 8601 timestamp. Defaults to the current time if omitted.
`recertificationDate`	`ISO 8601 timestamp`	No	body	Date and time by which the user must recertify, as an ISO 8601 timestamp.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "issuedAt": "2024-01-01T00:00:00.000Z",
  "url": "https://example.com/path",
  "resourceId": "00000000-0000-0000-0000-000000000000",
  "resourceType": "string",
  "expirationDate": "2024-01-01T00:00:00.000Z",
  "recertificationDate": "2024-01-01T00:00:00.000Z",
  "pdfAsset": "https://example.com/path",
  "user": {
    "id": "00000000-0000-0000-0000-000000000000",
    "learnerUserId": "00000000-0000-0000-0000-000000000000",
    "managerUserId": "00000000-0000-0000-0000-000000000000",
    "clientId": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "disabled": true,
    "sfAccountId": "00000000-0000-0000-0000-000000000000",
    "sfContactId": "00000000-0000-0000-0000-000000000000",
    "roleKey": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "telephone": "string",
    "country": "string",
    "stripeCustomerId": "00000000-0000-0000-0000-000000000000",
    "externalCustomerId": "00000000-0000-0000-0000-000000000000",
    "shippingName": "string",
    "asset": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "lastActiveAt": "2024-01-01T00:00:00.000Z",
    "ref1": "string",
    "ref2": "string",
    "ref3": "string",
    "ref4": "string",
    "ref5": "string",
    "ref6": "string",
    "ref7": "string",
    "ref8": "string",
    "ref9": "string",
    "ref10": "string",
    "language": "string",
    "customFields": {},
    "purchasedBundles": [
      {
        "bundleId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "allocatedLicenses": [
      {
        "licenseId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "allocatedLearningPaths": [
      {
        "learningPathId": "00000000-0000-0000-0000-000000000000",
        "status": "string"
      }
    ],
    "purchasedCourses": [
      {
        "courseId": "00000000-0000-0000-0000-000000000000",
        "status": "string"
      }
    ],
    "waitlistedCourses": [
      {
        "courseId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "balance": 0,
    "preferredCurrency": "string"
  }
}

Response fields

Field	Type	Description
`id`	`uuid`	Unique identifier of the certificate record.
`issuedAt`	`ISO 8601 timestamp`	Date and time the certificate was issued.
`url`	`string`	URL where the certificate can be viewed.
`resourceId`	`uuid`	Unique identifier of the resource the certificate was issued against.
`resourceType`	`CertificateResourceType`	Type of resource the certificate was issued against.
`expirationDate`	`ISO 8601 timestamp`	Date and time at which the certificate expires.
`recertificationDate`	`ISO 8601 timestamp`	Date and time by which the user must recertify.
`pdfAsset`	`string`	URL of the certificate's PDF asset.
`user`	`User`	The certified user.
`user.id`	`uuid`	Unique identifier of the user.
`user.learnerUserId`	`uuid`	Identifier of the learner-facing user record, if distinct from the admin/manager record.
`user.managerUserId`	`uuid`	Identifier of the user's manager, if any.
`user.clientId`	`uuid`	Identifier of the client the user belongs to.
`user.createdAt`	`ISO 8601 timestamp`	Date and time the user was created.
`user.disabled`	`boolean`	Indicates whether the user account is disabled.
`user.sfAccountId`	`uuid`	Associated Salesforce account identifier.
`user.sfContactId`	`uuid`	Associated Salesforce contact identifier.
`user.roleKey`	`string`	The user's role.
`user.address1`	`string`	First line of the user's address.
`user.address2`	`string`	Second line of the user's address.
`user.city`	`string`	City of the user's address.
`user.state`	`string`	State or region of the user's address.
`user.zipCode`	`string`	Postal code of the user's address.
`user.telephone`	`string`	The user's telephone number.
`user.country`	`string`	Country of the user's address.
`user.stripeCustomerId`	`uuid`	Associated Stripe customer identifier.
`user.externalCustomerId`	`uuid`	External customer identifier associated with the user.
`user.shippingName`	`string`	Name used for shipping physical goods to the user.
`user.asset`	`string`	URL of the user's profile image.
`user.email`	`string`	Email address of the user.
`user.firstName`	`string`	First name of the user.
`user.lastName`	`string`	Last name of the user.
`user.lastActiveAt`	`ISO 8601 timestamp`	Date and time the user was last active.
`user.ref1`	`string`	Custom reference field 1 associated with the user.
`user.ref2`	`string`	Custom reference field 2 associated with the user.
`user.ref3`	`string`	Custom reference field 3 associated with the user.
`user.ref4`	`string`	Custom reference field 4 associated with the user.
`user.ref5`	`string`	Custom reference field 5 associated with the user.
`user.ref6`	`string`	Custom reference field 6 associated with the user.
`user.ref7`	`string`	Custom reference field 7 associated with the user.
`user.ref8`	`string`	Custom reference field 8 associated with the user.
`user.ref9`	`string`	Custom reference field 9 associated with the user.
`user.ref10`	`string`	Custom reference field 10 associated with the user.
`user.language`	`string`	The user's preferred language.
`user.customFields`	`object`	Key-value map of custom fields defined for the user.
`user.purchasedBundles`	`object[]`	Bundles the user has purchased.
`user.purchasedBundles.bundleId`	`uuid`	Identifier of the purchased bundle.
`user.allocatedLicenses`	`object[]`	Licenses allocated to the user.
`user.allocatedLicenses.licenseId`	`uuid`	Identifier of the allocated license.
`user.allocatedLearningPaths`	`object[]`	Learning paths allocated to the user.
`user.allocatedLearningPaths.learningPathId`	`uuid`	Identifier of the allocated learning path.
`user.allocatedLearningPaths.status`	`string`	The user's status on the allocated learning path.
`user.purchasedCourses`	`object[]`	Courses the user has purchased.
`user.purchasedCourses.courseId`	`uuid`	Identifier of the purchased course.
`user.purchasedCourses.status`	`string`	The user's status on the purchased course.
`user.waitlistedCourses`	`object[]`	Courses the user is waitlisted for.
`user.waitlistedCourses.courseId`	`uuid`	Identifier of the waitlisted course.
`user.balance`	`integer`	The user's current account balance.
`user.preferredCurrency`	`string`	The user's preferred currency.