> 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/docs.facephi-pt-br/sdks/backend-sdk/iad/technical_documentation/api_reference/models.md).

# Models

## The BinaryData object

```json
{"openapi":"3.0.1","info":{"title":"IAD Service Rest API","version":"2.0.0"},"components":{"schemas":{"BinaryData":{"type":"string","format":"binary","description":"Buffer de datos binarios, típicamente datos de captura biométrica (imágenes, fotogramas de vídeo, etc.)."}}}}
```

## The TimeStamp object

```json
{"openapi":"3.0.1","info":{"title":"IAD Service Rest API","version":"2.0.0"},"components":{"schemas":{"TimeStamp":{"type":"string","description":"Un valor de fecha/hora en formato \"%Y-%m-%dT%H:%M:%SZ\"."}}}}
```

## The CaptureLivenessResult object

```json
{"openapi":"3.0.1","info":{"title":"IAD Service Rest API","version":"2.0.0"},"components":{"schemas":{"CaptureLivenessResult":{"type":"object","description":"Respuesta pública de liveness expuesta por la API de Facephi.","properties":{"diagnostic":{"type":"string","enum":["Live","NoLive"]},"reason":{"type":"string","description":"Motivo público de liveness.\n\nValores posibles:\n- `None`: la captura fue aceptada como `Live`.\n- `Unknown`: el servicio no pudo asignar la respuesta a un motivo de rechazo público documentado.\n- `UntrustedEnvironment`: el entorno de ejecución no se considera de confianza.\n- `SuspiciousActivity`: el dispositivo mostró patrones de actividad asociados a un ataque.\n- `UntrustedDevice`: no se pudo confiar en que el dispositivo fuera el que dice ser.\n- `SdkIntegrityViolation`: el SDK de captura o sus librerías parecen haber sido alterados.\n- `UntrustedCorruptedPayload`: el payload parece estar corrupto o manipulado.\n- `UntrustedContent`: se detectó un ataque de inyección.\n- `UntrustedContentLowConfidence`: se detectaron indicios de un ataque de inyección con menor confianza y la captura debe tratarse igualmente como rechazada.\n","enum":["None","Unknown","UntrustedEnvironment","SuspiciousActivity","UntrustedDevice","SdkIntegrityViolation","UntrustedCorruptedPayload","UntrustedContent","UntrustedContentLowConfidence"]},"probability":{"type":"number","format":"float"},"score":{"type":"number","format":"float"},"faceProbability":{"type":"number","format":"float"},"sdkDuration":{"type":"integer","format":"int64"},"queueDuration":{"type":"integer","format":"int64"}}}}}}
```

## The FacephiErrorMessage object

```json
{"openapi":"3.0.1","info":{"title":"IAD Service Rest API","version":"2.0.0"},"components":{"schemas":{"FacephiErrorMessage":{"type":"string","description":"Mensaje de error público documentado devuelto en las respuestas HTTP 400.","enum":["NoneBecauseFaceTooClose","NoneBecauseFaceNotFound","NoneBecauseFaceTooSmall","NoneBecauseAngleTooLarge","NoneBecauseImageDataError","NoneBecauseLicenseError","NoneBecauseTooManyFaces","NoneBecauseFaceTooCloseToBorder","NoneBecauseFaceCropped","NoneBecauseFaceOccluded","NoneBecauseEyesClosed","Replay attack detected","ErrorProcessing","ErrorFacialImage"]}}}}
```

## The ExtractImageResult object

```json
{"openapi":"3.0.1","info":{"title":"IAD Service Rest API","version":"2.0.0"},"components":{"schemas":{"ExtractImageResult":{"type":"object","properties":{"image":{"type":"string","format":"byte","description":"Imagen extraída codificada en base64."},"mimeType":{"type":"string","description":"Tipo MIME de la imagen extraída."}}}}}}
```

## The MessageResult object

