> 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/morphology/document-validation/document-validation-data.md).

# Document validation Data

Obtiene los resultados del análisis morfológico del documento **una vez que el proceso de validación se ha completado exitosamente**.

{% hint style="info" %}
Los campos de la respuesta dependerán del proveedor de morfología configurado.
{% endhint %}

### Endpoint

```
POST /verify/documentValidation/data
```

### Headers

| Nombre        | Tipo   | Requerido | Descripción                                                   |
| ------------- | ------ | --------- | ------------------------------------------------------------- |
| **x-api-key** | string | **Sí**    | API key de autorización de acceso.                            |
| **family**    | string | No        | Valor: **OnBoarding**. Requerido con el servicio de tracking. |

{% hint style="info" %}
Todas las llamadas a los Endpoints para tracking con **Identity Platform** deben contener el header `family`.
{% endhint %}

### Cuerpo de la solicitud

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

#### Parámetros

| Parámetro              | Tipo   | Requerido | Descripción                                                                                             |
| ---------------------- | ------ | --------- | ------------------------------------------------------------------------------------------------------- |
| `scanReference`        | string | **Sí**    | **Número de referencia** del escaneo.                                                                   |
| `type`                 | string | No        | ⚠️ Valor **obsoleto**. Será eliminado en futuras versiones.                                             |
| `tracking`             | object | No        | Objeto que representa la información de seguimiento necesaria.                                          |
| `tracking.extraData`   | string | No        | Token generado por el SDK Mobile/Web. Contiene información de seguimiento tokenizada con la Plataforma. |
| `tracking.operationId` | string | No        | Identificador de operación generado por el SDK Mobile/Web.                                              |

#### Ejemplo de solicitud

```json
{
  "scanReference": "fe294c25-17e1-4d98-a958-710edbf00064",
  "type": "1",
  "tracking": {
    "extraData": "BQABAQG2gBNjuHN4kLmPqYf7R...",
    "operationId": "123e4567-e89b-12d3-a456-426614174000"
  }
}
```

### Respuestas

#### `200` Éxito

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

Detalles de la validación del documento e información extraída.

