@trustdiplomas/sdk
v1.0.0
Published
The TypeScript SDK for the TrustDiplomas API that enables institutions to securely certify and manage diplomas.
Readme
TrustDiplomas™ is a free solution simplifying registrars' workloads, integrating seamlessly with existing systems, instantly verifying paper and electronic diploma authenticity & validity. Patented technology with end-to-end encryption accelerates hiring, informs users in real-time if diplomas become invalid, generates revenue for universities & colleges, and combats fraud effectively.
Usage
Documentation
The SDK documentation is available at https://api.trustdiplomas.com/doc/sdk/typescript.
Installation
npm install @trustdiplomas/sdkExample using ES Modules
import { TrustDiplomasClient } from "@trustdiplomas/sdk";
import { join } from "node:path";
// Create a new client instance
const client = await TrustDiplomasClient.create(
"your-api-key",
"your-encryption-key" // it corresponds to the password of the user
);
// Certify a diploma
const diploma = {
student: {
firstName: "Charlotte",
lastName: "Fletcher",
gender: "Mrs.",
},
degree: {
name: "Bachelor of Science",
level: "Undergraduate",
major: "Computer Science",
instructionMode: "In-person",
},
graduationDate: new Date("2024-10-29"),
issuanceDate: new Date("2024-10-29"),
};
// Optional QR code generation options
const qrCodeOptions = {
outputPath: join(import.meta.dirname, "output.jpg"),
// Optional: Your institution's logo (128x128px)
logoPath: join(import.meta.dirname, "custom-logo.png"),
};
const result = await client.certifyDiploma(diploma, qrCodeOptions);
console.log("Diploma certified with ID:", result.diplomaId);
// Update diploma status
await client.updateStatusDiploma(
result.diplomaId,
result.sha256Fingerprint,
"suspended"
);Software License Agreement
Copyright © 2025 TrustDiplomas™ All Rights Reserved
This software, including its associated documentation, constitutes the proprietary and confidential property of TrustDiplomas™. It is made available exclusively for limited internal evaluation and non-commercial testing purposes.
Restrictions on Use
You are expressly prohibited from:
- Modifying, altering, reverse-engineering, decompiling, or creating derivative works of the software or any part thereof;
- Distributing, sublicensing, publishing, transmitting, transferring, or otherwise disclosing the software to any third party;
- Using the software for any commercial purpose, unless prior written authorization has been granted by TrustDiplomas™.
Ownership and License
This software is NOT open source and is NOT licensed under any open-source license. All rights, title, and interest in and to the software remain the exclusive property of TrustDiplomas™.
Unauthorized use, reproduction, distribution, or disclosure of the software, in whole or in part, may result in both civil and criminal liability under applicable laws.
Third-Party Components
This software may include third-party open-source components. Each such component is licensed under its own applicable open-source license terms. For details, refer to the file: THIRD-PARTY-LICENSES.txt.
Contact and Licensing Requests
To inquire about licensing options or to request permission for extended or commercial use, please contact:
📧 [email protected] 🌐 https://trustdiplomas.com
By accessing, downloading, or using this software, you acknowledge and agree to be legally bound by the terms of this license agreement.
Support
For support, please contact [email protected].
