Skip to main content
API

Container names in the appointment preview become product names

From the next release, containers[].name in Preview Appointment is the tube’s product name. type does not change, so read type if your app compares containers.
Admin panelAPI

Aniva now works in every EU language, and a few more

API

One List Panels endpoint

  • List Panels now returns biomarker_groups. Use it instead of /api/v2/panels.
  • Create Panel is removed. Use the Admin Panel.
API

Show lab results inside your app

Your patients can now see their lab results inside your app: the biomarker list, the trend of each biomarker, and a 3D twin with a grade per health area. The page uses your brand colour and your logo, in light or dark mode.The results page is a paid add-on, and your contact at Aniva can tell you the price. Create Embed Session shows how to set it up.
API

List API reads are cached for up to 5 minutes

These four endpoints now cache their response for up to 5 minutes, so a change can take up to 5 minutes to show:The Get endpoints still show changes directly.If you poll the API to find changes, use webhooks instead. A webhook tells you about each change as it happens. See Repeated reads.
Admin panel

See when the courier comes for your samples

The admin panel now shows the next courier pickup at your practice, with tracking and label.Admin panel with a banner at the top: GO! coming tomorrow ~10:00–12:00.Admin panel with a banner at the top: GO! coming tomorrow ~10:00–12:00.
API

Aniva ranges are now available

Your results can now include the Aniva ranges: a general range and a narrower range for each biomarker, with the sources that Aniva recorded. The ranges differ by age, sex and pregnancy week.To get access, sign the short agreement on Aniva ranges. We then switch them on for your API key. Ask your contact at Aniva for the agreement.The ranges are in the new field aniva_range. It replaces reference_range_aniva, which was always null. The ranges are general information. They do not assess a result, and they are not medical advice or a medical device. The range of the laboratory stays the standard. See Aniva ranges.
API

The fluoride tube is now fluoride

Preview Containers names the fluoride tube fluoride. The old value was naf. If your code compares container.type with naf, change it to fluoride.Two new values can appear: lihep_capillary and fluoride_capillary. They are the capillary lithium heparin tube and the capillary fluoride tube.
API

No more double bookings of the last slot

If two bookings for the last place in a slot arrive at the same time, only one succeeds. The other gets 409, like any full slot. The same applies when an appointment is changed while it is being cancelled or confirmed.Confirm Blood Draw has three new 409 reasons:
  • remapped: the code now maps to different panels than before.
  • sent_to_lab and order_in_flight: the lab may already have the order, so the code must stay on its tube.
APIHome kits

Stricter delivery addresses on home kit orders

Create Home Kit and Update Home Kit check delivery_address more strictly.
  • country_code accepts lower case, e.g. de. Aniva stores and returns it in upper case.
  • A German address (DE) needs a postal_code of exactly 5 digits. Other values get a 400.
  • Spaces around postal_code are removed before we store it.
Admin panelHome kitsAPI

A new kit for a kit sent back to us

When the carrier sends a kit back to us, we no longer wait for the box. Tell us you want the kit again, and we send a new kit right away. You can also create it yourself: call Create Home Kit with replaces_home_kit_order_id set to the returned kit. The new kit is a separate order with a new kit code.We check the returned box when it arrives. Then the returned kit changes to cancelled, and you see what was in the box.
ResultsAPIAdmin panel

Email your team when results are ready

Ask us to set a default email address for your profile group, for example your team inbox. It then gets an email when the results of a new booking are ready. This covers bookings from the admin panel, from the API and from your patients.To change it for one booking:
  • Admin panel: edit the email addresses, or turn off “Email me when the results are ready”.
  • API: send a list in results_ready_emails to use those email addresses instead. To keep your default email address, include it in the list. Send [] for no email.
See Results-ready emails.
APIHome kits

The patient enters birthdate and sex

We can now let your profile group create a profile without date_of_birth and sex. The patient enters both on the kit activation page, with the birthdate typed twice. Ask us to turn it on. See Profiles.
Admin panel

A faster admin panel

The admin panel now shows the first content in about 0.2 s, down from 1.3 s. No more loading spinners. Pages fill in as their data arrives. Pages start loading when you hover over a link.
Admin panelHome kitsWebhooks

Kits sent back to us

