> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Створити профіль

> Створити новий профіль пацієнта та додати його до групи профілів

Створи новий профіль пацієнта й додай його до групи профілів. Профіль зберігає демографічні дані, які використовуються для записів і лабораторних замовлень.

Потребує дозволу `create_user`.

Надішли необов’язковий заголовок `Idempotency-Key`, щоб зробити повторний запит на створення безпечним — повторення з тим самим ключем повертає початкову відповідь замість створення другого запису. Див. [Ідемпотентність](https://docs.anivahealth.com/uk/concepts/idempotency.md).

## Запит

### Параметри тіла запиту

**first\_name** `string` *required*

Ім’я пацієнта. Має бути записане латиницею, від 1 до 100 символів.

**last\_name** `string` *required*

Прізвище пацієнта. Має бути записане латиницею, від 1 до 100 символів. Лабораторії відхиляють
замовлення для пацієнта без прізвища, тому профіль не можна створити без нього.

Три значення зарезервовано для створення тестових даних — див. [Тестові дані для sandbox](#testovi-dani-dlya-sandbox).

**sex** `integer` *required*

Біологічна стать за ISO/IEC 5218. Використовуй `1` для чоловічої, `2` для жіночої. Лабораторія потребує її для
референтних діапазонів, тому `0` (невідомо) повертає `400`. Обов’язкове поле, якщо тільки твоя група профілів не дозволяє
пацієнту вказати стать на сторінці активації набору. У такому разі пропусти його. Див.
[Дозволити пацієнту вказати дату народження та стать](https://docs.anivahealth.com/uk/concepts/profiles.md#dozvoliti-patsiyentu-vvesti-datu-narodzhennya-i-stat).

**date\_of\_birth** `string` *required*

Дата народження у форматі `YYYY-MM-DD`. Має бути в минулому й не раніше 1900 року. Вік
має становити від 16 до 100 років. Інші значення повертають `400`. Обов’язкове поле, якщо тільки твоя група профілів не дозволяє
пацієнту вказати дату на сторінці активації набору. У такому разі пропусти його.

**profile\_group** `string` *required*

Поліморфне посилання (UUID або slug) на групу профілів, до якої потрібно додати цей профіль. UUID є
незмінним ідентифікатором і зберігається після перейменування slug; slug і надалі приймається для маркетингових і
партнерських інтеграцій на основі читабельних ідентифікаторів. Краще використовувати UUID. Група профілів має бути
в контексті доступу твого API-ключа. Обов’язкове поле, якщо ти не передаєш застаріле поле
`profile_group_slug`.

**profile\_group\_slug** `string` *deprecated*

Застаріле: використовуй `profile_group`. Slug групи профілів. Лише малі літери, цифри, дефіси та
підкреслення.

**email** `string`

Електронна адреса для профілю. Якщо не вказано, Aniva автоматично згенерує електронну адресу.

Передача `email` також робить створення **безпечним для повторних запитів**: одна адреса може мати лише один профіль, тому
повторний запит поверне `409` замість створення другого профілю. Автоматично згенеровані адреси унікальні для кожного
запиту. Надсилай `email` або `Idempotency-Key`, якщо твоя інтеграція повторює запити.

**phone** `string`

Номер телефону у форматі E.164 (наприклад, `+14155552671`).

**height** `number`

Зріст у сантиметрах.

**weight** `number`

Вага в кілограмах.

**language** `string` (default: en)

Бажана мова для профілю: `en`, `bg`, `ca`, `cs`, `da`, `de`, `el`, `es`, `et`, `fi`, `fr`, `ga`, `hr`, `hu`, `is`, `it`, `lb`, `lt`, `lv`, `mt`, `nl`, `no`, `pl`, `pt`, `ro`, `ru`, `sk`, `sl`, `sr`, `sv`, `tr` або `uk`. Типове значення — `en`.

**transactional\_emails\_enabled** `boolean`

Чи має цей профіль отримувати транзакційні (автоматичні) листи — підтвердження
записів, сповіщення про готовність результатів тощо. Перевизначає типове налаштування групи профілів. Не залежить від
згоди на маркетингові розсилки. Пропусти, щоб використати типове значення.

**marketing\_emails\_enabled** `boolean`

Чи погоджується цей профіль на маркетингові листи (розсилки, оновлення продукту). Перевизначає
типове налаштування групи профілів. Не залежить від транзакційних листів. Пропусти, щоб використати типове налаштування групи профілів.
Лише для запису: не повертається у відповіді профілю.

## Тестові дані для sandbox

Кожен шлях читання, який варто протестувати — [Список записів](https://docs.anivahealth.com/uk/api/appointments/list-appointments.md),
[Отримати результати](https://docs.anivahealth.com/uk/api/appointments/get-results.md),
[Завантажити документ](https://docs.anivahealth.com/uk/api/documents/download-document.md) — залишається порожнім, доки через кілька днів не відбудеться реальний забір крові.
Через це складно писати автоматизовані інтеграційні тести.

Щоб вирішити це, зарезервовано три значення `last_name`. Створи профіль з одним із них, і Aniva
попередньо заповнить описаний нижче стан перед відповіддю, тому твій наступний виклик уже його побачить:

| `last_name` | Що отримує профіль |
| - | - |
| `Upcomingtestmann` | Один майбутній запис зі статусом `confirmed` і прикріпленою панеллю. Результатів ще немає. |
| `Partialtestmann` | Один минулий запис зі статусом `blood_drawn`. Є результати приблизно для **половини** панелі; [Отримати результати](https://docs.anivahealth.com/uk/api/appointments/get-results.md) має статус `in_progress`. |
| `Fulltestmann` | Один минулий запис зі статусом `blood_drawn`. Є результати для **кожного** біомаркера в панелі, `status: "completed"` і PDF лабораторного звіту в `documents[]`. |

Зіставлення не чутливе до регістру. Усі інші поля — включно з `date_of_birth` і `sex` — зберігаються й
використовуються як зазвичай, тому референтні діапазони, які ти отримаєш, є реальними для віку та статі
створеного тобою профілю.

Запис бронюється в локації **Aniva Test** на реальний доступний слот щонайменше через п’ять днів
від сьогодні (або п’ять днів тому для минулих станів). Генерація цих даних не створює замовлення в лабораторії й не замовляє
кур’єра.

> [!NOTE]
>
> Вказуй для тестових профілів адресу, яку ти контролюєш. Нагадування про запис в Aniva працюють за полем
> `scheduled_at`, тому фікстура майбутнього запису надсилатиме їх, якщо для профілю не вимкнено розсилку через
> `transactional_emails_enabled: false`.

Панель обирається випадково з тих, які бачить твій API-ключ, тому її `panel_id` завжди можна знайти
через [Список панелей](https://docs.anivahealth.com/uk/api/panels/list-panels.md). Клінічні біомаркери отримують значення в межах
референтного діапазону біомаркера; гени отримують випадковий генотип із довідкових даних Aniva, а з нього випливають відповідні варіанти, клінічна значущість та rs-ідентифікатори.

> [!NOTE]
>
> Панель і значення генеруються заново під час кожного створення, тому перевіряй структуру, а не конкретну
> панель чи точні числа.

## Відповідь

У разі успіху API повертає `201 Created` із щойно створеним профілем.

**id** `string` *required*

Унікальний ідентифікатор профілю (UUID).

**handle** `string`

Псевдонім або ім’я користувача профілю. Може бути `null`.

**first\_name** `string`

Ім’я. Може бути `null`.

**last\_name** `string`

Прізвище. Може бути `null`.

**email** `string`

Електронна адреса. Може бути `null`.

**phone** `string`

Номер телефону у форматі E.164. Може бути `null`.

**sex** `integer`

Біологічна стать за ISO/IEC 5218 (`0` = невідома, `1` = чоловіча, `2` = жіноча). Може бути `null`.

**date\_of\_birth** `string`

Дата народження у форматі `YYYY-MM-DD`. Може бути `null`.

**height** `number`

Зріст у сантиметрах. Може бути `null`.

**weight** `number`

Вага в кілограмах. Може бути `null`.

**language** `string`

Бажана мова, один із 32 кодів вище.

**transactional\_emails\_enabled** `boolean`

Чи отримує цей профіль транзакційні (програмні) листи. `null`, якщо значення ніколи не встановлювалося.

**created\_at** `string`

Часова мітка створення профілю у форматі ISO 8601.

**updated\_at** `string`

Часова мітка останнього оновлення у форматі ISO 8601. `null` для щойно створених профілів.

## Відповіді з помилками

| Статус | Опис |
| - | - |
| `400` | Помилка валідації — одне або кілька полів не пройшли перевірку. |
| `403` | Доступ заборонено — твій API-ключ не має доступу до цієї операції або група профілів поза межами твого контексту доступу. |
| `404` | Групу профілів не знайдено. |
| `409` | Профіль із зазначеним `email` уже існує (відповідь містить цю адресу), або існує профіль для тієї самої людини (див. нижче), або `Idempotency-Key` використано повторно з іншим тілом запиту, або початковий запит ще не завершився. |
| `500` | Внутрішня помилка сервера. |

Відповідь `409` виглядає так — сприймай її як «цей профіль уже існує» та шукай його через
[Список профілів](https://docs.anivahealth.com/uk/api/profiles/list-profiles.md) (`?email=`), а не повторюй запит на створення:

```json theme={null}
{
  "error": "An account with the email \"maria.schmidt@example.com\" already exists.",
  "error_name": "email_exists_error",
  "email": "maria.schmidt@example.com"
}
```

Для людини з таким самим ім’ям, прізвищем, статтю та датою народження, як у профілю, який бачить твій ключ,
повертається `409` із `error_name: "duplicate_profile_error"`. Використай повернутий `profile_id` замість
створення другого профілю:

```json theme={null}
{
  "error": "A patient named \"Maria Schmidt\", born 02-04-1990, with the same biological sex already exists as m***@example.com. Search for that patient and select them instead of creating a duplicate.",
  "error_name": "duplicate_profile_error",
  "profile_id": "3f1c2a8e-5b7d-4c9e-8a21-6d4f0b9e7c35",
  "full_name": "Maria Schmidt",
  "date_of_birth": "1990-04-02",
  "masked_email": "m***@example.com"
}
```

Прізвища пісочниці, які генерують тестові дані, є винятком.

```bash cURL theme={null}
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
  }'
```

```json 201 theme={null}
{
  "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
}
```

```json 400 theme={null}
{
  "error": "date_of_birth: Birthdate cannot be in the future."
}
```

```json 404 theme={null}
{
  "error": "Profile group 'acme-clinic-berlin' not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.