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

# Crea un perfil

> Crea un nou perfil de pacient i assigna'l a un grup de perfils

Crea un nou perfil de pacient i assigna'l a un grup de perfils. El perfil conté dades demogràfiques utilitzades en cites i comandes de laboratori.

Requereix l'àmbit `create_user`.

Envia una capçalera opcional `Idempotency-Key` perquè aquesta creació es pugui reintentar amb seguretat — repetir la mateixa clau retorna la resposta original en lloc de crear-ne una segona. Consulta [Idempotència](https://docs.anivahealth.com/ca/concepts/idempotency.md).

## Sol·licitud

### Paràmetres del cos

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

Nom del pacient. Ha d'utilitzar caràcters llatins, entre 1 i 100 caràcters.

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

Cognom del pacient. Ha d'utilitzar caràcters llatins, entre 1 i 100 caràcters. Els laboratoris rebutgen
les comandes d'un pacient sense cognom, de manera que no es pot crear un perfil sense cognom.

Hi ha tres valors reservats per generar dades de prova — consulta [Dades de prova del sandbox](#dades-de-prova-del-sandbox).

**sex** `integer` *required*

Sexe biològic segons la norma ISO/IEC 5218. Fes servir `1` per a masculí, `2` per a femení. El laboratori el necessita per als
intervals de referència, així que `0` (desconegut) retorna `400`. Obligatori, tret que el teu grup de perfils permeti que el
pacient l'introdueixi a la pàgina d'activació del kit. En aquest cas, omet-lo. Consulta
[Permet que el pacient introdueixi la data de naixement i el sexe](https://docs.anivahealth.com/ca/concepts/profiles.md#permet-que-el-pacient-introdueixi-la-data-de-naixement-i-el-sexe).

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

Data de naixement en format `YYYY-MM-DD`. Ha de ser en el passat i no anterior a 1900. L'edat resultant
ha d'estar entre 16 i 100 anys. Qualsevol altre valor retorna `400`. Obligatòria, tret que el teu grup de perfils permeti
que el pacient l'introdueixi a la pàgina d'activació del kit. En aquest cas, omet-la.

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

Referència polimòrfica (UUID o slug) al grup de perfils al qual s'assignarà aquest perfil. L'UUID és
l'identificador immutable i es manté si es canvia el nom del slug; el slug continua sent acceptat per a màrqueting i
integracions de socis basades en identificadors llegibles. Es recomana l'UUID. El grup de perfils ha d'estar
dins del context d'accés de la teva clau API. Obligatori tret que enviïs el camp obsolet
`profile_group_slug`.

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

Obsolet: fes servir `profile_group`. Slug del grup de perfils. Només lletres minúscules, dígits, guions i
guions baixos.

**email** `string`

Adreça electrònica del perfil. Si s'omet, Aniva genera automàticament una adreça electrònica.

Indicar `email` també fa que la creació sigui **segura davant reintents**: una adreça només pot tenir un perfil, de manera que
una sol·licitud repetida retorna `409` en lloc d'un segon perfil. Les adreces generades automàticament són úniques per
sol·licitud. Envia `email` o una `Idempotency-Key` si la teva integració fa reintents.

**phone** `string`

Número de telèfon en format E.164 (p. ex., `+14155552671`).

**height** `number`

Alçada en centímetres.

**weight** `number`

Pes en quilograms.

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

Idioma preferit per al perfil: `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` o `uk`. El valor per defecte és `en`.

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

Si aquest perfil ha de rebre correus transaccionals (programàtics) — confirmacions de
cita, avisos de resultats disponibles, etc. Sobreescriu el valor per defecte del grup de perfils. Independent del
consentiment de màrqueting. Omet-lo per fer servir el valor per defecte.

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

Si aquest perfil accepta rebre correus de màrqueting (butlletins, novetats del producte). Sobreescriu el
valor per defecte del grup de perfils. Independent dels correus transaccionals. Omet-lo per fer servir el valor per defecte del grup de perfils.
Només d'escriptura: no es retorna a la resposta del perfil.

## Dades de prova del sandbox

Cada ruta de lectura que val la pena provar — [Llistar cites](https://docs.anivahealth.com/ca/api/appointments/list-appointments.md),
[Obtenir resultats](https://docs.anivahealth.com/ca/api/appointments/get-results.md),
[Descarregar document](https://docs.anivahealth.com/ca/api/documents/download-document.md) — és buida fins que té lloc una extracció de sang real
dies més tard. Això fa que escriure una prova d'integració automatitzada sigui incòmode.

Hi ha tres valors de `last_name` reservats per resoldre-ho. Crea un perfil amb un d'aquests valors i Aniva
emplena prèviament l'estat descrit a continuació abans de respondre, de manera que la teva següent crida ja el veu:

| `last_name` | Què rep el perfil |
| - | - |
| `Upcomingtestmann` | Una propera cita `confirmed` amb un panell associat. Encara sense resultats. |
| `Partialtestmann` | Una cita passada `blood_drawn`. Aproximadament la **meitat** del panell té resultats; [Obtenir resultats](https://docs.anivahealth.com/ca/api/appointments/get-results.md) és `in_progress`. |
| `Fulltestmann` | Una cita passada `blood_drawn`. **Tots** els biomarcadors del panell tenen resultats, `status: "completed"`, i un PDF de l'informe de laboratori a `documents[]`. |

La coincidència no distingeix entre majúscules i minúscules. Tots els altres camps — inclosos `date_of_birth` i `sex` — es desen i
s'utilitzen amb normalitat, de manera que els intervals de referència que reps són els reals segons l'edat i el sexe per al
perfil que has creat.

La cita es reserva a la ubicació **Aniva Test**, en una franja reservable real d'almenys cinc dies
a partir d'ara (o de fa cinc dies, per als estats passats). Generar-la no envia cap petició de laboratori ni reserva cap
missatger.

> [!NOTE]
>
> Assigna als perfils de prova una adreça que controlis. Els recordatoris de cita d'Aniva es basen en
> `scheduled_at`, així que l'escenari de cita futura n'enviarà tret que el perfil els desactivi amb
> `transactional_emails_enabled: false`.

El panell es tria a l'atzar entre els que la teva clau API pot veure, de manera que el seu `panel_id` sempre es correspon
amb el teu [Llista els panells](https://docs.anivahealth.com/ca/api/panels/list-panels.md). Els biomarcadors clínics reben un valor dins de
l'interval de referència del biomarcador; els gens reben un genotip aleatori de les dades de referència d'Aniva, amb les variants corresponents, la significació clínica i els identificadors rs que se'n deriven.

> [!NOTE]
>
> El panell i els valors es regeneren en cada creació, així que comprova l'estructura en lloc d'un panell
> concret o d'uns nombres exactes.

## Resposta

En cas d'èxit, l'API retorna `201 Created` amb el perfil acabat de crear.

**id** `string` *required*

Identificador únic del perfil (UUID).

**handle** `string`

Àlies del perfil o nom d'usuari. Pot ser `null`.

**first\_name** `string`

Nom. Pot ser `null`.

**last\_name** `string`

Cognom. Pot ser `null`.

**email** `string`

Adreça electrònica. Pot ser `null`.

**phone** `string`

Número de telèfon en format E.164. Pot ser `null`.

**sex** `integer`

Sexe biològic segons la norma ISO/IEC 5218 (`0` = desconegut, `1` = masculí, `2` = femení). Pot ser `null`.

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

Data de naixement en format `YYYY-MM-DD`. Pot ser `null`.

**height** `number`

Alçada en centímetres. Pot ser `null`.

**weight** `number`

Pes en quilograms. Pot ser `null`.

**language** `string`

Idioma preferit, un dels 32 codis anteriors.

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

Indica si aquest perfil rep correus electrònics transaccionals (programàtics). És `null` si no s'ha definit mai.

**created\_at** `string`

Marca de temps ISO 8601 de quan es va crear el perfil.

**updated\_at** `string`

Marca de temps ISO 8601 de l'última actualització. És `null` per als perfils acabats de crear.

## Respostes d'error

| Estat | Descripció |
| - | - |
| `400` | Error de validació — un o més camps no han passat la validació. |
| `403` | Prohibit — la teva clau API no té accés a aquesta operació o el grup de perfils és fora del teu context d'accés. |
| `404` | No s'ha trobat el grup de perfils. |
| `409` | Ja existeix un perfil per a l'`email` indicat (la resposta inclou l'adreça) o per a la mateixa persona (mira més avall), o bé s'ha reutilitzat `Idempotency-Key` amb un cos diferent, o la sol·licitud original encara no s'ha completat. |
| `500` | Error intern del servidor. |

Un `409` té aquest aspecte — tracta'l com "aquest perfil ja existeix" i cerca'l amb
[Llista els perfils](https://docs.anivahealth.com/ca/api/profiles/list-profiles.md) (`?email=`) en lloc de tornar a intentar la creació:

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

Una persona amb el mateix nom, cognom, sexe i data de naixement que un perfil que la teva clau pot veure
rep un `409` amb `error_name: "duplicate_profile_error"`. Fes servir el `profile_id` retornat en lloc de
crear un segon perfil:

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

Els cognoms de sandbox que generen dades de prova n'estan exempts.

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