HLA-Verify Report API
The Report API from HLA-Verify — 2 operation(s) for report.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/hlaverify-com:hlaverify-com-report-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: HLA-Verify Report 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: Report
paths:
/v1/report:
post:
summary: Report an answer you believe is wrong (support portal intake)
description: 'Files one support report: a verdict, normalization or lookup that looks wrong, a docs page that disagrees with the API, an outdated release, or a question. Every report is rerun against the live API and the IPD-IMGT/HLA reference data, and a person confirms any error before it is published; a confirmed error is fixed and listed with the release that fixed it. Returns an id to follow it with GET /v1/report/{id} or at https://hlaverify.com/support?id=... . Do not include patient identifiers of any kind, names included: obvious ones (record-number and DOB labels, SSNs, US-format dates) are refused with 422 and nothing is stored, and a name cannot be detected. Stores what you send plus a timestamp, CF-IPCountry and the live release, and no IP address, in a store separate from API keys. At most 20 reports a day per IP. Not billable against the daily quota, but rate limited like every other /v1/ route (60 requests/minute per IP without a key).'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- input
- expected
properties:
kind:
type: string
enum:
- wrong_result
- docs_mismatch
- outdated_release
- question
- other
default: wrong_result
endpoint:
type: string
maxLength: 60
example: /v1/verify
input:
type: string
maxLength: 2000
example: B*07:02
description: The HLA names or request you sent. No patient identifiers.
received:
type: string
maxLength: 4000
description: What the API answered.
expected:
type: string
maxLength: 1000
example: a valid allele, not flagged
description: What you expected instead.
details:
type: string
maxLength: 2000
email:
type: string
maxLength: 254
example: you@lab.example
description: Optional; where we reply.
request_id:
type: string
maxLength: 100
source:
type: string
maxLength: 120
description: 'Free-text hint: site, mcp, docs.'
responses:
'200':
description: recorded
content:
application/json:
schema:
type: object
required:
- ok
- id
- status
- status_url
- message
- release
properties:
ok:
type: boolean
id:
type: string
pattern: ^r[0-9a-f]{16}$
status:
type: string
enum:
- received
status_url:
type: string
message:
type: string
release:
type: string
'422':
description: a missing or empty required field, an unknown kind, an oversized field, an invalid email, or something shaped like a patient identifier
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: 'rate limited: 60 req/min per IP, or more than 20 reports today from this IP (/v1/report does not consume daily quota)'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'503':
description: the report store is not available on this deployment
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Report
operationId: postV1Report
x-operation-id-source: derived
/v1/report/{id}:
get:
summary: 'Follow a support report: its public status only'
description: Status, public note and the release that fixed it. Never the input or the email address. Not billable.
parameters:
- name: id
in: path
required: true
schema:
type: string
pattern: ^r[0-9a-f]{16}$
responses:
'200':
description: the report's public status
content:
application/json:
schema:
type: object
required:
- id
- kind
- status
- created
- updated
properties:
id:
type: string
kind:
type: string
status:
type: string
enum:
- received
- investigating
- confirmed
- fixed
- expected_behavior
- duplicate
- needs_info
created:
type: string
updated:
type: string
note:
type:
- string
- 'null'
fixed_in:
type:
- string
- 'null'
release_at_report:
type:
- string
- 'null'
'404':
description: no report with that id
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Report
operationId: getV1ReportById
x-operation-id-source: derived
components:
schemas:
Error:
type: object
properties:
detail:
type: string
securitySchemes:
ApiKey:
type: apiKey
in: header
name: X-API-Key