> 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":"Unique identifier associated with the transaction being processed."}}}}
```

## The PhotoBuffer object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"PhotoBuffer":{"type":"string","description":"Photo image encoded in 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":"Operation error codes.","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":"Supported photo image types.","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":"Score resulting from the comparison."}}}}
```

## 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":"Similarity resulting from the comparison."}}}}
```

## The ServiceTime object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"ServiceTime":{"type":"integer","description":"Total time in milliseconds from when the request arrives until the response is sent."}}}}
```

## The TimeStamp object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"TimeStamp":{"type":"string","description":"A date/time value in the format \"%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":"Supported photo image types.","enum":["INE               = 0","JPEG              = 1","TEMPLATE_RAW      = 2","BEST_IMAGE_TOKEN  = 3"]},"PhotoBuffer":{"type":"string","description":"Photo image encoded in 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":"Result of the photo comparison","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":"Operation error codes.","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":"Score resulting from the comparison."},"Similarity":{"type":"number","minimum":0,"maximum":100,"description":"Similarity resulting from the comparison."},"ServiceTime":{"type":"integer","description":"Total time in milliseconds from when the request arrives until the response is sent."}}}}
```

## The AuthenticationBody object

```json
{"openapi":"3.0.0","info":{"title":"INE-Service Rest API","version":"1.7.0"},"components":{"schemas":{"AuthenticationBody":{"type":"object","description":"Authentication request body","properties":{"idTransaccion":{"$ref":"#/components/schemas/IdTransaction"},"fotoA":{"$ref":"#/components/schemas/Photo"},"fotoB":{"$ref":"#/components/schemas/Photo"}},"required":["idTransaccion","fotoA","fotoB"]},"IdTransaction":{"type":"string","description":"Unique identifier associated with the transaction being processed."},"Photo":{"type":"object","properties":{"tipo":{"$ref":"#/components/schemas/PhotoTypes"},"data":{"$ref":"#/components/schemas/PhotoBuffer"}}},"PhotoTypes":{"type":"number","description":"Supported photo image types.","enum":["INE               = 0","JPEG              = 1","TEMPLATE_RAW      = 2","BEST_IMAGE_TOKEN  = 3"]},"PhotoBuffer":{"type":"string","description":"Photo image encoded in 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":"Result returned when the request contains incorrect parameters.","properties":{"status":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"A date/time value in the format \"%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":"Result returned when the request does not provide a valid JWT.","properties":{"status":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"A date/time value in the format \"%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":"An error occurred in the call to the SDK backend.","properties":{"status":{"type":"number"},"error":{"type":"string"},"exception":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"A date/time value in the format \"%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":"Result of the health service (whether the SDK is active or not).","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":"The result of a health check.","properties":{"message":{"$ref":"#/components/schemas/HealthStatus"}}},"HealthStatus":{"type":"string","description":"Result of the health service (whether the SDK is active or not).","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":"The result of a version check.","properties":{"message":{"type":"string"},"sdk":{"type":"object","description":"SDK information returned by the service.","properties":{"version":{"type":"string"},"modules":{"type":"string"}}}}}}}}
```