> 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-en/sdks/backend-sdk/backend1n/technical_documentation/api_reference/models.md).

# Models

## The ImageBuffer object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"ImageBuffer":{"type":"string","description":"Buffer de imagen en formato JPEG, PNG o BMP, codificado en base64 RFC4648."}}}}
```

## The FacialTemplate object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"FacialTemplate":{"type":"string","description":"Patrón biométrico facial, codificado en base64 RFC4648."}}}}
```

## The FacialTemplateRaw object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"FacialTemplateRaw":{"type":"string","description":"Un token extendido que contiene patrones biométricos y metadatos. Se recomienda su almacenamiento en bases de datos por ser persistente. Puede actualizarse automáticamente en caso de cambios en la tecnología de extracción. Está codificado en base64 RFC4648."}}}}
```

## The UpdatedTemplateRaw object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"UpdatedTemplateRaw":{"type":"boolean","default":false,"description":"Si es true, significa que el templateRaw se ha actualizado tras una operación de extracción. Esto se puede usar para determinar si el templateRaw debe actualizarse en las bases de datos."}}}}
```

## The BinaryImage object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"BinaryImage":{"type":"string","format":"binary","description":"Datos binarios de imagen en formato JPEG, PNG o BMP."}}}}
```

## The FaceId object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"FaceId":{"type":"string","description":"Un identificador de un espécimen (rostro) en la base de datos."}}}}
```

## The TenantId object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"TenantId":{"type":"string","description":"Un identificador que permite agrupar distintas imágenes o patrones biométricos en un espacio común."}}}}
```

## The MediaId object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"MediaId":{"type":"string","description":"Un identificador de imagen en la base de datos."}}}}
```

## The MimeType object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"MimeType":{"type":"string","description":"Identificador del formato del archivo."}}}}
```

## The TemplateRawExraction object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"TemplateRawExraction":{"type":"boolean","default":false,"description":"Si es true, se calculará el templateRaw."}}}}
```

## The MaxCandidates object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"MaxCandidates":{"type":"integer","default":1,"description":"El número máximo de candidatos que se desean en la respuesta."}}}}
```

## The MinSimilarity object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"MinSimilarity":{"type":"number","default":0,"description":"La similitud mínima requerida para que un candidato se incluya en la respuesta."}}}}
```

## The Similarity object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"Similarity":{"type":"number","default":0,"description":"Un valor entre 0 y 1 que indica el valor de similitud entre dos patrones biométricos."}}}}
```

## The GalleryIndex object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"GalleryIndex":{"type":"integer","description":"La posición que ocupa un elemento en la galería."}}}}
```

## The ExtractOptions object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"ExtractOptions":{"type":"object","description":"Opciones al extraer patrones biométricos.","properties":{"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExraction"}}},"TemplateRawExraction":{"type":"boolean","default":false,"description":"Si es true, se calculará el templateRaw."}}}}
```

## The SearchOptions object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"SearchOptions":{"type":"object","description":"Opciones al buscar patrones biométricos.","properties":{"maxCandidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilariry":{"$ref":"#/components/schemas/MinSimilarity"}}},"MaxCandidates":{"type":"integer","default":1,"description":"El número máximo de candidatos que se desean en la respuesta."},"MinSimilarity":{"type":"number","default":0,"description":"La similitud mínima requerida para que un candidato se incluya en la respuesta."}}}}
```

## The FaceDescription object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"FaceDescription":{"type":"string","description":"Descripción del espécimen (rostro) que se almacena en la base de datos."}}}}
```

## The CreateAt object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"CreateAt":{"type":"string","description":"Valor de fecha/hora en formato \"%Y-%m-%dT%H:%M:%SZ\" en el que se creó un espécimen (rostro)."}}}}
```

## The UpdateAt object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"UpdateAt":{"type":"string","description":"Valor de fecha/hora en formato \"%Y-%m-%dT%H:%M:%SZ\" en el que se actualizó un espécimen (rostro)."}}}}
```

## The TimeStamp object

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

## The ExtractBody object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"ExtractBody":{"type":"object","description":"Body para la solicitud de extract","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"},"options":{"$ref":"#/components/schemas/ExtractOptions"}},"required":["image"]},"ImageBuffer":{"type":"string","description":"Buffer de imagen en formato JPEG, PNG o BMP, codificado en base64 RFC4648."},"ExtractOptions":{"type":"object","description":"Opciones al extraer patrones biométricos.","properties":{"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExraction"}}},"TemplateRawExraction":{"type":"boolean","default":false,"description":"Si es true, se calculará el templateRaw."}}}}
```

