صك إثبات
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
}الإشهادات
إصدار إشهاد
صك إثبات موقع باستخدام مخطط وهياكل منظمة، أو حمولة مشفرة. احتفظ بنفس Idempotency-Key والنص عند إعادة محاولة هذا الطلب.
POST
/
v1
/
attestations
/
mint
صك إثبات
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
}يوقع حمولة باستخدام مفتاح توقيع متاح للمصدر ويسجل الإثبات الناتج. قد تمنع سياسة المصدر وحالة المفتاح والبيئة وحدود الاستخدام سك العملة.
اختر نوع السجل
لسجل منظم، اخترschema من القائمة المنسدلة لنوع السجل وأدخل كائن JSON في claims. اترك payload_b64url فارغًا. يقوم الخادم بتسلسل هذه الحقول في حمولة JSON الموقعة. هذا يحدد نوع السجل؛ ولا يثبت بشكل مستقل أن المطالبات صحيحة.
اختر حزمة تحقق
تنتمي حزم التحقق إلى مساحة عملك. استخدم المحدد أدناه بنفس البيئة ومفتاح API كما في Try it، ثم انسخ المعرف المحدد إلىpack_id. احذف هذا الحقل لسجل مستقل. يمكنك أيضًا استخدام List verification packs أو Mint in Console.
استخدام حمولة موجودة
إذا كان لديك البايتات الدقيقة للتوقيع بالفعل، فاحذفschema و claims. قم بترميز البايتات الأصلية كـ base64url غير مبطن في payload_b64url. بالنسبة لـ JSON، قم بتسلسل الكائن أولاً. تنتمي حقول التطبيق مثل subject و claims و schema داخل تلك البايتات المشفرة؛ استخدمها إما من خلال الإدخال المنظم أعلاه أو داخل البايتات المشفرة، ولا تستخدم كليهما أبدًا. لا تتحقق نقطة النهاية هذه بشكل مستقل من صحة المطالبات المقدمة أو تتحقق من صحة مخططات الاعتماد العشوائية.
استخدم kid للمفتاح و alg المطابق. لا يؤدي تسجيل المفتاح العام وحده إلى توفير مفتاح توقيع خاص. انظر مفاتيح المُصدر.
انتهاء الصلاحية الاختياري
لـschema و claims المنظمين، اضبط expires_at_unix على طابع زمني Unix مستقبلي بـ الثواني. يتضمن Truthlocks ذلك في جذر حمولة JSON الموقعة. مع payload_b64url، ضع هذا الحقل داخل حمولة JSON الدقيقة قبل ترميزها وحذف حقل الطلب المنفصل.
بعد تلك اللحظة، يعيد التحقق EXPIRED. لا يمكن تمديد انتهاء الصلاحية أو إزالته من سجل موقع موجود؛ قم بإنشاء بديل. احذفه عندما لا ترغب في انتهاء صلاحية التصديق. التواريخ داخل المطالبات الفردية، مثل expiry_date لجواز السفر، هي مطالبات منفصلة ولا تحدد تلقائيًا انتهاء صلاحية التصديق. لا يتم تعيين تاريخ للسجلات الموجودة بأثر رجعي.
احتفظ بالحمولة الدقيقة وتاريخ انتهاء الصلاحية عند إعادة المحاولة. تعيد المحاولة المتطابقة السجل الأصلي حتى بعد انتهاء صلاحيته.
إعادة المحاولة بأمان
Idempotency-Key مطلوب. قم بإنشاء قيمة واحدة لكل سك مقصود واحتفظ بها مع الطلب الأصلي لإعادة المحاولات. لا تعيد استخدامها لمحتوى مختلف.
سلامة المستندات
يتم تحديد تجزئة المستند المخزنة بهذا الترتيب:claims.document.sha256داخل حمولة JSON.document_hashللطلب.- SHA-256 لبايتات الحمولة المفككة.
document_hash_hex إلى verification لمقارنة تجزئة ملف. احتفظ بالحمولة الأصلية للتحقق من سلامة الحمولة.
الاستجابة والتسليم
يعيد HTTP 201attestation_id، issued_at_unix، signature، و log. موقع السجل هو log.leaf_index، وليس log_index على المستوى الأعلى.
recipient_email يطلب إشعارًا غير متزامن. يؤكد HTTP 201 السك، وليس تسليم البريد الإلكتروني. احذفه عند توزيع السجل بنفسك.
راجع دليل البدء السريع لطلب يستخدم حقول الإدخال والاستجابة الفعلية.
دليل حقل نوع السجل
هذه الحقول هي هياكل مطالبات مقترحة، وليست ضمانًا للتحقق من المطالبة أو التحقق من الهوية.| معرف المخطط | الاسم | الفئة | حقول المطالبة |
|---|---|---|---|
verifiable-id | هوية قابلة للتحقق | الهوية | full_name, employee_id, department, title, start_date |
passport | جواز سفر | الهوية | full_name, nationality, passport_number, date_of_birth, expiry_date, issuing_country |
drivers-license | رخصة قيادة | الهوية | full_name, license_number, state, class, expiry_date, date_of_birth |
government-id | هوية حكومية | الهوية | full_name, id_number, id_type, issuing_authority, country, expiry_date |
self-sovereign-id | هوية ذاتية السيادة | الهوية | did, display_name, created_at |
employment-verification | التحقق من التوظيف | التوظيف | employee_name, employer, position, department, employment_type, start_date, end_date |
professional-role | دور مهني | التوظيف | full_name, title, organization, department, effective_date |
membership-card | بطاقة عضوية | التوظيف | member_name, organization, membership_id, tier, valid_from, valid_to |
professional-certification | شهادة مهنية | التوظيف | holder_name, certification_name, issuing_body, certification_id, issued_date, expiry_date |
license | ترخيص | التوظيف | holder_name, license_type, license_number, issuing_authority, jurisdiction, issued_date, expiry_date |
accreditation | اعتماد | التوظيف | entity_name, accreditation_body, standard, scope, valid_from, valid_to |
degree | درجة | التعليم | student_name, institution, degree_type, field_of_study, graduation_date, honors |
completion-cert | شهادة إتمام | التعليم | participant_name, program_name, institution, completion_date, hours |
course-credit | رصيد الدورة | التعليم | student_name, course_name, institution, credits, grade, semester |
transcript | كشف الدرجات | التعليم | student_name, institution, program, gpa, total_credits, issue_date |
micro-credential | شهادة مصغرة | التعليم | earner_name, credential_name, issuer, skills, earned_date |
training-completion | إتمام التدريب | تعليم | trainee_name, training_program, provider, completion_date, score, certificate_id |
medical-license | ترخيص طبي | الرعاية الصحية | practitioner_name, license_number, specialty, state, issued_date, expiry_date |
dea-registration | تسجيل DEA | الرعاية الصحية | registrant_name, dea_number, schedules, business_activity, expiry_date |
board-certification | شهادة مجلس الإدارة | رعاية صحية | physician_name, board, specialty, certification_date, expiry_date |
health-credential | شهادة صحية | الرعاية الصحية | patient_name, credential_type, provider, date, details |
vaccination-record | سجل التطعيم | رعاية صحية | patient_name, vaccine_name, manufacturer, lot_number, date_administered, dose_number, site |
aml-kyc | فحص AML/KYC | الامتثال | entity_name, check_type, result, risk_level, verified_by, verified_at |
security-clearance | تصريح أمني | امتثال | holder_name, clearance_level, granting_agency, granted_date, expiry_date |
sam-gov | تسجيل SAM.gov | الامتثال | entity_name, cage_code, uei, registration_status, expiry_date |
jurisdiction-approval | موافقة الولاية القضائية | امتثال | entity_name, jurisdiction, approval_type, approved_date, conditions |
attestation-of-will | تصديق وصية | امتثال | declarant_name, declaration, witness, date |
bank-verification | التحقق المصرفي | المالية | account_holder, bank_name, account_type, routing_number_last4, verified_date |
credit-attestation | تصديق ائتماني | مالي | entity_name, credit_score_range, reporting_agency, assessment_date |
income-verification | التحقق من الدخل | مالي | individual_name, employer, annual_income_range, verification_date, tax_year |
skill-badge | شارة المهارة | المهارات والتدريب | earner_name, skill_name, proficiency_level, assessed_by, earned_date |
competency | إثبات الكفاءة | المهارات والتدريب | individual_name, competency, level, assessor, assessment_date |
industry-cert | شهادة صناعية | المهارات والتدريب | holder_name, certification, issuing_body, cert_id, issued_date, expiry_date |
product-authenticity | أصالة المنتج | سلسلة التوريد | product_name, sku, serial_number, manufacturer, manufactured_date, origin_country |
chain-of-custody | سلسلة الحضانة | سلسلة التوريد | item_description, from_entity, to_entity, transfer_date, location, condition |
origin-verification | التحقق من الأصل | سلسلة التوريد | product_name, origin_country, origin_region, certifying_body, verified_date |
custom | مخصص | أخرى | subject, type, details |
attestation | إثبات عام | أخرى | subject, claim, evidence |
الجسم
application/json
- Structured record
- Encoded payload
اختر سجل منظم لتحديد نوع السجل وإدخال المطالبات، أو حمولة مشفرة لتوقيع البايتات الموجودة. لا تجمع أبدًا بين تنسيقي الإدخال.
نوع السجل للإدخال المنظم. قدم المطالبات واحذف payload_b64url. هذا التصنيف لا يتحقق بشكل مستقل من صحة المطالبات.
الخيارات المتاحة:
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"
طابع زمني Unix مستقبلي اختياري بالثواني لإدخال المخطط/المطالبات المهيكلة. يتم تضمينه في حمولة JSON الموقعة. بالنسبة لإدخال payload_b64url، احذف حقل الطلب هذا وقم بتضمين expires_at_unix في جذر حمولة JSON الدقيقة بدلاً من ذلك. لا يمكن تغيير تاريخ انتهاء الصلاحية في مكانه.
النطاق المطلوب:
1 <= x <= 253402300799الاستجابة
تم سك الإشهاد