When the carrier sends a kit back to us, the Home Kits page now shows it. Filter by Sent back to see every kit the carrier returned to us, with the carrier’s reason. The shipment ends in fault and fires shipment.fault, no longer delivered. Once we open the box, you also see what was in it: complete, a part missing, or opened. That tells you whether your customer gets a full refund.Want us to send the kit out again? Message us with the kit code and the correct delivery address. We ship it with the same kit code.
API

Logarithmic units

List Units returns a third unit_type: logarithmic, for a value that is the logarithm of a quantity, such as pH or an atherogenic index. Treat it like physical when you display it. Do not scale it: two logarithmic units differ by an offset, not a factor.
APIPricing

Quote a home kit with its fees

Quote Cart takes fulfilment. Send home_kit with a country_code and the bill adds the kit lines your monthly invoice bills for one order: the kit fee, the collection devices, postage to that country and back, the sleeve and a spare lancet bag. The default stays a draw at a location with the appointment fees. The response says which one it priced in fulfilment.kind.
Concierge

Meet the Aniva Concierge

From now on, our changelog also shows up in your Slack channel with us, as soon as we ship something.We also built the Aniva Concierge. Got a question about the API or the admin panel? Mention @Aniva in Slack, or just reply under a changelog post. It checks our docs and tells you where to click in the admin panel, or which endpoint and filters to use, with a link to the page.
APIAppointments

List one day’s appointments

List Appointments takes two new filters. date (YYYY-MM-DD) returns one calendar day, in each appointment’s location time zone, earliest first. location_id returns one test location. Use both for a location’s schedule today.
APIProfiles

Duplicate profiles are refused

Create Profile now returns 409 with error_name: "duplicate_profile_error" when a profile your key can see has the same first name, last name, sex and date of birth. The response names the existing profile_id. Use it instead of creating a second profile. The sandbox surnames are exempt.
Locations

Aniva Berlin Mitte closes

From November 1, 2026, Aniva Berlin Mitte (206e8e2e-1ae6-401b-9dfe-781d639210ed) no longer offers appointments. The closest location is Aniva Berlin P-Berg | Mariposa (f7897229-5c37-409b-bb43-dc8b50687fbc), Kastanienallee 83, 10435 Berlin.
Admin panelPricing

Test catalog with your prices

The new Test catalog in the admin panel lists every biomarker with its labs, tubes and price on your rate card.
APIResults

Why a result has no lab range

Each clinical result on Get Results and Get Lab Results for home kits now has reference_range_lab_absent_reason. It says why reference_range_lab is null:
  • not_provided: no range exists. Show “Not applicable”.
  • lab_text_only: the lab printed only text, such as a target or a risk tier. Show lab_reported.reference_range.
  • not_measured: the result is undeliverable.
It is null when a range is present. See Results.
APILocations

Retail prices and coordinates

  • Locations now have state_code, latitude and longitude.
  • List Retail Prices and Get Retail Prices return the price of each panel a pharmacy sells to walk-in customers.
  • The location.retail_prices.updated webhook tells you when a price changes.
The retail price endpoints and event need the retail_prices_view scope.
Home kitsAdmin panel

Order home kits in the admin panel

You can now order a home kit for your patient on the Home kits page in the admin panel. Pick or create the patient, pick the kit and enter the delivery address. You can also cancel a kit there.
APIPricing

Rate card and quotes

  • Get Rate Card returns your rates on the Aniva catalog and your fees.
  • Quote Cart prices panels and biomarkers without an appointment.
  • The bill on Quote Cart and Preview Appointment now has fees, total_with_fees_cents and a name on each biomarker row.
  • rate_card on the listings takes the id from Get Rate Card.
Both new endpoints need the prices_view scope.
APIResults

More document details

Each entry in documents on Get Results now has:
  • file_name: the name Download Document uses.
  • New: original_file_name, origin, content_type, etag, size_bytes.
A replaced report PDF now sends results.updated, for example Labor Quade’s final report (_E) after the preliminary one (_V).
APIWebhooks

Webhooks

Aniva now calls your server when an appointment, a home kit order, its results, a location, a profile or a shipment changes. You no longer need to poll.
  • Register an HTTPS URL with Create Webhook. You need the webhooks_manage scope. Ask Aniva to add it to your key, or to set up the webhook for you.
  • Events cover every status of an appointment and a home kit order, a new time or location, and every change of the results. results.completed tells you that the results are final.
  • location.*, profile.* and shipment.* events tell you when a location, a profile or a shipment appears, changes or goes away. A shipment also sends shipment.<status> on every status change.
  • Events carry ids and statuses, never lab values or personal data. Read the url in the event to get the data.
  • Every request is signed with the Standard Webhooks scheme.
  • Aniva retries a failed delivery 10 times over about three days. You can list and resend deliveries for 30 days.
  • Each result on Get Results now has an id, so you can update the result a results.updated event points to.
  • Get Location returns one location by its id. The url of a location.* event points to it.