## The ExtractTemplateBody object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"ExtractTemplateBody":{"type":"object","description":"Body para la solicitud de extracción a partir de un template","properties":{"facialTemplateRaw":{"$ref":"#/components/schemas/FacialTemplateRaw"},"options":{"$ref":"#/components/schemas/ExtractOptions"}},"required":["facialTemplateRaw"]},"FacialTemplateRaw":{"type":"string","description":"Un token extendido que contiene patrones biométricos y metadatos. Se recomienda su almacenamiento en bases de datos por ser persistente. Puede actualizarse automáticamente en caso de cambios en la tecnología de extracción. Está codificado en base64 RFC4648."},"ExtractOptions":{"type":"object","description":"Opciones al extraer patrones biométricos.","properties":{"templateRawExtraction":{"$ref":"#/components/schemas/TemplateRawExraction"}}},"TemplateRawExraction":{"type":"boolean","default":false,"description":"Si es true, se calculará el templateRaw."}}}}
```

## The AssetUploadBody object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"AssetUploadBody":{"type":"object","description":"Body para la solicitud de subida de recursos (asset) en `multipart/form-data`","properties":{"file":{"$ref":"#/components/schemas/BinaryImage"},"tenantId":{"$ref":"#/components/schemas/TenantId"},"mimeType":{"$ref":"#/components/schemas/MimeType"}},"required":["file","tenantId","mimeType"]},"BinaryImage":{"type":"string","format":"binary","description":"Datos binarios de imagen en formato JPEG, PNG o BMP."},"TenantId":{"type":"string","description":"Un identificador que permite agrupar distintas imágenes o patrones biométricos en un espacio común."},"MimeType":{"type":"string","description":"Identificador del formato del archivo."}}}}
```

## The FaceBody object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"FaceBody":{"type":"object","description":"Body para la solicitud POST de face","properties":{"mediaId":{"$ref":"#/components/schemas/MediaId"},"tenantId":{"$ref":"#/components/schemas/TenantId"},"description":{"$ref":"#/components/schemas/FaceDescription"}},"required":["mediaId","tenantId","description"]},"MediaId":{"type":"string","description":"Un identificador de imagen en la base de datos."},"TenantId":{"type":"string","description":"Un identificador que permite agrupar distintas imágenes o patrones biométricos en un espacio común."},"FaceDescription":{"type":"string","description":"Descripción del espécimen (rostro) que se almacena en la base de datos."}}}}
```

## The SearchImageBody object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"SearchImageBody":{"type":"object","description":"Body para la solicitud POST de búsqueda por imagen","properties":{"image":{"$ref":"#/components/schemas/ImageBuffer"},"options":{"$ref":"#/components/schemas/SearchOptions"}},"required":["image"]},"ImageBuffer":{"type":"string","description":"Buffer de imagen en formato JPEG, PNG o BMP, codificado en base64 RFC4648."},"SearchOptions":{"type":"object","description":"Opciones al buscar patrones biométricos.","properties":{"maxCandidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilariry":{"$ref":"#/components/schemas/MinSimilarity"}}},"MaxCandidates":{"type":"integer","default":1,"description":"El número máximo de candidatos que se desean en la respuesta."},"MinSimilarity":{"type":"number","default":0,"description":"La similitud mínima requerida para que un candidato se incluya en la respuesta."}}}}
```

## The SearchTemplateBody object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"SearchTemplateBody":{"type":"object","description":"Body para la solicitud POST de búsqueda por template","properties":{"facialTemplateRaw":{"$ref":"#/components/schemas/FacialTemplateRaw"},"options":{"$ref":"#/components/schemas/SearchOptions"}},"required":["image"]},"FacialTemplateRaw":{"type":"string","description":"Un token extendido que contiene patrones biométricos y metadatos. Se recomienda su almacenamiento en bases de datos por ser persistente. Puede actualizarse automáticamente en caso de cambios en la tecnología de extracción. Está codificado en base64 RFC4648."},"SearchOptions":{"type":"object","description":"Opciones al buscar patrones biométricos.","properties":{"maxCandidates":{"$ref":"#/components/schemas/MaxCandidates"},"minSimilariry":{"$ref":"#/components/schemas/MinSimilarity"}}},"MaxCandidates":{"type":"integer","default":1,"description":"El número máximo de candidatos que se desean en la respuesta."},"MinSimilarity":{"type":"number","default":0,"description":"La similitud mínima requerida para que un candidato se incluya en la respuesta."}}}}
```

## The ConfigBody object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"ConfigBody":{"type":"object","description":"Body para la solicitud de config. Este endpoint no acepta parámetros de autenticación JWT.","properties":{"config_json_string":{"type":"string","description":"Cadena JSON con los parámetros de configuración del servicio."}},"required":["config_json_string"]}}}}
```

