curl --request POST \
--url https://api.truthlocks.com/v1/attestations/mint \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-API-Key: <api-key>' \
--data '
{
"issuer_id": "550e8400-e29b-41d4-a716-446655440000",
"kid": "es256-key-1",
"schema": "verifiable-id",
"claims": {
"full_name": "Example recipient",
"employee_id": "QA-001"
}
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
issuer_id: '550e8400-e29b-41d4-a716-446655440000',
kid: 'es256-key-1',
schema: 'verifiable-id',
claims: {full_name: 'Example recipient', employee_id: 'QA-001'}
})
};
fetch('https://api.truthlocks.com/v1/attestations/mint', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/attestations/mint"
payload = {
"issuer_id": "550e8400-e29b-41d4-a716-446655440000",
"kid": "es256-key-1",
"schema": "verifiable-id",
"claims": {
"full_name": "Example recipient",
"employee_id": "QA-001"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/attestations/mint"
payload := strings.NewReader("{\n \"issuer_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"kid\": \"es256-key-1\",\n \"schema\": \"verifiable-id\",\n \"claims\": {\n \"full_name\": \"Example recipient\",\n \"employee_id\": \"QA-001\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issuer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>",
"status": "<string>",
"expires_at_unix": 123,
"issued_at_unix": 123,
"payload_hash": "<string>",
"signature": {
"alg": "<string>",
"kid": "<string>",
"value": "<string>"
},
"log": {
"log_id": "<string>",
"leaf_index": 123,
"status": "recorded",
"leaf_hash": "<string>",
"proof_url": "<string>"
},
"governance": {}
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}{
"code": "PAYLOAD_TOO_LARGE",
"message": "Request body exceeds maximum size of 1MB",
"http_status": 413
}{
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded",
"http_status": 429,
"retry_after_ms": 60000
}Eine Attestierung ausstellen
Prägen Sie eine signierte Attestierung unter Verwendung eines strukturierten Schemas und von Claims oder einer kodierten Nutzlast. Behalten Sie denselben Idempotenz-Schlüssel und Body bei, wenn Sie diese Anfrage wiederholen.
curl --request POST \
--url https://api.truthlocks.com/v1/attestations/mint \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-API-Key: <api-key>' \
--data '
{
"issuer_id": "550e8400-e29b-41d4-a716-446655440000",
"kid": "es256-key-1",
"schema": "verifiable-id",
"claims": {
"full_name": "Example recipient",
"employee_id": "QA-001"
}
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
issuer_id: '550e8400-e29b-41d4-a716-446655440000',
kid: 'es256-key-1',
schema: 'verifiable-id',
claims: {full_name: 'Example recipient', employee_id: 'QA-001'}
})
};
fetch('https://api.truthlocks.com/v1/attestations/mint', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/attestations/mint"
payload = {
"issuer_id": "550e8400-e29b-41d4-a716-446655440000",
"kid": "es256-key-1",
"schema": "verifiable-id",
"claims": {
"full_name": "Example recipient",
"employee_id": "QA-001"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/attestations/mint"
payload := strings.NewReader("{\n \"issuer_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"kid\": \"es256-key-1\",\n \"schema\": \"verifiable-id\",\n \"claims\": {\n \"full_name\": \"Example recipient\",\n \"employee_id\": \"QA-001\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"attestation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"issuer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>",
"status": "<string>",
"expires_at_unix": 123,
"issued_at_unix": 123,
"payload_hash": "<string>",
"signature": {
"alg": "<string>",
"kid": "<string>",
"value": "<string>"
},
"log": {
"log_id": "<string>",
"leaf_index": 123,
"status": "recorded",
"leaf_hash": "<string>",
"proof_url": "<string>"
},
"governance": {}
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}{
"code": "PAYLOAD_TOO_LARGE",
"message": "Request body exceeds maximum size of 1MB",
"http_status": 413
}{
"code": "RATE_LIMIT_EXCEEDED",
"message": "Rate limit exceeded",
"http_status": 429,
"retry_after_ms": 60000
}Einen Datensatztyp auswählen
Für einen strukturierten Datensatz wählen Sieschema aus dem Dropdown-Menü für den Datensatztyp und geben Sie ein JSON-Objekt in claims ein. Lassen Sie payload_b64url leer. Der Server serialisiert diese Felder in die signierte JSON-Nutzlast. Dies identifiziert den Datensatztyp; es stellt nicht unabhängig fest, dass die Behauptungen wahr sind.
Ein Verifizierungspaket auswählen
Verifizierungspakete gehören zu Ihrem Arbeitsbereich. Verwenden Sie den Selektor unten mit derselben Umgebung und demselben API-Schlüssel wie „Ausprobieren“, und kopieren Sie dann die ausgewählte ID inpack_id. Lassen Sie dieses Feld für einen eigenständigen Datensatz weg. Sie können auch Verifizierungspakete auflisten oder In Console prägen verwenden.
Eine bestehende Nutzlast verwenden
Wenn Sie die genauen zu signierenden Bytes bereits haben, lassen Sieschema und claims weg. Kodieren Sie die ursprünglichen Bytes als ungepolstertes base64url in payload_b64url. Für JSON serialisieren Sie das Objekt zuerst. Anwendungsfelder wie subject, claims und schema gehören in diese kodierten Bytes; verwenden Sie sie entweder über die oben genannte strukturierte Eingabe oder innerhalb der kodierten Bytes, niemals beides. Dieser Endpunkt überprüft nicht unabhängig die Wahrheit der eingereichten Behauptungen oder validiert beliebige Anmeldeinformationsschemata.
Verwenden Sie den kid des Schlüssels und den passenden alg. Die Registrierung eines öffentlichen Schlüssels allein macht keinen privaten Signierschlüssel verfügbar. Siehe Ausstellerschlüssel.
Optionaler Ablauf
Für strukturierteschema und claims setzen Sie expires_at_unix auf einen zukünftigen Unix-Zeitstempel in Sekunden. Truthlocks fügt ihn an der Wurzel der signierten JSON-Nutzlast ein. Mit payload_b64url platzieren Sie dieses Feld innerhalb der exakten JSON-Nutzlast, bevor Sie es kodieren, und lassen Sie das separate Anforderungsfeld weg.
Nach diesem Zeitpunkt gibt die Verifizierung EXPIRED zurück. Das Ablaufdatum kann nicht von einem bestehenden signierten Datensatz verlängert oder entfernt werden; erstellen Sie einen Ersatz. Lassen Sie es weg, wenn Sie kein Ablaufdatum für die Bestätigung wünschen. Daten innerhalb einzelner Ansprüche, wie z. B. ein Reisepass expiry_date, sind separate Ansprüche und legen das Ablaufdatum der Bestätigung nicht automatisch fest. Bestehenden Datensätzen wird kein Datum rückwirkend zugewiesen.
Behalten Sie die genaue Nutzlast und den Ablauf bei Wiederholungsversuchen bei. Ein idempotenter Wiederholungsversuch gibt den ursprünglichen Datensatz auch nach dessen Ablauf zurück.
Sichere Wiederholung
Idempotency-Key ist erforderlich. Generieren Sie einen Wert pro beabsichtigter Prägung und bewahren Sie ihn zusammen mit der ursprünglichen Anfrage für Wiederholungen auf. Verwenden Sie ihn nicht für verschiedene Inhalte wieder.
Dokumentintegrität
Der gespeicherte Dokument-Hash wird in dieser Reihenfolge ausgewählt:claims.document.sha256innerhalb einer JSON-Nutzlast.- Der
document_hashder Anfrage. - SHA-256 der dekodierten Nutzlast-Bytes.
document_hash_hex an verification, um einen Dateihash zu vergleichen. Behalten Sie die ursprüngliche Nutzlast für die Nutzlast-Integritätsprüfung bei.
Antwort und Lieferung
HTTP 201 gibtattestation_id, issued_at_unix, signature und log zurück. Die Log-Position ist log.leaf_index, nicht ein Top-Level log_index.
recipient_email fordert eine asynchrone Benachrichtigung an. HTTP 201 bestätigt die Prägung, nicht die E-Mail-Zustellung. Lassen Sie es weg, wenn Sie den Datensatz selbst verteilen.
Ein Beispiel für eine Anfrage mit den tatsächlichen Eingabe- und Antwortfeldern finden Sie im Schnellstart.
Feldhandbuch für Datensatztypen
Diese Felder sind vorgeschlagene Anspruchsstrukturen, keine Garantie für die Anspruchsvalidierung oder Identitätsprüfung.| Schema-ID | Name | Kategorie | Anspruchsfelder |
|---|---|---|---|
verifiable-id | Verifizierbare ID | Identität | full_name, employee_id, department, title, start_date |
passport | Reisepass | Identität | full_name, nationality, passport_number, date_of_birth, expiry_date, issuing_country |
drivers-license | Führerschein | Identität | full_name, license_number, state, class, expiry_date, date_of_birth |
government-id | Regierungs-ID | Identität | full_name, id_number, id_type, issuing_authority, country, expiry_date |
self-sovereign-id | Selbstsouveräne ID | Identität | did, display_name, created_at |
employment-verification | Beschäftigungsnachweis | Beschäftigung | employee_name, employer, position, department, employment_type, start_date, end_date |
professional-role | Berufsrolle | Beschäftigung | full_name, title, organization, department, effective_date |
membership-card | Mitgliedskarte | Beschäftigung | member_name, organization, membership_id, tier, valid_from, valid_to |
professional-certification | Berufsqualifikation | Beschäftigung | holder_name, certification_name, issuing_body, certification_id, issued_date, expiry_date |
license | Lizenz | Beschäftigung | holder_name, license_type, license_number, issuing_authority, jurisdiction, issued_date, expiry_date |
accreditation | Akkreditierung | Beschäftigung | entity_name, accreditation_body, standard, scope, valid_from, valid_to |
degree | Abschluss | Bildung | student_name, institution, degree_type, field_of_study, graduation_date, honors |
completion-cert | Abschlusszertifikat | Bildung | participant_name, program_name, institution, completion_date, hours |
course-credit | Kursgutschrift | Bildung | student_name, course_name, institution, credits, grade, semester |
transcript | Zeugnis | Bildung | student_name, institution, program, gpa, total_credits, issue_date |
micro-credential | Mikro-Zertifikat | Bildung | earner_name, credential_name, issuer, skills, earned_date |
training-completion | Abschluss der Ausbildung | Bildung | trainee_name, training_program, provider, completion_date, score, certificate_id |
medical-license | Ärztliche Lizenz | Gesundheitswesen | practitioner_name, license_number, specialty, state, issued_date, expiry_date |
dea-registration | DEA-Registrierung | Gesundheitswesen | registrant_name, dea_number, schedules, business_activity, expiry_date |
board-certification | Vorstandsbescheinigung | Gesundheitswesen | physician_name, board, specialty, certification_date, expiry_date |
health-credential | Gesundheitsnachweis | Gesundheitswesen | patient_name, credential_type, provider, date, details |
vaccination-record | Impfpass | Gesundheitswesen | patient_name, vaccine_name, manufacturer, lot_number, date_administered, dose_number, site |
aml-kyc | AML/KYC-Prüfung | Compliance | entity_name, check_type, result, risk_level, verified_by, verified_at |
security-clearance | Sicherheitsfreigabe | Compliance | holder_name, clearance_level, granting_agency, granted_date, expiry_date |
sam-gov | SAM.gov-Registrierung | Compliance | entity_name, cage_code, uei, registration_status, expiry_date |
jurisdiction-approval | Genehmigung der Gerichtsbarkeit | Compliance | entity_name, jurisdiction, approval_type, approved_date, conditions |
attestation-of-will | Bestätigung des Testaments | Compliance | declarant_name, declaration, witness, date |
bank-verification | Bankverifizierung | Finanzen | account_holder, bank_name, account_type, routing_number_last4, verified_date |
credit-attestation | Kreditbestätigung | Finanzen | entity_name, credit_score_range, reporting_agency, assessment_date |
income-verification | Einkommensprüfung | Finanzen | individual_name, employer, annual_income_range, verification_date, tax_year |
skill-badge | Skill-Abzeichen | Fähigkeiten & Training | earner_name, skill_name, proficiency_level, assessed_by, earned_date |
competency | Kompetenzbestätigung | Fähigkeiten & Training | individual_name, competency, level, assessor, assessment_date |
industry-cert | Branchenzertifizierung | Fähigkeiten & Training | holder_name, certification, issuing_body, cert_id, issued_date, expiry_date |
product-authenticity | Produktauthentizität | Lieferkette | product_name, sku, serial_number, manufacturer, manufactured_date, origin_country |
chain-of-custody | Nachweiskette | Lieferkette | item_description, from_entity, to_entity, transfer_date, location, condition |
origin-verification | Ursprungsprüfung | Lieferkette | product_name, origin_country, origin_region, certifying_body, verified_date |
custom | Benutzerdefiniert | Sonstiges | subject, type, details |
attestation | Generische Bestätigung | Sonstiges | subject, claim, evidence |
Autorisierungen
Header
Body
- Structured record
- Encoded payload
Wählen Sie „Strukturierter Datensatz“, um einen Datensatztyp auszuwählen und Ansprüche einzugeben, oder „Kodierte Nutzlast“, um vorhandene Bytes zu signieren. Kombinieren Sie niemals beide Eingabeformate.
Datensatztyp für strukturierte Eingaben. Geben Sie Ansprüche an und lassen Sie payload_b64url weg. Dieses Label validiert die Wahrheit der Ansprüche nicht unabhängig.
verifiable-id, passport, drivers-license, government-id, self-sovereign-id, employment-verification, professional-role, membership-card, professional-certification, license, accreditation, degree, completion-cert, course-credit, transcript, micro-credential, training-completion, medical-license, dea-registration, board-certification, health-credential, vaccination-record, aml-kyc, security-clearance, sam-gov, jurisdiction-approval, attestation-of-will, bank-verification, credit-attestation, income-verification, skill-badge, competency, industry-cert, product-authenticity, chain-of-custody, origin-verification, custom, attestation "verifiable-id"
Optionaler zukünftiger Unix-Zeitstempel in Sekunden für strukturierte Schema-/Anspruchseingaben. Er ist in der signierten JSON-Nutzlast enthalten. Für die Eingabe payload_b64url lassen Sie dieses Anforderungsfeld weg und betten expires_at_unix stattdessen an der Wurzel der genauen JSON-Nutzlast ein. Das Ablaufdatum kann nicht nachträglich geändert werden.
1 <= x <= 253402300799Antwort
Bestätigung geprägt