| Parámetro          | Tipo   | Nullable | Descripción                                                                                                                                                                                                                          |
| ------------------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `dateOfBirthParts` | object | Sí       | Partes de la fecha de nacimiento (`year`, `month`, `day`).                                                                                                                                                                           |
| `dob`              | string | Sí       | Fecha de nacimiento en formato **YYYY-MM-DD**.                                                                                                                                                                                       |
| `expiry`           | string | Sí       | Fecha de expiración del documento en formato **YYYY-MM-DD**.                                                                                                                                                                         |
| `expiryDateParts`  | object | Sí       | Partes de la fecha de expiración (`year`, `month`, `day`).                                                                                                                                                                           |
| `firstName`        | string | Sí       | Nombre del titular del documento.                                                                                                                                                                                                    |
| `lastName`         | string | Sí       | Apellido del titular del documento.                                                                                                                                                                                                  |
| `gender`           | string | Sí       | Género del titular del documento.                                                                                                                                                                                                    |
| `idSubtype`        | string | Sí       | Subtipo del documento.                                                                                                                                                                                                               |
| `issuingCountry`   | string | Sí       | País que emitió el documento.                                                                                                                                                                                                        |
| `nationality`      | string | Sí       | Nacionalidad del titular del documento.                                                                                                                                                                                              |
| `number`           | string | Sí       | Número del documento.                                                                                                                                                                                                                |
| `optionalData2`    | string | Sí       | Campo de datos opcionales adicionales.                                                                                                                                                                                               |
| `status`           | string | No       | Estado de verificación del documento. Valores posibles: `APPROVED_VERIFIED`, `DENIED_FRAUD`, `DENIED_UNSUPPORTED_ID_TYPE`, `DENIED_UNSUPPORTED_ID_COUNTRY`, `ERROR_NOT_READABLE`. Ver [Verification Results](#verification-results). |
| `type`             | string | Sí       | Tipo de documento. Valores posibles: `PASSPORT`, `DRIVING_LICENSE`, `ID_CARD`, `VISA`                                                                                                                                                |
| `issuingDate`      | string | Sí       | Fecha de emisión del documento.                                                                                                                                                                                                      |
| `issuingDateParts` | object | Sí       | Partes de la fecha de emisión (`year`, `month`, `day`).                                                                                                                                                                              |
| `issuingPlace`     | string | Sí       | Lugar donde se emitió el documento.                                                                                                                                                                                                  |
| `issuingAuthority` | string | Sí       | Autoridad que emitió el documento.                                                                                                                                                                                                   |

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

Metadatos de la transacción e información de procesamiento.

| Parámetro               | Tipo   | Descripción                                                         |
| ----------------------- | ------ | ------------------------------------------------------------------- |
| `date`                  | string | Fecha de creación de la transacción en formato **ISO 8601**.        |
| `merchantScanReference` | string | Referencia de escaneo proporcionada por el comercio.                |
| `source`                | string | Origen de la transacción.                                           |
| `status`                | string | Estado de procesamiento de la transacción.                          |
| `updatedAt`             | string | Marca de tiempo de la última actualización en formato **ISO 8601**. |

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

Resultados de verificación y comprobaciones adicionales realizadas.

| Parámetro          | Tipo   | Nullable | Descripción                                              |
| ------------------ | ------ | -------- | -------------------------------------------------------- |
| `additionalChecks` | object | Sí       | Comprobaciones de verificación adicionales realizadas.   |
| `mrzCheck`         | object | Sí       | Resultados de la verificación del Machine Readable Zone. |

#### Verification Results

El campo `document.status` en la respuesta de Document Validation Data indica el resultado de la verificación:

| Status                               | Descripción                                                                     |
| ------------------------------------ | ------------------------------------------------------------------------------- |
| **APPROVED\_VERIFIED**               | Verificado y aprobado exitosamente para su uso.                                 |
| **DENIED\_FRAUD**                    | La verificación falló debido a contenido fraudulento o manipulación sospechosa. |
| **DENIED\_UNSUPPORTED\_ID\_TYPE**    | El tipo de documento no es soportado por el sistema de validación.              |
| **DENIED\_UNSUPPORTED\_ID\_COUNTRY** | El país del documento no es soportado por el sistema de validación.             |
| **ERROR\_NOT\_READABLE**             | No se pudo procesar debido a mala calidad de imagen o problemas de legibilidad. |

#### Ejemplo de respuesta

```json
{
  "document": {
    "dateOfBirthParts": {
      "year": "1995",
      "month": "10",
      "day": "16"
    },
    "dob": "XXXX-10-16",
    "expiry": "XXXX-10-16",
    "expiryDateParts": {
      "year": "XXXX",
      "month": "XX",
      "day": "XX"
    },
    "firstName": "XXX XXXXX",
    "gender": null,
    "idSubtype": null,
    "issuingCountry": "CHL",
    "lastName": "XXXX XXXXXX",
    "nationality": null,
    "number": "XXXXXXXXX",
    "optionalData2": "XXXXXX K",
    "status": "APPROVED_VERIFIED",
    "type": "ID_CARD",
    "issuingDate": null,
    "issuingDateParts": null,
    "issuingPlace": null,
    "issuingAuthority": null
  },
  "transaction": {
    "date": "2024-01-18T17:48:49.598029Z",
    "merchantScanReference": "680f8ef8-3ff5-XXXXX-XXXX-97182d998dfb",
    "source": "API",
    "status": "DONE",
    "updatedAt": "2024-01-18T17:49:15.310078Z"
  },
  "verification": {
    "additionalChecks": null,
    "mrzCheck": null
  }
}
```

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