> 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/finger/technical_documentation/api_reference/models.md).

# Models

## The TimeStamp object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"TimeStamp":{"type":"string","description":"Fecha y hora en formato ISO-8601."}}}}
```

## The MessageResult object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"MessageResult":{"type":"object","properties":{"message":{"type":"string","description":"Mensaje del servicio."}},"required":["message"]}}}}
```

## The ConfigData object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"ConfigData":{"type":"object","description":"Configuración actual de arranque/tiempo de ejecución expuesta por el endpoint de gestión. Los ajustes de autenticación JWT se omiten intencionadamente.","properties":{"port":{"type":"string"},"number_of_threads":{"type":"string"},"connection_timeout":{"type":"string"},"keep_alive_request_number":{"type":"string"},"client_max_body_size":{"type":"string","description":"Tamaño máximo del cuerpo de la petición en MB."},"logger_path":{"type":"string"},"logger_level":{"type":"string"},"logger_rotation":{"type":"string"},"logger_max_files":{"type":"string"}}}}}}
```

## The ConfigUpdateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"ConfigUpdateRequest":{"type":"object","required":["config_json_string"],"properties":{"config_json_string":{"type":"string","description":"Configuración completa en tiempo de ejecución serializada como cadena JSON. Este endpoint no acepta ajustes de autenticación JWT."}}}}}}
```

## The PublicOptions object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"PublicOptions":{"type":"object","description":"Parámetros de ajuste opcionales para las operaciones de extract y authenticate.","properties":{"dpi":{"type":"integer","minimum":250,"maximum":1000,"default":500},"scanType":{"type":"string","enum":["Plain","Rolled","Latent"],"default":"Plain"},"includeQuality":{"type":"boolean","default":true},"authThreshold":{"type":"integer","description":"Umbral de autenticación como número entero entre 0 y 100.","minimum":0,"maximum":100,"default":20}}}}}}
```

## The ExtractRequest object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"ExtractRequest":{"type":"object","required":["image","position"],"properties":{"image":{"type":"string","description":"Imagen de huella dactilar codificada en Base64. Formatos admitidos; wsq, bmp, png, jpg, jp2."},"position":{"type":"string","description":"Nombre público de la posición del dedo.","enum":["RightThumb","RightIndex","RightMiddle","RightRing","RightLittle","LeftThumb","LeftIndex","LeftMiddle","LeftRing","LeftLittle"]},"options":{"$ref":"#/components/schemas/PublicOptions"}}},"PublicOptions":{"type":"object","description":"Parámetros de ajuste opcionales para las operaciones de extract y authenticate.","properties":{"dpi":{"type":"integer","minimum":250,"maximum":1000,"default":500},"scanType":{"type":"string","enum":["Plain","Rolled","Latent"],"default":"Plain"},"includeQuality":{"type":"boolean","default":true},"authThreshold":{"type":"integer","description":"Umbral de autenticación como número entero entre 0 y 100.","minimum":0,"maximum":100,"default":20}}}}}}
```

## The QualityDetails object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"QualityDetails":{"type":"object","properties":{"nfiq2":{"type":"number","format":"float"},"nfiq":{"type":"number","format":"float"},"score":{"type":"number","format":"float"}}}}}}
```

## The ExtractResponse object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"ExtractResponse":{"type":"object","description":"Respuesta pública de extract.","required":["fingerTemplate","position","scanType","sdkDuration","queueDuration"],"properties":{"fingerTemplate":{"type":"string","description":"Plantilla generada, codificada en Base64."},"position":{"type":"string","enum":["RightThumb","RightIndex","RightMiddle","RightRing","RightLittle","LeftThumb","LeftIndex","LeftMiddle","LeftRing","LeftLittle"]},"scanType":{"type":"string","enum":["Plain","Rolled","Latent"]},"quality":{"type":"integer","description":"Puntuación de calidad global (0-100), cuando está disponible."},"qualityDetails":{"$ref":"#/components/schemas/QualityDetails"},"sdkDuration":{"type":"integer","format":"int64","description":"Tiempo de ejecución del SDK en milisegundos."},"queueDuration":{"type":"integer","format":"int64","description":"Tiempo de espera en cola en milisegundos."}}},"QualityDetails":{"type":"object","properties":{"nfiq2":{"type":"number","format":"float"},"nfiq":{"type":"number","format":"float"},"score":{"type":"number","format":"float"}}}}}}
```

