Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

Creates a cryptographically signed, transparency-log-anchored receipt event. Receipts are validated against the registered receipt type schema before signing.

​
Receipt types

TypeNameRequired Fields
payment_receiptPayment Receiptamount, currency, provider, provider_reference, subject
security_event_receiptSecurity Event Receiptevent_type, severity, subject, outcome
delivery_receiptDelivery Receiptitem_reference, recipient, delivery_method, delivered_at
compliance_receiptCompliance Receiptcheck_type, subject, result, framework
custom_receiptCustom Receiptsubject, event

​
Headers

​
Idempotency-Key
string
required
UUID for idempotent minting. If you submit the same key twice, the original receipt is returned.

​
Request

​
issuer_id
string
required
UUID of the issuer signing the receipt.
​
kid
string
required
Key ID of the signing key.
​
alg
string
required
Signing algorithm: Ed25519, ES256, or RS256.
​
receipt_type
string
required
Receipt type name (e.g. payment_receipt, security_event_receipt, or a custom type).
​
subject
string
required
Subject identifier for the receipt.
​
payload
object
required
Receipt payload — validated against the receipt type’s JSON Schema.
​
metadata
object
Optional metadata attached to the receipt envelope.

​
Response

​
receipt_id
string
UUID of the created receipt.
​
receipt_type
string
The receipt type name.
​
status
string
active
​
issuer_id
string
UUID of the signing issuer.
​
subject
string
Subject identifier.
​
signature
object
Cryptographic signature: alg, kid, value.
​
issued_at
string
ISO 8601 timestamp.

​
Webhook event

A receipt.created webhook event is delivered to all configured endpoints after a successful mint.