## The ExtractResponse object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"ExtractResponse":{"type":"object","description":"Respuesta de extracción biométrica","properties":{"facialTemplate":{"$ref":"#/components/schemas/FacialTemplate"},"facialTemplateRaw":{"$ref":"#/components/schemas/FacialTemplateRaw"},"updatedTemplateRaw":{"$ref":"#/components/schemas/UpdatedTemplateRaw"}}},"FacialTemplate":{"type":"string","description":"Patrón biométrico facial, codificado en base64 RFC4648."},"FacialTemplateRaw":{"type":"string","description":"Un token extendido que contiene patrones biométricos y metadatos. Se recomienda su almacenamiento en bases de datos por ser persistente. Puede actualizarse automáticamente en caso de cambios en la tecnología de extracción. Está codificado en base64 RFC4648."},"UpdatedTemplateRaw":{"type":"boolean","default":false,"description":"Si es true, significa que el templateRaw se ha actualizado tras una operación de extracción. Esto se puede usar para determinar si el templateRaw debe actualizarse en las bases de datos."}}}}
```

## The UploadMediaResponse object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"UploadMediaResponse":{"type":"object","description":"Respuesta de subida de recursos multimedia","properties":{"id":{"$ref":"#/components/schemas/MediaId"}}},"MediaId":{"type":"string","description":"Un identificador de imagen en la base de datos."}}}}
```

## The FaceResponse object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"FaceResponse":{"type":"object","description":"Campos de datos del espécimen en la base de datos","properties":{"createAt":{"$ref":"#/components/schemas/CreateAt"},"description":{"$ref":"#/components/schemas/FaceDescription"},"facialTemplateRaw":{"$ref":"#/components/schemas/FacialTemplateRaw"},"id":{"$ref":"#/components/schemas/FaceId"},"mediaId":{"$ref":"#/components/schemas/MediaId"},"tenantId":{"$ref":"#/components/schemas/TenantId"},"updateAt":{"$ref":"#/components/schemas/UpdateAt"}}},"CreateAt":{"type":"string","description":"Valor de fecha/hora en formato \"%Y-%m-%dT%H:%M:%SZ\" en el que se creó un espécimen (rostro)."},"FaceDescription":{"type":"string","description":"Descripción del espécimen (rostro) que se almacena en la base de datos."},"FacialTemplateRaw":{"type":"string","description":"Un token extendido que contiene patrones biométricos y metadatos. Se recomienda su almacenamiento en bases de datos por ser persistente. Puede actualizarse automáticamente en caso de cambios en la tecnología de extracción. Está codificado en base64 RFC4648."},"FaceId":{"type":"string","description":"Un identificador de un espécimen (rostro) en la base de datos."},"MediaId":{"type":"string","description":"Un identificador de imagen en la base de datos."},"TenantId":{"type":"string","description":"Un identificador que permite agrupar distintas imágenes o patrones biométricos en un espacio común."},"UpdateAt":{"type":"string","description":"Valor de fecha/hora en formato \"%Y-%m-%dT%H:%M:%SZ\" en el que se actualizó un espécimen (rostro)."}}}}
```

## The FacesResponse object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"FacesResponse":{"type":"array","description":"Campos de datos de varios especímenes en la base de datos","items":{"$ref":"#/components/schemas/FaceResponse"}},"FaceResponse":{"type":"object","description":"Campos de datos del espécimen en la base de datos","properties":{"createAt":{"$ref":"#/components/schemas/CreateAt"},"description":{"$ref":"#/components/schemas/FaceDescription"},"facialTemplateRaw":{"$ref":"#/components/schemas/FacialTemplateRaw"},"id":{"$ref":"#/components/schemas/FaceId"},"mediaId":{"$ref":"#/components/schemas/MediaId"},"tenantId":{"$ref":"#/components/schemas/TenantId"},"updateAt":{"$ref":"#/components/schemas/UpdateAt"}}},"CreateAt":{"type":"string","description":"Valor de fecha/hora en formato \"%Y-%m-%dT%H:%M:%SZ\" en el que se creó un espécimen (rostro)."},"FaceDescription":{"type":"string","description":"Descripción del espécimen (rostro) que se almacena en la base de datos."},"FacialTemplateRaw":{"type":"string","description":"Un token extendido que contiene patrones biométricos y metadatos. Se recomienda su almacenamiento en bases de datos por ser persistente. Puede actualizarse automáticamente en caso de cambios en la tecnología de extracción. Está codificado en base64 RFC4648."},"FaceId":{"type":"string","description":"Un identificador de un espécimen (rostro) en la base de datos."},"MediaId":{"type":"string","description":"Un identificador de imagen en la base de datos."},"TenantId":{"type":"string","description":"Un identificador que permite agrupar distintas imágenes o patrones biométricos en un espacio común."},"UpdateAt":{"type":"string","description":"Valor de fecha/hora en formato \"%Y-%m-%dT%H:%M:%SZ\" en el que se actualizó un espécimen (rostro)."}}}}
```