## The AuthenticateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"AuthenticateRequest":{"type":"object","description":"Petición pública de autenticación 1:1.\nSe requiere exactamente un origen por lado:\n- Lado 1: image1 o fingerTemplate1\n- Lado 2: image2 o fingerTemplate2\nLa posición puede indicarse como `position` compartida o mediante `position1` y `position2` específicas de cada lado.\n","properties":{"image1":{"type":"string","description":"Imagen de huella dactilar de referencia (probe), codificada en Base64. Formatos admitidos; wsq, bmp, png, jpg, jp2."},"image2":{"type":"string","description":"Imagen de huella dactilar de galería, codificada en Base64. Formatos admitidos; wsq, bmp, png, jpg, jp2."},"fingerTemplate1":{"type":"string","description":"Plantilla de huella dactilar de referencia (probe), codificada en Base64."},"fingerTemplate2":{"type":"string","description":"Plantilla de huella dactilar de galería, codificada en Base64."},"position":{"type":"string","description":"Posición pública compartida del dedo, usada cuando no se indican posiciones específicas por lado.","enum":["RightThumb","RightIndex","RightMiddle","RightRing","RightLittle","LeftThumb","LeftIndex","LeftMiddle","LeftRing","LeftLittle"]},"position1":{"type":"string","description":"Sobrescritura opcional de la posición del dedo de referencia (probe).","enum":["RightThumb","RightIndex","RightMiddle","RightRing","RightLittle","LeftThumb","LeftIndex","LeftMiddle","LeftRing","LeftLittle"]},"position2":{"type":"string","description":"Sobrescritura opcional de la posición del dedo de galería.","enum":["RightThumb","RightIndex","RightMiddle","RightRing","RightLittle","LeftThumb","LeftIndex","LeftMiddle","LeftRing","LeftLittle"]},"options":{"$ref":"#/components/schemas/PublicOptions"}}},"PublicOptions":{"type":"object","description":"Parámetros de ajuste opcionales para las operaciones de extract y authenticate.","properties":{"dpi":{"type":"integer","minimum":250,"maximum":1000,"default":500},"scanType":{"type":"string","enum":["Plain","Rolled","Latent"],"default":"Plain"},"includeQuality":{"type":"boolean","default":true},"authThreshold":{"type":"integer","description":"Umbral de autenticación como número entero entre 0 y 100.","minimum":0,"maximum":100,"default":20}}}}}}
```

## The AuthenticateResponse object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"AuthenticateResponse":{"type":"object","description":"Respuesta pública de autenticación 1:1.","required":["authStatus","similarity","sdkDuration","queueDuration"],"properties":{"authStatus":{"type":"string","enum":["Positive","Negative"]},"similarity":{"type":"number","format":"float","description":"Puntuación de similitud en el rango 0-100."},"sdkDuration":{"type":"integer","format":"int64","description":"Tiempo de ejecución del SDK en milisegundos."},"queueDuration":{"type":"integer","format":"int64","description":"Tiempo de espera en cola en milisegundos."}}}}}}
```

## The UsageMetricsResponse object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"UsageMetricsResponse":{"type":"object","description":"Informe de contadores de uso de los endpoints de operaciones de huella dactilar.","required":["usageCountersEnabled","extractCount","authenticateCount","totalCount"],"properties":{"usageCountersEnabled":{"type":"boolean","description":"Indica si los contadores de uso están habilitados mediante metadatos de licencia."},"extractCount":{"type":"integer","format":"int64","minimum":0,"description":"Valor del contador de la operación extract."},"authenticateCount":{"type":"integer","format":"int64","minimum":0,"description":"Valor del contador de la operación authenticate."},"totalCount":{"type":"integer","format":"int64","minimum":0,"description":"Suma de extractCount y authenticateCount."}}}}}}
```

## The BadRequestResult object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"BadRequestResult":{"type":"object","properties":{"status":{"type":"integer"},"error":{"type":"string"},"message":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}},"required":["status","error","message","timeStamp"]},"TimeStamp":{"type":"string","description":"Fecha y hora en formato ISO-8601."}}}}
```

## The ExceptionResult object

```json
{"openapi":"3.0.1","info":{"title":"Facephi Finger Service REST API","version":"2.1.0"},"components":{"schemas":{"ExceptionResult":{"type":"object","properties":{"status":{"type":"integer"},"error":{"type":"string"},"message":{"type":"string"},"exception":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}},"required":["status","error","message","exception","timeStamp"]},"TimeStamp":{"type":"string","description":"Fecha y hora en formato ISO-8601."}}}}
```