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
}Emitir uma atestação
Emita um atestado assinado usando esquema e reivindicações estruturadas, ou um payload codificado. Mantenha a mesma Idempotency-Key e corpo ao tentar novamente esta solicitação.
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
}Escolha um tipo de registro
Para um registo estruturado, escolhaschema na lista suspensa de tipo de registo e insira um objeto JSON em claims. Deixe payload_b64url vazio. O servidor serializa esses campos no payload JSON assinado. Isso identifica o tipo de registo; não estabelece independentemente que as reivindicações são verdadeiras.
Escolha um pacote de verificação
Os pacotes de verificação pertencem ao seu espaço de trabalho. Use o seletor abaixo com o mesmo ambiente e chave de API de Experimente, então copie o ID selecionado parapack_id. Omita esse campo para um registro autônomo. Você também pode usar Listar pacotes de verificação ou Emitir no Console.
Usar um payload existente
Se você já tiver os bytes exatos para assinar, omitaschema e claims. Codifique os bytes originais como base64url sem preenchimento em payload_b64url. Para JSON, serialize o objeto primeiro. Campos de aplicação como subject, claims e schema pertencem a esses bytes codificados; use-os através da entrada estruturada acima ou dentro dos bytes codificados, nunca ambos. Este endpoint não verifica independentemente a veracidade das reivindicações enviadas nem valida esquemas de credenciais arbitrários.
Use o kid da chave e o alg correspondente. O registro de chave pública por si só não torna uma chave de assinatura privada disponível. Consulte chaves do emissor.
Validade opcional
Paraschema e claims estruturados, defina expires_at_unix para um timestamp Unix futuro em segundos. O Truthlocks inclui-o na raiz do payload JSON assinado. Com payload_b64url, coloque este campo dentro do payload JSON exato antes de codificá-lo e omita o campo de solicitação separado.
Após esse instante, a verificação retorna EXPIRED. A expiração não pode ser estendida ou removida de um registro assinado existente; crie um substituto. Omita-a quando não quiser uma expiração de atestado. Datas dentro de reivindicações individuais, como o expiry_date de um passaporte, são reivindicações separadas e não definem automaticamente a expiração do atestado. Registros existentes não recebem uma data retroativamente.
Mantenha a carga útil exata e a expiração ao tentar novamente. Uma nova tentativa idempotente retorna o registro original mesmo após sua expiração.
Tentar novamente com segurança
Idempotency-Key é obrigatório. Gere um valor por cunhagem pretendida e mantenha-o com a solicitação original para novas tentativas. Não o reutilize para conteúdo diferente.
Integridade do documento
O hash do documento armazenado é selecionado nesta ordem:claims.document.sha256dentro de um payload JSON.- O
document_hashda solicitação. - SHA-256 dos bytes do payload decodificado.
document_hash_hex para verificação para comparar um hash de arquivo. Mantenha o payload original para verificação de integridade do payload.
Resposta e entrega
HTTP 201 retornaattestation_id, issued_at_unix, signature e log. A posição do log é log.leaf_index, não um log_index de nível superior.
recipient_email solicita notificação assíncrona. HTTP 201 confirma a cunhagem, não a entrega do e-mail. Omita-o ao distribuir o registro você mesmo.
Consulte o início rápido para uma solicitação usando os campos de entrada e resposta reais.
Guia de campo de tipo de registro
Esses campos são estruturas de reivindicação sugeridas, não uma garantia de validação de reivindicação ou verificação de identidade.| ID do Esquema | Nome | Categoria | Campos de Reivindicação |
|---|---|---|---|
verifiable-id | ID Verificável | Identidade | full_name, employee_id, department, title, start_date |
passport | Passaporte | Identidade | full_name, nationality, passport_number, date_of_birth, expiry_date, issuing_country |
drivers-license | Carteira de Motorista | Identidade | full_name, license_number, state, class, expiry_date, date_of_birth |
government-id | ID Governamental | Identidade | full_name, id_number, id_type, issuing_authority, country, expiry_date |
self-sovereign-id | ID Auto-Soberana | Identidade | did, display_name, created_at |
employment-verification | Verificação de Emprego | Emprego | employee_name, employer, position, department, employment_type, start_date, end_date |
professional-role | Função Profissional | Emprego | full_name, title, organization, department, effective_date |
membership-card | Cartão de Membro | Emprego | member_name, organization, membership_id, tier, valid_from, valid_to |
professional-certification | Certificação Profissional | Emprego | holder_name, certification_name, issuing_body, certification_id, issued_date, expiry_date |
license | Licença | Emprego | holder_name, license_type, license_number, issuing_authority, jurisdiction, issued_date, expiry_date |
accreditation | Acreditação | Emprego | entity_name, accreditation_body, standard, scope, valid_from, valid_to |
degree | Grau | Educação | student_name, institution, degree_type, field_of_study, graduation_date, honors |
completion-cert | Certificado de Conclusão | Educação | participant_name, program_name, institution, completion_date, hours |
course-credit | Crédito de Curso | Educação | student_name, course_name, institution, credits, grade, semester |
transcript | Histórico Escolar | Educação | student_name, institution, program, gpa, total_credits, issue_date |
micro-credential | Micro-Credencial | Educação | earner_name, credential_name, issuer, skills, earned_date |
training-completion | Conclusão de Treinamento | Educação | trainee_name, training_program, provider, completion_date, score, certificate_id |
medical-license | Licença Médica | Saúde | practitioner_name, license_number, specialty, state, issued_date, expiry_date |
dea-registration | Registro DEA | Saúde | registrant_name, dea_number, schedules, business_activity, expiry_date |
board-certification | Certificação de Conselho | Saúde | physician_name, board, specialty, certification_date, expiry_date |
health-credential | Credencial de Saúde | Saúde | patient_name, credential_type, provider, date, details |
vaccination-record | Registro de Vacinação | Saúde | patient_name, vaccine_name, manufacturer, lot_number, date_administered, dose_number, site |
aml-kyc | Verificação AML/KYC | Conformidade | entity_name, check_type, result, risk_level, verified_by, verified_at |
security-clearance | Autorização de Segurança | Conformidade | holder_name, clearance_level, granting_agency, granted_date, expiry_date |
sam-gov | Registro SAM.gov | Conformidade | entity_name, cage_code, uei, registration_status, expiry_date |
jurisdiction-approval | Aprovação de Jurisdição | Conformidade | entity_name, jurisdiction, approval_type, approved_date, conditions |
attestation-of-will | Atestado de Testamento | Conformidade | declarant_name, declaration, witness, date |
bank-verification | Verificação Bancária | Financeiro | account_holder, bank_name, account_type, routing_number_last4, verified_date |
credit-attestation | Atestado de Crédito | Financeiro | entity_name, credit_score_range, reporting_agency, assessment_date |
income-verification | Verificação de Renda | Financeiro | individual_name, employer, annual_income_range, verification_date, tax_year |
skill-badge | Selo de Habilidade | Habilidades e Treinamento | earner_name, skill_name, proficiency_level, assessed_by, earned_date |
competency | Atestado de Competência | Habilidades e Treinamento | individual_name, competency, level, assessor, assessment_date |
industry-cert | Certificação da Indústria | Habilidades e Treinamento | holder_name, certification, issuing_body, cert_id, issued_date, expiry_date |
product-authenticity | Autenticidade do Produto | Cadeia de Suprimentos | product_name, sku, serial_number, manufacturer, manufactured_date, origin_country |
chain-of-custody | Cadeia de Custódia | Cadeia de Suprimentos | item_description, from_entity, to_entity, transfer_date, location, condition |
origin-verification | Verificação de Origem | Cadeia de Suprimentos | product_name, origin_country, origin_region, certifying_body, verified_date |
custom | Personalizado | Outro | subject, type, details |
attestation | Atestado Genérico | Outro | subject, claim, evidence |
Cabeçalhos
Corpo
- Structured record
- Encoded payload
Escolha Registro estruturado para selecionar um tipo de registro e inserir reivindicações, ou Payload codificado para assinar bytes existentes. Nunca combine ambos os formatos de entrada.
Tipo de registro para entrada estruturada. Forneça reivindicações e omita payload_b64url. Este rótulo não valida independentemente a veracidade das reivindicações.
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"
Timestamp Unix futuro opcional em segundos para entrada de esquema/declarações estruturadas. Ele é incluído no payload JSON assinado. Para entrada payload_b64url, omita este campo de solicitação e incorpore expires_at_unix na raiz do payload JSON exato. A expiração não pode ser alterada no local.
1 <= x <= 253402300799Resposta
Atestação cunhada