```json
{"openapi":"3.0.1","info":{"title":"IAD Service Rest API","version":"2.0.0"},"components":{"schemas":{"MessageResult":{"type":"object","properties":{"message":{"type":"string","description":"Mensaje de respuesta del servicio."}}}}}}
```

## The ConfigData object

```json
{"openapi":"3.0.1","info":{"title":"IAD Service Rest API","version":"2.0.0"},"components":{"schemas":{"ConfigData":{"type":"object","description":"Vista pública de la configuración en tiempo de ejecución devuelta por GET /api/v1/iad/config. Las claves de autenticación JWT se omiten intencionadamente.","properties":{"port":{"type":"integer"},"number_of_threads":{"type":"integer"},"connection_timeout":{"type":"integer"},"keep_alive_request_number":{"type":"integer"},"client_max_body_size":{"type":"integer"},"logger_path":{"type":"string"},"logger_level":{"type":"string"},"logger_rotation":{"type":"string"},"logger_max_files":{"type":"integer"},"engine_connection_timeout":{"type":"integer","description":"Timeout de conexión del análisis de capturas en milisegundos."},"engine_request_timeout":{"type":"integer","description":"Timeout de solicitud del análisis de capturas en milisegundos."},"engine_max_retries":{"type":"integer","description":"Número máximo de intentos de reintento."},"engine_retry_delay":{"type":"integer","description":"Retardo entre reintentos en milisegundos."},"engine_verify_ssl":{"type":"boolean","description":"Indica si se deben verificar los certificados SSL del análisis de capturas."},"engine_verbose":{"type":"boolean"},"engine_pool_size":{"type":"integer"},"engine_url":{"type":"string","description":"URL del runtime de análisis de capturas."}}}}}}
```

## The ConfigUpdateRequest object

```json
{"openapi":"3.0.1","info":{"title":"IAD Service Rest API","version":"2.0.0"},"components":{"schemas":{"ConfigUpdateRequest":{"type":"object","required":["config_json_string"],"properties":{"config_json_string":{"type":"string","description":"Cadena JSON con la configuración en tiempo de ejecución a cargar. Las claves de autenticación JWT (`auth_*`) se rechazan y deben configurarse únicamente al inicio."}}}}}}
```

## The BadRequestResult object

```json
{"openapi":"3.0.1","info":{"title":"IAD Service Rest API","version":"2.0.0"},"components":{"schemas":{"BadRequestResult":{"type":"object","description":"Resultado cuando llegan parámetros incorrectos en la solicitud.","properties":{"status":{"type":"number"},"error":{"type":"string"},"message":{"type":"string","description":"Mensaje de error del servicio o error de validación normalizado por Facephi.","oneOf":[{"$ref":"#/components/schemas/FacephiErrorMessage"},{"type":"string"}]},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"FacephiErrorMessage":{"type":"string","description":"Mensaje de error público documentado devuelto en las respuestas HTTP 400.","enum":["NoneBecauseFaceTooClose","NoneBecauseFaceNotFound","NoneBecauseFaceTooSmall","NoneBecauseAngleTooLarge","NoneBecauseImageDataError","NoneBecauseLicenseError","NoneBecauseTooManyFaces","NoneBecauseFaceTooCloseToBorder","NoneBecauseFaceCropped","NoneBecauseFaceOccluded","NoneBecauseEyesClosed","Replay attack detected","ErrorProcessing","ErrorFacialImage"]},"TimeStamp":{"type":"string","description":"Un valor de fecha/hora en formato \"%Y-%m-%dT%H:%M:%SZ\"."}}}}
```

## The ExceptionResult object

```json
{"openapi":"3.0.1","info":{"title":"IAD Service Rest API","version":"2.0.0"},"components":{"schemas":{"ExceptionResult":{"type":"object","description":"Se ha producido un error en la llamada al backend.","properties":{"status":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"exception":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"Un valor de fecha/hora en formato \"%Y-%m-%dT%H:%M:%SZ\"."}}}}
```