List receipt types

curl --request GET \
  --url https://api.truthlocks.com/v1/receipt-types \
  --header 'X-API-Key: <api-key>'

{
  "items": [
    {
      "name": "<string>",
      "display_name": "<string>",
      "schema": {},
      "created_at": "<string>"
    }
  ]
}

GET

receipt-types

List receipt types

curl --request GET \
  --url https://api.truthlocks.com/v1/receipt-types \
  --header 'X-API-Key: <api-key>'

{
  "items": [
    {
      "name": "<string>",
      "display_name": "<string>",
      "schema": {},
      "created_at": "<string>"
    }
  ]
}

Returns all receipt types available to the authenticated tenant. Includes all five platform-defined types (globally available to every tenant) plus any custom types registered by the tenant. Use this endpoint to discover available types and inspect the JSON Schema each type enforces on the payload field when minting a receipt.

Platform-defined types

Name	Display Name	Use Case
`payment_receipt`	Payment Receipt	Payments, invoices, refunds
`security_event_receipt`	Security Event Receipt	Auth events, key rotations, anomalies
`delivery_receipt`	Delivery Receipt	Document/credential/notification delivery
`compliance_receipt`	Compliance Receipt	KYC, AML, sanctions checks
`custom_receipt`	Custom Receipt	Any tenant-defined event (open schema)

Platform types have tenant_id: null in the response. Tenant-custom types include their tenant_id.

Responses

Authorizations

X-API-Key

string

header

required

API key for machine-to-machine authentication

Response

Receipt types list

items

object[]

Show child attributes

Revoke Receipt Get receipt type

​Platform-defined types

​Responses

Authorizations

Response

Platform-defined types

Responses