See Webhooks.
ResultsAdmin panel

Email the results to the customer

You can now email a customer that their lab results are ready. Send it from the Lab results page in the admin panel, or through two new endpoints: Email Results for appointments and Email Results for home kit orders.
  • The email can attach the lab reports as PDF files. Each PDF is password-protected: the password is the customer’s date of birth as 8 digits (DDMMYYYY), and the email says so.
  • You can add a personal note of at most 1000 characters.
  • It shows the name and the logo of the profile’s primary profile group, in the profile language.
  • Each send is one email. A retry sends a second one. You need the results_view scope for that customer.

Get an email when results are ready

When you book an appointment or order a replacement home kit in the admin panel, you can turn on “Email me when the results are ready”. We then send one email to you, or to any address you type, once every lab result is in. The email links to the result in the admin panel. The customer does not get this email. You need the results_view scope for that customer.Through the API, you can set up to 5 addresses in results_ready_emails on Create Appointment, Create Home Kit Order, Update Appointment and Update Home Kit Order.
Home kits

Send the recipient’s phone and email with each kit

If the delivery_address of a home kit has phone or email, we pass them to the carrier. The carrier then tells the recipient when the parcel is on its way or waits at a pickup point. If you leave them out, the carrier gets no contact, even if the profile has one. You decide who gets carrier notices. The notice may name Aniva Health as the sender.See Create Home Kit Order.
Locations

Aniva Berlin P-Berg (Mariposa), Potsdam, Mannheim and Wiesbaden

Four new locations for venous blood draws. See List locations.
Admin panel

Lab results page

The new Lab results page in the admin panel lists every blood draw and every activated home kit with its lab reports. Search by name, birthday or tube barcode. You need the results_view scope, and a home-kit grant to see kits.
Home kits

Activate-only API keys

The new home_kit_orders_activate scope lets a key activate home kits and nothing else. It cannot create, change or cancel a kit. Ask Aniva for such a key if a separate system activates your kits.See Activate Home Kit Order.
APIBreaking

Sex must be male or female

Create Profile and Update Profile no longer accept sex: 0 (unknown). Send 1 for male or 2 for female; 0 returns 400. The laboratory needs the sex for the reference ranges, and an order for a profile without one could not reach the laboratory.See Create Profile.
Home kits

Kits that reach the lab without activation

If a sample reaches the laboratory before its kit is activated, Aniva activates the kit. activated_at is the morning of the first tracking event of the return parcel, or the morning the sample arrived at the laboratory if there is no tracking. A later Activate call with a different activated_at returns 409.See Activate Home Kit Order.
API

Aniva ranges in results

The results endpoints now fill reference_range_aniva with the comparison values that Aniva compiled, converted to the unit of the result. The values differ by age, sex and pregnancy week. Your key needs the ANIVA_REFERENCE_RANGES_VIEW scope. Without it, the field is null.See Get appointment results.
APIHome kits

Replacement kits

Order a replacement when a kit could not deliver all results. A replacement is a new order with a new lab code and keeps the panel of the original order. biomarker_ids sets what the laboratory runs again.See Home kit orders.
APIPricingBreaking

One price per biomarker and panel

Biomarkers and panels carry one price_cents at your rate card, with retail_cents beside it:
  • > 0: orderable on its own.
  • 0: a ratio (see requires), or orderable only with other markers (see positions).
  • null: not priced, so not orderable.
Breaking: groups[] is removed from the listings and from the appointment preview. The retail and yours price fields are removed.See Pricing.
API

Idempotency keys

The create endpoints for profiles, appointments, home kit orders and shipments accept an Idempotency-Key header. A retry with the same key returns the first response and writes nothing.See Idempotency.
Locations

Aniva Hannover, Düsseldorf, Duisburg and Essen

Four new Aniva locations in Germany are open for venous blood draws: Hannover, Düsseldorf, Duisburg and Essen. Call List locations to see the locations your key can book.