> ## 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.

# Créer un profil

> Créer un nouveau profil de patient et l'attribuer à un groupe de profils

Créer un nouveau profil patient et l'assigner à un groupe de profils. Le profil contient les données démographiques utilisées pour les rendez-vous et les commandes de laboratoire.

Nécessite le scope `create_user`.

Envoie un en-tête facultatif `Idempotency-Key` pour pouvoir relancer cette création sans risque — répéter la même clé renvoie la réponse d'origine au lieu d'en créer un second. Voir [Idempotence](https://docs.anivahealth.com/fr/concepts/idempotency.md).

## Requête

### Paramètres du corps

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

Prénom du patient. Doit utiliser des caractères latins, entre 1 et 100 caractères.

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

Nom de famille du patient. Doit utiliser des caractères latins, entre 1 et 100 caractères. Les
laboratoires rejettent les commandes pour un patient sans nom de famille, un profil ne peut donc
pas être créé sans nom de famille.

Trois valeurs sont réservées pour initialiser des jeux de test — voir [Jeux de test sandbox](#jeux-de-test-sandbox).

**sex** `integer` *required*

Sexe biologique selon la norme ISO/IEC 5218. Utilise `1` pour masculin, `2` pour féminin. Le
laboratoire en a besoin pour les intervalles de référence, donc `0` (inconnu) renvoie `400`.
Obligatoire, sauf si ton groupe de profils laisse le patient le saisir sur la page d'activation
du kit. Dans ce cas, omets-le. Voir
[Laisser le patient saisir sa date de naissance et son sexe](https://docs.anivahealth.com/fr/concepts/profiles.md#laisser-le-patient-saisir-sa-date-de-naissance-et-son-sexe).

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

Date de naissance au format `YYYY-MM-DD`. Doit être dans le passé et pas avant 1900. L'âge
correspondant doit être compris entre 16 et 100 ans. Les autres valeurs renvoient `400`.
Obligatoire, sauf si ton groupe de profils laisse le patient la saisir sur la page d'activation
du kit. Dans ce cas, omets-la.

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

Référence polymorphe (UUID ou slug) vers le groupe de profils auquel assigner ce profil. L'UUID
est l'identifiant immuable et survit aux renommages de slug ; le slug reste accepté pour les
intégrations marketing et partenaires basées sur des identifiants lisibles. L'UUID est
recommandé. Le groupe de profils doit faire partie du contexte d'accès de ta clé API.
Obligatoire, sauf si tu envoies le champ obsolète `profile_group_slug`.

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

Obsolète : utilise `profile_group`. Slug du groupe de profils. Lettres minuscules, chiffres,
tirets et tirets bas uniquement.

**email** `string`

Adresse e-mail du profil. Si elle est omise, Aniva génère automatiquement une adresse e-mail.

Fournir `email` rend aussi la création **sûre en cas de nouvelle tentative** : une adresse ne peut
jamais avoir qu'un seul profil, donc une requête répétée renvoie `409` au lieu d'un second profil.
Les adresses générées automatiquement sont uniques pour chaque requête. Envoie `email` ou un
`Idempotency-Key` si ton intégration réessaie.

**phone** `string`

Numéro de téléphone au format E.164 (par ex., `+14155552671`).

**height** `number`

Taille en centimètres.

**weight** `number`

Poids en kilogrammes.

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

Langue préférée du profil : `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` ou `uk`. Par défaut : `en`.

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

Indique si ce profil doit recevoir les e-mails transactionnels (programmatiques) — confirmations
de rendez-vous, notifications de résultats disponibles, etc. Remplace la valeur par défaut du
groupe de profils. Distinct du consentement marketing. Omets ce champ pour utiliser la valeur
par défaut.

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

Indique si ce profil accepte les e-mails marketing (newsletters, actualités produit). Remplace
la valeur par défaut du groupe de profils. Distinct des e-mails transactionnels. Omets ce champ
pour utiliser la valeur par défaut du groupe de profils. Écriture seule : non renvoyé dans la
réponse du profil.

## Jeux de test sandbox

Chaque chemin de lecture utile à tester — [Lister les rendez-vous](https://docs.anivahealth.com/fr/api/appointments/list-appointments.md),
[Obtenir les résultats](https://docs.anivahealth.com/fr/api/appointments/get-results.md),
[Télécharger un document](https://docs.anivahealth.com/fr/api/documents/download-document.md) — reste vide tant qu'une vraie prise de
sang n'a pas eu lieu plusieurs jours plus tard. Cela rend un test d'intégration automatisé peu
pratique à écrire.

Trois valeurs de `last_name` sont réservées pour régler cela. Crée un profil avec l'une d'elles et
Aniva préremplit l'état décrit ci-dessous avant de répondre, afin que ton appel suivant le voie
déjà :

| `last_name` | Ce que reçoit le profil |
| - | - |
| `Upcomingtestmann` | Un rendez-vous `confirmed` à venir avec un panel associé. Aucun résultat pour l'instant. |
| `Partialtestmann` | Un rendez-vous `blood_drawn` passé. Environ la **moitié** du panel est disponible ; [Obtenir les résultats](https://docs.anivahealth.com/fr/api/appointments/get-results.md) est `in_progress`. |
| `Fulltestmann` | Un rendez-vous `blood_drawn` passé. **Chaque** biomarqueur du panel est disponible, `status: "completed"`, et un rapport de laboratoire PDF dans `documents[]`. |

La correspondance ne tient pas compte de la casse. Tous les autres champs — y compris `date_of_birth`
et `sex` — sont enregistrés et utilisés normalement, de sorte que les intervalles de référence
renvoyés correspondent bien à l'âge et au sexe du profil que tu as créé.

Le rendez-vous est réservé sur le site **Aniva Test**, sur un vrai créneau disponible dans au moins cinq jours
(ou il y a cinq jours, pour les états passés). Son initialisation ne passe aucune commande au laboratoire et ne réserve aucun
coursier.

> [!NOTE]
>
> Donne aux profils de test une adresse que tu contrôles. Les rappels de rendez-vous d'Aniva s'appuient sur
> `scheduled_at`, donc la fixture à venir les enverra sauf si le profil est désinscrit via
> `transactional_emails_enabled: false`.

Le panel est choisi au hasard parmi ceux que ta clé API peut voir, donc son `panel_id` correspond toujours
à un résultat de ton propre [Lister les panels](https://docs.anivahealth.com/fr/api/panels/list-panels.md). Les biomarqueurs cliniques reçoivent une valeur comprise dans
leur intervalle de référence ; les gènes reçoivent un génotype aléatoire issu des données de référence d'Aniva, avec les variants, la signification clinique et les identifiants rs correspondants qui en découlent.

> [!NOTE]
>
> Le panel et les valeurs sont régénérés à chaque création, vérifie donc la structure plutôt qu'un panel
> précis ou des nombres exacts.

## Réponse

En cas de succès, l'API renvoie `201 Created` avec le profil nouvellement créé.

**id** `string` *required*

Identifiant unique du profil (UUID).

**handle** `string`

Pseudonyme ou nom d'utilisateur du profil. Peut être `null`.

**first\_name** `string`

Prénom. Peut être `null`.

**last\_name** `string`

Nom de famille. Peut être `null`.

**email** `string`

Adresse e-mail. Peut être `null`.

**phone** `string`

Numéro de téléphone au format E.164. Peut être `null`.

**sex** `integer`

Sexe biologique selon la norme ISO/IEC 5218 (`0` = inconnu, `1` = masculin, `2` = féminin). Peut être `null`.

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

Date de naissance au format `YYYY-MM-DD`. Peut être `null`.

**height** `number`

Taille en centimètres. Peut être `null`.

**weight** `number`

Poids en kilogrammes. Peut être `null`.

**language** `string`

Langue préférée, parmi les 32 codes ci-dessus.

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

Indique si ce profil reçoit des e-mails transactionnels (automatiques). `null` si jamais défini.

**created\_at** `string`

Horodatage ISO 8601 de création du profil.

**updated\_at** `string`

Horodatage ISO 8601 de la dernière mise à jour. `null` pour les profils nouvellement créés.

## Réponses d'erreur

| Statut | Description |
| - | - |
| `400` | Erreur de validation — un ou plusieurs champs n'ont pas passé la validation. |
| `403` | Accès refusé — ta clé API n'a pas accès à cette opération ou le groupe de profils est en dehors de ton contexte d'accès. |
| `404` | Groupe de profils introuvable. |
| `409` | Un profil existe déjà pour l'adresse `email` fournie (la réponse contient l'adresse) ou pour la même personne (voir ci-dessous), ou la clé `Idempotency-Key` a été réutilisée avec un corps différent, ou sa requête d'origine n'est pas encore terminée. |
| `500` | Erreur interne du serveur. |

Une réponse `409` ressemble à ceci — traite-la comme « ce profil existe déjà » et recherche le profil avec
[Lister les profils](https://docs.anivahealth.com/fr/api/profiles/list-profiles.md) (`?email=`) plutôt que de relancer la création :

```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"
}
```

Une personne ayant les mêmes prénom, nom de famille, sexe et date de naissance qu'un profil visible par ta clé
reçoit une réponse `409` avec `error_name: "duplicate_profile_error"`. Utilise le `profile_id` renvoyé au lieu de
créer un second profil :

```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"
}
```

Les noms de famille de la sandbox qui initialisent les données de test sont exemptés.

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