HLA-Verify Match API

openapi: 3.2.0
info:
  title: HLA-Verify Match API
  version: 1.0.0
  description: 'Deterministic validation of HLA nomenclature and donor-recipient match arithmetic against IPD-IMGT/HLA 3.66.0. No LLM; nothing stored. What to send: allele names, typing strings, GL strings and report text about HLA typing. What never to send: patient identifiers of any kind (names, medical record numbers, dates of birth, accession or case identifiers, other patient details). The service neither needs nor wants them, request bodies are processed in memory and never stored, and de-identifying before sending is the caller''s responsibility. This is a nomenclature and reference-release checker: not a diagnostic aid, not clinical decision support, and it does not recommend a donor. Limits are a daily call quota plus a per-call batch cap, both per tier: free 100 calls/day per IP and 250 typings per /v1/normalize call, free_key 1,000/250 (the instant self-serve key), starter 500/250, lab 10,000/5,000, scale 1,000,000/5,000, enterprise uncapped/5,000, academic 10,000/5,000 (hand-issued to accredited institutions, never sold); ''pro'' is the legacy name for ''lab''. Quotas reset at UTC midnight and every billable response carries x-hla-verify-daily-limit, -daily-remaining, -daily-reset and -max-typings. /healthz, /docs, /openapi.json, /pricing, /v1/checkout, /v1/beta-signup, /v1/research-access, /v1/keys, /v1/report and /v1/usage are not billable. Per-key usage reporting: GET /v1/usage returns the caller''s own calls and units for today/7d/30d, by endpoint and by status, plus the tier''s daily quota; cached 60s per key; 401 without a key. Free for anyone: anonymous access stays open, and anyone can get a free API key instantly (1,000 calls/day, 250 typings per call) at https://hlaverify.com/research or with POST /v1/research-access. Verified labs that need more can have the Lab tier (10,000 calls/day) by request. Nothing is for sale. Enterprise and self-hosting: hello@hlaverify.com.'
  contact:
    email: hello@hlaverify.com
    url: https://hlaverify.com
servers:
- url: https://api.hlaverify.com
- url: https://hlaverify.com
security:
- {}
- ApiKey: []
tags:
- name: Match
paths:
  /v1/match:
    post:
      summary: Donor-recipient match verdict (rules R1-R6)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - recipient
              - donor
              properties:
                framework:
                  type: string
                  enum:
                  - 6/6
                  - 8/8
                  - 10/10
                  - 12/12
                  - antigen
                  default: 8/8
                recipient:
                  $ref: '#/components/schemas/Typing'
                donor:
                  $ref: '#/components/schemas/Typing'
      responses:
        '200':
          description: verdict
          content:
            application/json:
              schema:
                type: object
                properties:
                  release:
                    type: string
                  framework:
                    type: string
                  count:
                    type: string
                    example: 7/8
                  verdicts:
                    type: object
                    additionalProperties:
                      type: string
                      enum:
                      - match
                      - mismatch
                      - potential
                  hvg_mismatches:
                    type: integer
                  gvh_mismatches:
                    type: integer
                  flags:
                    type: array
                    items:
                      type: string
                  attribution:
                    type: string
      tags:
      - Match
      operationId: postV1Match
      x-operation-id-source: derived
components:
  schemas:
    Typing:
      type: object
      description: 'locus -> up to 4 reported allele names. Allele strings only: never patient names, medical record numbers, dates of birth, or accession or case identifiers.'
      additionalProperties:
        type: array
        items:
          type: string
        maxItems: 4
      example:
        A:
        - A*02:01
        - A*24:02
        B:
        - B*07:02
        - B*44:02
        C:
        - C*07:02
        - C*05:01
        DRB1:
        - DRB1*15:01
        - DRB1*04:01
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key