> ## 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/ru/concepts/idempotency.md).

## Запрос

### Параметры тела запроса

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

Имя пациента. Только латинские символы, от 1 до 100 символов.

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

Фамилия пациента. Только латинские символы, от 1 до 100 символов. Лаборатории отклоняют
заказы для пациентов без фамилии, поэтому без неё профиль создать нельзя.

Три значения зарезервированы для создания тестовых фикстур — см. [Тестовые фикстуры для песочницы](#testovye-fikstury-dlya-pesochnitsy).

**sex** `integer` *required*

Биологический пол по стандарту ISO/IEC 5218. Используй `1` для мужского и `2` для женского.
Он нужен лаборатории для референсных интервалов, поэтому `0` (неизвестно) возвращает `400`.
Обязательно, если только твоя группа профилей не позволяет пациенту указать его на странице
активации набора. В этом случае не передавай поле. См.
[Разрешить пациенту указать дату рождения и пол](https://docs.anivahealth.com/ru/concepts/profiles.md#pozvolit-patsientu-vvesti-datu-rozhdeniya-i-pol).

**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`

Email-адрес для профиля. Если его не указать, 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`

Согласен ли этот профиль получать маркетинговые письма (рассылки, новости продукта).
Переопределяет настройку группы профилей по умолчанию. Не связано с транзакционными письмами.
Не передавай, чтобы использовать значение группы профилей по умолчанию. Только для записи:
не возвращается в ответе профиля.

## Тестовые фикстуры для песочницы

Все важные для тестирования запросы на чтение — [Список записей](https://docs.anivahealth.com/ru/api/appointments/list-appointments.md),
[Получить результаты](https://docs.anivahealth.com/ru/api/appointments/get-results.md),
[Скачать документ](https://docs.anivahealth.com/ru/api/documents/download-document.md) — пусты, пока через несколько дней не пройдёт
реальный забор крови. Из-за этого неудобно писать автоматические интеграционные тесты.

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

| `last_name` | Что получает профиль |
| - | - |
| `Upcomingtestmann` | Одна предстоящая запись в статусе `confirmed` с привязанной панелью. Результатов ещё нет. |
| `Partialtestmann` | Одна прошедшая запись в статусе `blood_drawn`. Готова примерно **половина** панели; [Получить результаты](https://docs.anivahealth.com/ru/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/ru/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/ru/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.