> ## 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.

# Create Receipt Type

> Registers a custom receipt type with a JSON Schema for payload validation.

Creates a tenant-custom receipt type with a JSON Schema for payload validation. Platform-defined types (`payment_receipt`, `security_event_receipt`, `delivery_receipt`, `compliance_receipt`, `custom_receipt`) are read-only and cannot be overridden or replaced.

Custom types are isolated to the authenticated tenant by row-level security. Other tenants cannot see or use your custom types.

## Request body

| Field          | Type   | Required | Description                                                                                         |
| -------------- | ------ | -------- | --------------------------------------------------------------------------------------------------- |
| `name`         | string | Yes      | Unique snake\_case identifier (e.g. `invoice_receipt`). Must not conflict with platform type names. |
| `display_name` | string | Yes      | Human-readable label shown in the console UI.                                                       |
| `version`      | string | No       | SemVer string (default `1.0.0`). Create multiple versions to manage schema evolution.               |
| `schema`       | object | Yes      | Valid JSON Schema (draft 2020-12) describing the required `payload` structure.                      |
| `description`  | string | No       | Plain-text description for documentation.                                                           |

### Schema Requirements

The `schema` field must be a valid JSON Schema (draft 2020-12). Include a `required` array to enforce mandatory payload fields when minting.

```json theme={null}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "required": ["invoice_number", "amount", "currency"],
  "properties": {
    "invoice_number": { "type": "string" },
    "amount":         { "type": "integer", "description": "Amount in smallest currency unit" },
    "currency":       { "type": "string", "minLength": 3, "maxLength": 3 }
  },
  "additionalProperties": false
}
```

### Versioning

Create multiple versions of the same type by passing different `version` values (`1.0.0`, `2.0.0`, etc.). Receipts always pin the version at mint time so existing receipts are unaffected when you introduce a new version.

To deprecate an old version, use `PATCH /v1/receipt-types/{name}` with `{"status": "deprecated"}`.

### Responses


## OpenAPI

````yaml mint-openapi.yaml POST /v1/receipt-types
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks is a universal verification infrastructure for documents,
    credentials, and digital assets.

    This specification defines the canonical API for interacting with Truthlocks
    services.


    ## Base URLs

    - **Production**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Authentication

    - **API Keys**: Use `X-API-Key` header for machine-to-machine operations

    - **Bearer Tokens**: Use `Authorization: Bearer <jwt>` for user-initiated
    operations


    ## Tenant Identity

    In production, tenant identity is derived from the authenticated context
    (API key or JWT).

    The `X-Tenant-ID` header is ignored in production to prevent spoofing.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: Production API
  - url: https://sandbox-api.truthlocks.com
    description: Sandbox Environment
security:
  - APIKey: []
tags:
  - name: Authentication
    description: API key and token management
  - name: Issuers
    description: Issuer registration and trust management
  - name: Keys
    description: Cryptographic key management for issuers
  - name: Attestations
    description: Attestation lifecycle (mint, revoke, supersede)
  - name: Verification
    description: Attestation verification and proof bundles
  - name: Governance
    description: Issuer governance workflows (admin only)
  - name: Identity
    description: Organization, user, and role management
  - name: Audit
    description: Audit event queries
  - name: Platform
    description: Platform administration (super admin only)
  - name: Platform Review
    description: Staff review workflows for issuer applications
  - name: Tenant Console
    description: Tenant profile and lifecycle endpoints
  - name: Health
    description: Service health and readiness endpoints
  - name: Risk
    description: Risk signal ingestion and fraud detection
  - name: Risk Enforcement
    description: Risk enforcement actions — block, challenge, quarantine, and configuration
  - name: Billing
    description: Billing, subscription, and addon management
  - name: Machine Identity
    description: >-
      Machine Agent Identity Protocol (MAIP) — agent registration, sessions,
      trust, witness, compliance, orchestration, and observability
externalDocs:
  description: Transparency read-only API (separate service spec)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/receipt-types:
    post:
      tags:
        - Receipts
      summary: Create receipt type
      description: >-
        Registers a custom receipt type with a JSON Schema for payload
        validation.
      operationId: receiptTypes.create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - display_name
                - schema
              properties:
                name:
                  type: string
                  description: Machine-readable receipt type name
                display_name:
                  type: string
                  description: Human-readable name
                description:
                  type: string
                schema:
                  type: object
                  description: JSON Schema for payload validation
      responses:
        '201':
          description: Receipt type created
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  display_name:
                    type: string
                  schema:
                    type: object
                  created_at:
                    type: string
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Machine-readable error code
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Human-readable error message
        http_status:
          type: integer
          description: HTTP status code
        retry_after_ms:
          type: integer
          description: Milliseconds to wait before retrying (for rate limits)
        details:
          type: object
          description: Additional error context
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for machine-to-machine authentication

````