## The SearchItem object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"SearchItem":{"type":"object","description":"Espécimen encontrado en la base de datos","properties":{"galleryIndex":{"$ref":"#/components/schemas/GalleryIndex"},"similarity":{"$ref":"#/components/schemas/Similarity"},"templateId":{"$ref":"#/components/schemas/FaceId"}}},"GalleryIndex":{"type":"integer","description":"La posición que ocupa un elemento en la galería."},"Similarity":{"type":"number","default":0,"description":"Un valor entre 0 y 1 que indica el valor de similitud entre dos patrones biométricos."},"FaceId":{"type":"string","description":"Un identificador de un espécimen (rostro) en la base de datos."}}}}
```

## The SearchResponse object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"SearchResponse":{"type":"array","description":"Una lista de especímenes (rostros) encontrados en la base de datos","items":{"$ref":"#/components/schemas/SearchItem"}},"SearchItem":{"type":"object","description":"Espécimen encontrado en la base de datos","properties":{"galleryIndex":{"$ref":"#/components/schemas/GalleryIndex"},"similarity":{"$ref":"#/components/schemas/Similarity"},"templateId":{"$ref":"#/components/schemas/FaceId"}}},"GalleryIndex":{"type":"integer","description":"La posición que ocupa un elemento en la galería."},"Similarity":{"type":"number","default":0,"description":"Un valor entre 0 y 1 que indica el valor de similitud entre dos patrones biométricos."},"FaceId":{"type":"string","description":"Un identificador de un espécimen (rostro) en la base de datos."}}}}
```

## The ConfigResult object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"ConfigResult":{"type":"object","description":"Objeto JSON con los parámetros de configuración del servicio expuestos por el endpoint de gestión. Los parámetros de autenticación JWT se omiten intencionadamente."}}}}
```

## The BadRequestResult object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"BadRequestResult":{"type":"object","description":"Resultado cuando llegan parámetros incorrectos en la solicitud.","properties":{"status":{"type":"number"},"error":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"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":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"ExceptionResult":{"type":"object","description":"Se ha producido un error en la llamada a los servicios del backend.","properties":{"status":{"type":"number"},"error":{"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\"."}}}}
```

## The HealthStatus object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"HealthStatus":{"type":"string","description":"Resultado del servicio de salud (indica si el SDK está activo o no).","enum":["Healthy","Unhealthy"]}}}}
```

## The HealthResult object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"HealthResult":{"type":"object","description":"El resultado de una comprobación de salud.","properties":{"message":{"$ref":"#/components/schemas/HealthStatus"}}},"HealthStatus":{"type":"string","description":"Resultado del servicio de salud (indica si el SDK está activo o no).","enum":["Healthy","Unhealthy"]}}}}
```

## The VersionResult object

```json
{"openapi":"3.0.1","info":{"title":"API REST de Backend1n-Service","version":"4.2.0"},"components":{"schemas":{"VersionResult":{"type":"object","description":"El resultado de una comprobación de versión.","properties":{"message":{"type":"string"}}}}}}
```