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

# Obtener pedido de kit de prueba en casa

> Obtener un kit de prueba en casa por correo mediante su ID

Obtén un único pedido de kit de prueba en casa por su UUID, incluido el perfil integrado del paciente. Usa este endpoint para comprobar el estado del pedido, revisar la dirección de entrega o consultar los paneles y biomarcadores asociados.

Requiere el ámbito `home_kit_orders_view` o `home_kit_orders_manage`.

## Solicitud

### Parámetros de ruta

**id** `string` *required*

Identificador único (UUID) del pedido de kit de prueba en casa que quieres obtener.

## Respuesta

Si la solicitud tiene éxito, la API devuelve `200 OK` con el pedido de kit de prueba en casa y su perfil integrado.

**id** `string` *required*

Identificador único del pedido de kit de prueba en casa (UUID).

**profile\_id** `string` *required*

UUID del perfil al que pertenece este pedido de kit de prueba en casa.

**status** `string` *required*

Estado actual del pedido de kit de prueba en casa. Puede ser `pending`, `dispatched`, `activated` o `cancelled`.
El grado de finalización de los resultados de laboratorio se obtiene de [Obtener resultados](https://docs.anivahealth.com/es/api/home-kit-orders/get-results.md).

**delivery\_address** `object` *required*

La dirección a la que se envía el kit, con uno de estos dos formatos: `{ location_id }` para referenciar una ubicación de pruebas conocida, o los campos de dirección en línea (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` opcionales, con el mismo vocabulario que la API de ubicaciones). Indica exactamente uno: una referencia de ubicación o una dirección en línea, no ambos.

**dirección de entrega**

> [tab] Referencia de ubicación
>
> **location\_id** `string` *required*
>
> UUID de la ubicación de pruebas a la que se envía el kit.

> [tab] Dirección en línea
>
> **name** `string` *required*
>
> Nombre del destinatario, la empresa o la ubicación.
>
> **company\_name** `string`
>
> Empresa que recibe el paquete para el destinatario: un destinatario `c/o` o un departamento.
>
> **street** `string` *required*
>
> Nombre de la calle, sin el número (p. ej., `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Número de la calle (p. ej., `118` o `12a`).
>
> **address\_line\_2** `string`
>
> Edificio, portal o piso.
>
> **city** `string` *required*
>
> **state** `string`
>
> Estado o provincia. Opcional.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> Código ISO 3166-1 alfa-2 (dos letras, p. ej., `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Código de muestra de laboratorio bajo el que se notifican los resultados: viene impreso en el kit físico y es lo que el
paciente lee en la caja como código de activación. `null` hasta que se empaqueta el kit.
Solo lectura.

**activated\_at** `string` *required*

Marca de tiempo de la recogida notificada mediante [Activar](https://docs.anivahealth.com/es/api/home-kit-orders/activate-home-kit.md): cuándo
recogió la muestra el paciente. `null` hasta que se activa el kit.

**replaces\_home\_kit\_order\_id** `string`

El pedido de kit de prueba en casa al que sustituye este, cuando se trata de un kit de sustitución. `null` en un pedido normal. Consulta
[Crear pedido de kit de prueba en casa](https://docs.anivahealth.com/es/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Motivo por el que se envió la sustitución. `null` en un pedido normal.

**results\_ready\_emails** `string[]` *required*

Direcciones que reciben un correo cada una cuando todos los resultados de laboratorio son definitivos, en minúsculas. Vacío cuando está desactivado. Consulta
[Correos de resultados listos](https://docs.anivahealth.com/es/concepts/results.md#correos-de-resultados-listos).

**metadata** `object` *required*

Pares clave/valor definidos por el socio, devueltos tal cual. Siempre presente: `{}` si no se ha definido.

**created\_at** `string` *required*

Marca de tiempo ISO 8601 de cuándo se creó el pedido de kit de prueba en casa.

**updated\_at** `string`

Marca de tiempo ISO 8601 de la última actualización. Puede ser `null`.

**profile** `object` *required*

El perfil de paciente asociado a este pedido de kit de prueba en casa.

**perfil**

**id** `string`

Identificador único del perfil (UUID).

**handle** `string`

Alias o nombre de usuario del perfil. Puede ser `null`.

**first\_name** `string`

Nombre. Puede ser `null`.

**last\_name** `string`

Apellido. Puede ser `null`.

**email** `string`

Dirección de correo electrónico. Puede ser `null`.

**phone** `string`

Número de teléfono en formato E.164. Puede ser `null`.

**sex** `integer`

Sexo biológico según ISO/IEC 5218. Puede ser `null`.

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

Fecha de nacimiento en formato `YYYY-MM-DD`. Puede ser `null`.

**height** `number`

Altura en centímetros. Puede ser `null`.

**weight** `number`

Peso en kilogramos. Puede ser `null`.

**language** `string`

Idioma preferido: uno de los 32 códigos en [Crear perfil](https://docs.anivahealth.com/es/api/profiles/create-profile.md).

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

Indica si este perfil recibe correos transaccionales (programáticos). Puede ser `null`.

**created\_at** `string`

Marca de tiempo ISO 8601 de cuándo se creó el perfil.

**updated\_at** `string`

Marca de tiempo ISO 8601 de la última actualización del perfil. Puede ser `null`.

**panels** `HomeKitOrderPanel[]` *required*

El panel asociado a este pedido de kit de prueba en casa — siempre es exactamente uno (un kit de prueba en casa corresponde 1:1 a un
kit físico) y puede cambiarse con [Actualizar](https://docs.anivahealth.com/es/api/home-kit-orders/update-home-kit.md) mientras
esté en `pending`. Consulta los detalles del panel (nombre, biomarcadores) en [Listar paneles](https://docs.anivahealth.com/es/api/panels/list-panels.md).

**Campos de vinculación del panel**

**panel\_id** `string`

UUID del panel: consúltalo en [Listar paneles](https://docs.anivahealth.com/es/api/panels/list-panels.md).

**added\_at** `string`

Marca de tiempo ISO 8601 en la que se vinculó por primera vez el panel a este pedido de kit de prueba en casa.

**individual\_biomarkers** `HomeKitOrderIndividualBiomarker[]` *required*

Biomarcadores a la carta asociados a este pedido de kit de prueba en casa fuera de cualquier panel. Cruza cada
`biomarker_id` con [Listar biomarcadores](https://docs.anivahealth.com/es/api/biomarkers/list-biomarkers.md) usando `home_kit=true` para obtener los datos de visualización.

**Campos de biomarcadores individuales**

**biomarker\_id** `integer`

Identificador del biomarcador: consúltalo en
[Listar biomarcadores](https://docs.anivahealth.com/es/api/biomarkers/list-biomarkers.md) con `home_kit=true`.

**added\_at** `string`

Marca de tiempo ISO 8601 en la que se vinculó por primera vez el biomarcador a este pedido de kit de prueba en casa.

**shipments** `HomeKitOrderShipmentLink[]` *required*

Paquetes vinculados a este pedido de kit de prueba en casa, del vínculo más antiguo al más reciente — normalmente el kit enviado al paciente
y la muestra de vuelta al laboratorio. Queda vacío hasta que logística imprime una etiqueta. Consulta los
paquetes completos con [Listar envíos](https://docs.anivahealth.com/es/api/shipments/list-shipments.md) y `?home_kit_order_id=`.

**Campos de enlace de envío**

**id** `string`

Referencia del envío: consúltala en [Obtener envío](https://docs.anivahealth.com/es/api/shipments/get-shipment.md).

**added\_at** `string`

Marca de tiempo ISO 8601 en la que se vinculó el envío a este pedido de kit de prueba en casa.

## Llamadas repetidas

Aniva guarda la respuesta de este endpoint durante 60 minutos para cada clave de API. Una llamada repetida dentro de
este plazo recibe la respuesta guardada mientras el pedido de kit de prueba en casa no cambie. Tras un cambio, recibes una respuesta
nueva. Las cabeceras `Cache-Status` y `Age` muestran que la respuesta está
guardada y su antigüedad.

Para enterarte de un cambio al instante, suscríbete a los eventos de webhook `home_kit_order.created` y al evento de cada estado, por ejemplo `home_kit_order.activated`.
Consulta [Lecturas repetidas](https://docs.anivahealth.com/es/concepts/webhooks.md#lecturas-repetidas).

## Respuestas de error

| Estado | Descripción |
| - | - |
| `400` | Formato de ID no válido — el valor proporcionado no es un UUID válido. |
| `403` | Prohibido — tu clave de API no tiene acceso a esta operación o el pedido de kit de prueba en casa está fuera de tu ámbito de permisos. |
| `404` | Pedido de kit de prueba en casa no encontrado. |
| `500` | Error interno del servidor. |

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "dispatched",
  "delivery_address": {
    "name": "Maria Schmidt",
    "street": "Friedrichstraße",
    "house_number": "123",
    "postal_code": "10117",
    "city": "Berlin",
    "country_code": "DE",
    "phone": "+4930123456789",
    "email": "maria.schmidt@example.com"
  },
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-02T08:00:00Z",
  "profile": {
    "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
  },
  "panels": [
    {
      "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
      "added_at": "2026-04-01T09:50:00Z"
    }
  ],
  "individual_biomarkers": [
    {
      "biomarker_id": 42,
      "added_at": "2026-04-01T09:52:00Z"
    }
  ],
  "metadata": {},
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": "7642000123",
  "activated_at": null,
  "shipments": [
    { "id": "K2604021FQ7", "added_at": "2026-04-02T08:00:00Z" },
    { "id": "K260402P3XD", "added_at": "2026-04-02T08:00:00Z" }
  ]
}
```

```json 400 theme={null}
{
  "error": "id: Invalid home kit ID format"
}
```

```json 404 theme={null}
{
  "error": "Home kit order not found"
}
```


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