Create Profile

POST

api

profiles

curl --request POST \
  --url https://anivahealth.com/api/v1/profiles \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Maria",
    "last_name": "Schmidt",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "profile_group": "acme-clinic-berlin",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "marketing_emails_enabled": false
  }'

{
  "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "handle": null,
  "first_name": "Maria",
  "last_name": "Schmidt",
  "email": "maria.schmidt@example.com",
  "phone": "+4930123456789",
  "sex": 2,
  "date_of_birth": "1985-03-22",
  "height": 168,
  "weight": 65,
  "language": "de",
  "transactional_emails_enabled": true,
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": null
}

{
  "error": "date_of_birth must be a date in the past"
}

{
  "error": "Profile group not found"
}

Create a new patient profile and assign it to a profile group. The profile holds demographic data used across appointments and lab orders. Send an optional Idempotency-Key header to make this create safe to retry — a repeat of the same key returns the original response instead of creating a second one. See Idempotency.

Request

Body parameters

string

required

First name of the patient. Must use latin characters, between 1 and 100 characters.

string

required

Last name of the patient. Must use latin characters, between 1 and 100 characters. Labs reject orders for a patient without a surname, so a profile cannot be created without one.Three values are reserved to seed test fixtures — see Sandbox test fixtures.

integer

required

Biological sex per ISO/IEC 5218. Use 0 for unknown, 1 for male, 2 for female.

string

required

Date of birth in YYYY-MM-DD format. Must be a date in the past.

string

required

Polymorphic reference (UUID or slug) to the profile group to assign this profile to. The UUID is the immutable identifier and survives slug renames; the slug remains accepted for marketing and partner integrations built on readable identifiers. UUID is preferred. The profile group must be within your API key’s access context.

string

Email address for the profile. If omitted, Aniva auto-generates an email address.Supplying email also makes the create retry-safe: an address can only ever have one profile, so a repeated request returns 409 instead of a second profile. Auto-generated addresses are unique per request, so repeats without email DO create separate profiles — send email if your integration retries.

string

Phone number in E.164 format (e.g., +14155552671).

number

Height in centimeters.

number

Weight in kilograms.

string

default:"en"

Preferred language for the profile. Accepted values: en, de, fi. Defaults to en.

boolean

Whether this profile should receive transactional (programmatic) emails — appointment confirmations, result-ready notices, etc. Overrides the profile group default. Distinct from marketing opt-in. Omit to use the default.

boolean

Whether this profile opts in to marketing emails (newsletters, product updates). Overrides the profile group default. Distinct from transactional emails. Omit to use the profile group default. Write-only: not returned in the profile response.

Sandbox test fixtures

Every read path worth testing — List Appointments, Get Results, Download Document — is empty until a real blood draw happens days later. That makes an automated integration test awkward to write. Three last_name values are reserved to solve it. Create a profile with one and Aniva pre-populates the state described below before responding, so your next call already sees it:

`last_name`	What the profile gets
`Upcomingtestmann`	One upcoming `confirmed` appointment with a panel attached. No results yet.
`Partialtestmann`	One past `blood_drawn` appointment. Roughly half the panel is reported; Get Results is `in_progress`.
`Fulltestmann`	One past `blood_drawn` appointment. Every biomarker in the panel is reported, `status: "completed"`, and a lab report PDF in `documents[]`.

Matching is case-insensitive. Every other field — including date_of_birth and sex — is stored and used normally, so the reference ranges you get back are the real age- and sex-specific ones for the profile you created. The appointment is booked at the Aniva Test location, on a real bookable slot at least five days from now (or five days ago, for the past states). Seeding it places no lab order and books no courier.

Give test profiles an address you control. Aniva’s appointment reminders are driven by scheduled_at, so the upcoming fixture will send them unless the profile is opted out via transactional_emails_enabled: false.

The panel is picked at random from the ones your API key can see, so its panel_id always resolves against your own List Panels. Clinical biomarkers get a value inside the biomarker’s reference range; genes get a random genotype from Aniva’s reference data, with the matching variants, clinical significance and rs ids following from it.

Panel and values are regenerated on every create, so assert on shape rather than on a specific panel or exact numbers.

Response

On success, the API returns 201 Created with the newly created profile.

string

required

Unique profile identifier (UUID).

string

Profile handle or username. May be null.

string

First name. May be null.

string

Last name. May be null.

string

Email address. May be null.

string

Phone number in E.164 format. May be null.

integer

Biological sex per ISO/IEC 5218 (0 = unknown, 1 = male, 2 = female). May be null.

string

Date of birth in YYYY-MM-DD format. May be null.

number

Height in centimeters. May be null.

number

Weight in kilograms. May be null.

string

Preferred language (en, de, or fi).

boolean

Whether this profile receives transactional (programmatic) emails. null when never set.

string

ISO 8601 timestamp of when the profile was created.

string

ISO 8601 timestamp of the last update. null for newly-created profiles.

Error responses

Status	Description
`400`	Validation error — one or more fields failed validation.
`403`	Forbidden — your API key does not have access to this operation or the profile group is outside your access context.
`404`	Profile group not found.
`409`	A profile already exists for the supplied `email` (the response carries the address), or the `Idempotency-Key` was reused with a different body, or its original request has not completed.
`500`	Internal server error.

A 409 looks like this — treat it as “this profile already exists” and look it up with List Profiles (?email=) rather than retrying the create:

{
  "error": "An account with the email \"maria.schmidt@example.com\" already exists.",
  "errorName": "EmailExistsError",
  "email": "maria.schmidt@example.com"
}

curl --request POST \
  --url https://anivahealth.com/api/v1/profiles \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Maria",
    "last_name": "Schmidt",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "profile_group": "acme-clinic-berlin",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "marketing_emails_enabled": false
  }'

{
  "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "handle": null,
  "first_name": "Maria",
  "last_name": "Schmidt",
  "email": "maria.schmidt@example.com",
  "phone": "+4930123456789",
  "sex": 2,
  "date_of_birth": "1985-03-22",
  "height": 168,
  "weight": 65,
  "language": "de",
  "transactional_emails_enabled": true,
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": null
}

{
  "error": "date_of_birth must be a date in the past"
}

{
  "error": "Profile group not found"
}

curl --request POST \
  --url https://anivahealth.com/api/v1/profiles \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Maria",
    "last_name": "Schmidt",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "profile_group": "acme-clinic-berlin",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "marketing_emails_enabled": false
  }'

{
  "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "handle": null,
  "first_name": "Maria",
  "last_name": "Schmidt",
  "email": "maria.schmidt@example.com",
  "phone": "+4930123456789",
  "sex": 2,
  "date_of_birth": "1985-03-22",
  "height": 168,
  "weight": 65,
  "language": "de",
  "transactional_emails_enabled": true,
  "created_at": "2026-04-01T09:14:32Z",
  "updated_at": null
}

{
  "error": "date_of_birth must be a date in the past"
}

{
  "error": "Profile group not found"
}

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Create Profile

Request

Body parameters

Sandbox test fixtures

Response

Error responses

​Request

​Body parameters

​Sandbox test fixtures

​Response

​Error responses

Request

Body parameters

Sandbox test fixtures

Response

Error responses