> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/api-rest/identity-api/identity-api-reference/onboarding/civil-registry/chile-cow.md).

# Chile COW

Permite verificar la **validez y estado** de las cédulas de identidad chilenas integrándose con el sistema **COW** (Certificate of Validity) del Registro Civil de Chile.

### Endpoint

```
POST /civil-registry/vigencia-cow
```

### Autenticación

| Tipo    | Ubicación | Nombre        |
| ------- | --------- | ------------- |
| API Key | Header    | **x-api-key** |

### Cuerpo de la solicitud

**Content-Type:** `application/json`

#### Parámetros

| Parámetro          | Tipo   | Requerido | Descripción                                                                         |
| ------------------ | ------ | --------- | ----------------------------------------------------------------------------------- |
| `RUN`              | string | **Sí**    | Número de identificación chileno del usuario, **incluyendo el dígito verificador**. |
| `credentialNumber` | string | **Sí**    | Número de credencial único asociado a la identificación.                            |

#### Ejemplo de solicitud

```bash
curl --location '{IDENTITY_API_BASE_URL}/civil-registry/vigencia-cow' \
--header 'x-api-key: {API_KEY}' \
--data-raw '{
  "RUN": "12345678-9",
  "credentialNumber": "000000000"
}'
```

### Respuestas

#### `200` Éxito

#### Parámetros de respuesta

| Parámetro      | Tipo   | Requerido | Descripción                            |
| -------------- | ------ | --------- | -------------------------------------- |
| `responseData` | object | **Sí**    | Contiene los datos de la transacción.  |
| `identity`     | array  | **Sí**    | Contiene los detalles de la identidad. |

#### Parámetros de respuesta — `responseData`

| Parámetro           | Tipo   | Requerido | Descripción                                                                                                                                                                                        |
| ------------------- | ------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `idTransaction`     | string | **Sí**    | Identificador único de la transacción.                                                                                                                                                             |
| `transactionDate`   | string | **Sí**    | Fecha de la transacción en formato **YYYY-MM-DD**.                                                                                                                                                 |
| `statusTransaction` | string | **Sí**    | Estado de la transacción. Valores posibles: `000` (ACK), `201` (Error técnico), `206` (Formato inválido), `301` (Datos inexistentes), `304` (Calidad deficiente), `306` (Sin huella proporcionada) |
| `errorDescription`  | string | **Sí**    | Descripción del estado de la transacción. Valores posibles: `ACK`, `Technical error`, `Invalid format`, `Non-existent data`, `Poor quality`, `No fingerprint provided`                             |

#### Parámetros de respuesta — `identity`

| Parámetro             | Tipo   | Requerido | Descripción                                                                                                                                 |
| --------------------- | ------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `RUN`                 | string | **Sí**    | Número de identificación nacional chileno (RUT).                                                                                            |
| `credentialProfileId` | string | **Sí**    | Tipo de credencial. Valores posibles: `CEDULA`, `CEDULA_EXT`, `PASAPORTE`, `DOC_VIAJE`, `TITULO_VIAJE`, `SALVO_CONDUCTO`                    |
| `credentialNumber`    | string | **Sí**    | Número de documento asociado a la credencial.                                                                                               |
| `expiryDate`          | string | **Sí**    | Fecha de expiración de la credencial.                                                                                                       |
| `validityStatus`      | string | **Sí**    | Estado de vigencia de la credencial. Valores posibles: `VIGENTE`, `NO_VIGENTE`                                                              |
| `status`              | string | **Sí**    | Estado detallado de la credencial. Valores posibles: `NO BLOQUEADO`, `CREACIÓN/RENOVACIÓN`, `TEMPORAL`, `TEMPORAL PERMANENTE`, `DEFINITIVO` |

#### Ejemplo de respuesta

```json
{
  "responseData": {
    "idTransaction": "03a10a56-cf9f-4248-bd60-5ce992562930",
    "transactionDate": "2024-12-13",
    "statusTransaction": "000",
    "errorDescription": "ACK"
  },
  "identity": [
    {
      "status": "NO BLOQUEADO",
      "run": "12345678-9",
      "credentialProfileId": "CEDULA",
      "credentialNumber": "000000000",
      "expiryDate": "2029-06-22",
      "validityStatus": "VIGENTE"
    }
  ]
}
```

#### `400` Bad Request

```json
{
  "status": 400,
  "title": "Bad Request",
  "detail": "Invalid request.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
  "errors": []
}
```

#### `401` Unauthorized

```json
{
  "message": "Unauthorized"
}
```

#### `403` Forbidden

```json
{
  "Message": "User is not authorized to access this resource with an explicit deny"
}
```

#### `502` Bad Gateway

```json
{
  "status": 502,
  "title": "Bad Gateway",
  "detail": "Server got an invalid response.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502"
}
```

#### `504` Gateway Timeout

```json
{
  "message": "Endpoint request timed out"
}
```