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

# Models

## The IdTransaction object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"IdTransaction":{"type":"string","description":"Identificador único asociado a la transacción que se está procesando."}}}}
```

## The PhotoBuffer object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"PhotoBuffer":{"type":"string","description":"Imagen de la foto codificada en base64 RFC4648."}}}}
```

## The ErrorCodes object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"ErrorCodes":{"type":"number","description":"Códigos de error de la operación.","enum":["OK              = 0","MALFORMED_JSON  = 400","PHOTOA_EMPTY    = 401","PHOTOB_EMPTY    = 402","NO_PHOTOS       = 403","POSE_INVALID    = 404","PHOTOA_INVALID  = 405","PHOTOB_INVALID  = 406"]}}}}
```

## The PhotoTypes object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"PhotoTypes":{"type":"number","description":"Tipos de imagen de foto soportados.","enum":["INE               = 0","JPEG              = 1","TEMPLATE_RAW      = 2","BEST_IMAGE_TOKEN  = 3"]}}}}
```

## The Score object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"Score":{"type":"integer","minimum":0,"maximum":1,"description":"Puntuación resultante de la comparación."}}}}
```

## The Similarity object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"Similarity":{"type":"number","minimum":0,"maximum":100,"description":"Similitud resultante de la comparación."}}}}
```

## The ServiceTime object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"ServiceTime":{"type":"integer","description":"Tiempo total en milisegundos desde que llega la solicitud hasta que se envía la respuesta."}}}}
```

## The TimeStamp object

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

## The Photo object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"Photo":{"type":"object","properties":{"tipo":{"$ref":"#/components/schemas/PhotoTypes"},"data":{"$ref":"#/components/schemas/PhotoBuffer"}}},"PhotoTypes":{"type":"number","description":"Tipos de imagen de foto soportados.","enum":["INE               = 0","JPEG              = 1","TEMPLATE_RAW      = 2","BEST_IMAGE_TOKEN  = 3"]},"PhotoBuffer":{"type":"string","description":"Imagen de la foto codificada en base64 RFC4648."}}}}
```

## The AuthenticationResponse object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"AuthenticationResponse":{"type":"object","description":"Resultado de la comparación de fotos","properties":{"codigo":{"$ref":"#/components/schemas/ErrorCodes"},"score":{"$ref":"#/components/schemas/Score"},"resultado":{"$ref":"#/components/schemas/Similarity"},"tiempoServicio":{"$ref":"#/components/schemas/ServiceTime"}}},"ErrorCodes":{"type":"number","description":"Códigos de error de la operación.","enum":["OK              = 0","MALFORMED_JSON  = 400","PHOTOA_EMPTY    = 401","PHOTOB_EMPTY    = 402","NO_PHOTOS       = 403","POSE_INVALID    = 404","PHOTOA_INVALID  = 405","PHOTOB_INVALID  = 406"]},"Score":{"type":"integer","minimum":0,"maximum":1,"description":"Puntuación resultante de la comparación."},"Similarity":{"type":"number","minimum":0,"maximum":100,"description":"Similitud resultante de la comparación."},"ServiceTime":{"type":"integer","description":"Tiempo total en milisegundos desde que llega la solicitud hasta que se envía la respuesta."}}}}
```

## The AuthenticationBody object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"AuthenticationBody":{"type":"object","description":"Cuerpo de la solicitud de autenticación","properties":{"idTransaccion":{"$ref":"#/components/schemas/IdTransaction"},"fotoA":{"$ref":"#/components/schemas/Photo"},"fotoB":{"$ref":"#/components/schemas/Photo"}},"required":["idTransaccion","fotoA","fotoB"]},"IdTransaction":{"type":"string","description":"Identificador único asociado a la transacción que se está procesando."},"Photo":{"type":"object","properties":{"tipo":{"$ref":"#/components/schemas/PhotoTypes"},"data":{"$ref":"#/components/schemas/PhotoBuffer"}}},"PhotoTypes":{"type":"number","description":"Tipos de imagen de foto soportados.","enum":["INE               = 0","JPEG              = 1","TEMPLATE_RAW      = 2","BEST_IMAGE_TOKEN  = 3"]},"PhotoBuffer":{"type":"string","description":"Imagen de la foto codificada en base64 RFC4648."}}}}
```

## The BadRequestResult object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.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"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"Un valor de fecha/hora en formato \"%Y-%m-%dT%H:%M:%SZ\"."}}}}
```

## The UnauthorizedResult object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"UnauthorizedResult":{"type":"object","description":"Resultado cuando la solicitud no proporciona un JWT válido.","properties":{"status":{"type":"number"},"error":{"type":"string"},"message":{"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.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"ExceptionResult":{"type":"object","description":"Se ha producido un error en la llamada al backend del SDK.","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.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"HealthStatus":{"type":"string","description":"Resultado del servicio de salud (si el SDK está activo o no).","enum":["Healthy","Unhealthy"]}}}}
```

## The HealthResult object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.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 (si el SDK está activo o no).","enum":["Healthy","Unhealthy"]}}}}
```

## The VersionResult object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"VersionResult":{"type":"object","description":"El resultado de una comprobación de versión.","properties":{"message":{"type":"string"},"sdk":{"type":"object","description":"Información del SDK devuelta por el servicio.","properties":{"version":{"type":"string"},"modules":{"type":"string"}}}}}}}}
```