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
}Émettre une attestation
Émettez une attestation signée en utilisant un schéma structuré et des revendications, ou une charge utile encodée. Conservez la même clé d’idempotence et le même corps lors de la nouvelle tentative de cette requête.
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
}Choisir un type d’enregistrement
Pour un enregistrement structuré, choisissezschema dans le menu déroulant du type d’enregistrement et entrez un objet JSON dans claims. Laissez payload_b64url vide. Le serveur sérialise ces champs dans la charge utile JSON signée. Cela identifie le type d’enregistrement ; cela n’établit pas indépendamment que les revendications sont vraies.
Choisir un pack de vérification
Les packs de vérification appartiennent à votre espace de travail. Utilisez le sélecteur ci-dessous avec le même environnement et la même clé API que Try it, puis copiez l’ID sélectionné danspack_id. Omettez ce champ pour un enregistrement autonome. Vous pouvez également utiliser Lister les packs de vérification ou Mint dans Console.
Utiliser une charge utile existante
Si vous avez déjà les octets exacts à signer, omettezschema et claims. Encodez les octets originaux en base64url non paddé dans payload_b64url. Pour JSON, sérialisez d’abord l’objet. Les champs d’application tels que subject, claims et schema appartiennent à ces octets encodés ; utilisez-les soit via l’entrée structurée ci-dessus, soit à l’intérieur des octets encodés, jamais les deux. Ce point de terminaison ne vérifie pas indépendamment la véracité des affirmations soumises ni ne valide des schémas d’informations d’identification arbitraires.
Utilisez le kid de la clé et le alg correspondant. L’enregistrement de la clé publique seule ne rend pas une clé de signature privée disponible. Voir clés d’émetteur.
Expiration facultative
Pour lesschema et claims structurés, définissez expires_at_unix sur un horodatage Unix futur en secondes. Truthlocks l’inclut à la racine de la charge utile JSON signée. Avec payload_b64url, placez ce champ à l’intérieur de la charge utile JSON exacte avant de l’encoder et omettez le champ de requête séparé.
Après cet instant, la vérification renvoie EXPIRED. L’expiration ne peut pas être prolongée ou supprimée d’un enregistrement signé existant ; créez un remplacement. Omettez-la lorsque vous ne souhaitez pas d’expiration d’attestation. Les dates figurant dans les revendications individuelles, telles que le expiry_date d’un passeport, sont des revendications distinctes et ne définissent pas automatiquement l’expiration de l’attestation. Les enregistrements existants ne se voient pas attribuer de date rétroactivement.
Conservez la charge utile exacte et l’expiration lors de la nouvelle tentative. Une nouvelle tentative idempotente renvoie l’enregistrement original même après son expiration.
Réessayer en toute sécurité
Idempotency-Key est requis. Générez une valeur par frappe prévue et conservez-la avec la demande originale pour les tentatives. Ne la réutilisez pas pour un contenu différent.
Intégrité des documents
Le hachage du document stocké est sélectionné dans cet ordre :claims.document.sha256à l’intérieur d’une charge utile JSON.- Le
document_hashde la requête. - SHA-256 des octets de la charge utile décodée.
document_hash_hex à vérification pour comparer un hachage de fichier. Conservez la charge utile originale pour la vérification de l’intégrité de la charge utile.
Réponse et livraison
HTTP 201 renvoieattestation_id, issued_at_unix, signature et log. La position du journal est log.leaf_index, et non un log_index de niveau supérieur.
recipient_email demande une notification asynchrone. HTTP 201 confirme la frappe, pas la livraison de l’e-mail. Omettez-le lorsque vous distribuez l’enregistrement vous-même.
Consultez le guide de démarrage rapide pour une requête utilisant les champs d’entrée et de réponse réels.
Guide des champs de type d’enregistrement
Ces champs sont des structures de revendication suggérées, et non une garantie de validation de revendication ou de vérification d’identité.| ID de schéma | Nom | Catégorie | Champs de réclamation |
|---|---|---|---|
verifiable-id | ID vérifiable | Identité | full_name, employee_id, department, title, start_date |
passport | Passeport | Identité | full_name, nationality, passport_number, date_of_birth, expiry_date, issuing_country |
drivers-license | Permis de conduire | Identité | full_name, license_number, state, class, expiry_date, date_of_birth |
government-id | Pièce d’identité gouvernementale | Identité | full_name, id_number, id_type, issuing_authority, country, expiry_date |
self-sovereign-id | ID auto-souverain | Identité | did, display_name, created_at |
employment-verification | Vérification d’emploi | Emploi | employee_name, employer, position, department, employment_type, start_date, end_date |
professional-role | Rôle professionnel | Emploi | full_name, title, organization, department, effective_date |
membership-card | Carte de membre | Emploi | member_name, organization, membership_id, tier, valid_from, valid_to |
professional-certification | Certification professionnelle | Emploi | holder_name, certification_name, issuing_body, certification_id, issued_date, expiry_date |
license | Licence | Emploi | holder_name, license_type, license_number, issuing_authority, jurisdiction, issued_date, expiry_date |
accreditation | Accréditation | Emploi | entity_name, accreditation_body, standard, scope, valid_from, valid_to |
degree | Diplôme | Éducation | student_name, institution, degree_type, field_of_study, graduation_date, honors |
completion-cert | Certificat de fin d’études | Éducation | participant_name, program_name, institution, completion_date, hours |
course-credit | Crédit de cours | Éducation | student_name, course_name, institution, credits, grade, semester |
transcript | Relevé de notes | Éducation | student_name, institution, program, gpa, total_credits, issue_date |
micro-credential | Micro-accréditation | Éducation | earner_name, credential_name, issuer, skills, earned_date |
training-completion | Achèvement de formation | Éducation | trainee_name, training_program, provider, completion_date, score, certificate_id |
medical-license | Licence médicale | Santé | practitioner_name, license_number, specialty, state, issued_date, expiry_date |
dea-registration | Enregistrement DEA | Santé | registrant_name, dea_number, schedules, business_activity, expiry_date |
board-certification | Certification professionnelle | Santé | physician_name, board, specialty, certification_date, expiry_date |
health-credential | Accréditation santé | Santé | patient_name, credential_type, provider, date, details |
vaccination-record | Carnet de vaccination | Santé | patient_name, vaccine_name, manufacturer, lot_number, date_administered, dose_number, site |
aml-kyc | Vérification AML/KYC | Conformité | entity_name, check_type, result, risk_level, verified_by, verified_at |
security-clearance | Habilitation de sécurité | Conformité | holder_name, clearance_level, granting_agency, granted_date, expiry_date |
sam-gov | Enregistrement SAM.gov | Conformité | entity_name, cage_code, uei, registration_status, expiry_date |
jurisdiction-approval | Approbation de juridiction | Conformité | entity_name, jurisdiction, approval_type, approved_date, conditions |
attestation-of-will | Attestation de testament | Conformité | declarant_name, declaration, witness, date |
bank-verification | Vérification bancaire | Financier | account_holder, bank_name, account_type, routing_number_last4, verified_date |
credit-attestation | Attestation de crédit | Finance | entity_name, credit_score_range, reporting_agency, assessment_date |
income-verification | Vérification de revenus | Finance | individual_name, employer, annual_income_range, verification_date, tax_year |
skill-badge | Badge de compétence | Compétences et formation | earner_name, skill_name, proficiency_level, assessed_by, earned_date |
competency | Attestation de compétence | Compétences et formation | individual_name, competency, level, assessor, assessment_date |
industry-cert | Certification industrielle | Compétences et formation | holder_name, certification, issuing_body, cert_id, issued_date, expiry_date |
product-authenticity | Authenticité du produit | Chaîne d’approvisionnement | product_name, sku, serial_number, manufacturer, manufactured_date, origin_country |
chain-of-custody | Chaîne de possession | Chaîne d’approvisionnement | item_description, from_entity, to_entity, transfer_date, location, condition |
origin-verification | Vérification d’origine | Chaîne d’approvisionnement | product_name, origin_country, origin_region, certifying_body, verified_date |
custom | Personnalisé | Autre | subject, type, details |
attestation | Attestation générique | Autre | subject, claim, evidence |
En-têtes
Corps
- Structured record
- Encoded payload
Choisissez Enregistrement structuré pour sélectionner un type d'enregistrement et saisir des revendications, ou Charge utile encodée pour signer des octets existants. Ne combinez jamais les deux formats d'entrée.
Type d'enregistrement pour l'entrée structurée. Fournissez des revendications et omettez payload_b64url. Cette étiquette ne valide pas indépendamment la véracité des revendications.
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"
Horodatage Unix futur optionnel en secondes pour l'entrée de schéma/revendications structuré. Il est inclus dans la charge utile JSON signée. Pour l'entrée payload_b64url, omettez ce champ de requête et intégrez plutôt expires_at_unix à la racine de la charge utile JSON exacte. L'expiration ne peut pas être modifiée sur place.
1 <= x <= 253402300799Réponse
Attestation émise

