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

# Models

## The type object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"type":{"type":"string","description":"The type of document to process must be specified, since our service can handle different types of documents.","enum":["id_card","passport","driver_license","foreign_card","invoice","pdf"]}}}}
```

## The model object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"model":{"type":"string","description":"This parameter specifies the ID of the document to process."}}}}
```

## The image object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"image":{"type":"string","description":"This parameter specifies the image to process, encoded in base64 RFC4648."}}}}
```

## The isCropped object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"isCropped":{"type":"boolean","default":false,"deprecated":true,"description":"If the `image` is already cropped and aligned, the service can skip these operations. Only applies to `invoice` documents."}}}}
```

## The forceDetection object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"forceDetection":{"type":"boolean","default":false,"deprecated":true,"description":"If the `invoice` document does not have the correct aspect ratio, the service can perform an operation to correct it and improve document detection. Only applies to `invoice` documents."}}}}
```

## The files object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"files":{"type":"array","description":"Array of images as raw buffers encoded in base64 RFC4648.","items":{"type":"string"}}}}}
```

## The retrieveImages object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"retrieveImages":{"type":"boolean","default":false,"description":"The service will return the cropped image in base64 in the final result."}}}}
```

## The DictionaryResult object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"DictionaryResult":{"type":"object","description":"Fields detected in an image. They will differ depending on the image.","properties":{"DateOfBirth":{"type":"string","description":"Date of birth."},"DateOfExpiry":{"type":"string","description":"Expiry date."},"DateOfIssue":{"type":"string","description":"Issue date."},"DocumentCaptured":{"type":"string","description":"Type of document captured."},"DocumentNumber":{"type":"string","description":"Document number."},"FirstName":{"type":"string","description":"First name."},"Nationality":{"type":"string","description":"Nationality."}}}}}}
```

## The ProcessResult object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ProcessResult":{"type":"object","description":"Result of processing an image.","properties":{"dictionary":{"$ref":"#/components/schemas/DictionaryResult"},"type":{"$ref":"#/components/schemas/type"},"model":{"$ref":"#/components/schemas/model"},"version":{"type":"string","description":"Version of the detected document."},"side":{"type":"string","description":"Side of the detected document."},"croppedImage":{"type":"string","description":"Cropped image encoded in base64 RFC4648."}}},"DictionaryResult":{"type":"object","description":"Fields detected in an image. They will differ depending on the image.","properties":{"DateOfBirth":{"type":"string","description":"Date of birth."},"DateOfExpiry":{"type":"string","description":"Expiry date."},"DateOfIssue":{"type":"string","description":"Issue date."},"DocumentCaptured":{"type":"string","description":"Type of document captured."},"DocumentNumber":{"type":"string","description":"Document number."},"FirstName":{"type":"string","description":"First name."},"Nationality":{"type":"string","description":"Nationality."}}},"type":{"type":"string","description":"The type of document to process must be specified, since our service can handle different types of documents.","enum":["id_card","passport","driver_license","foreign_card","invoice","pdf"]},"model":{"type":"string","description":"This parameter specifies the ID of the document to process."}}}}
```

## The ProcessResultUniversal object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ProcessResultUniversal":{"type":"object","description":"Result in universal response format of an image processing (multi-alphabet support).","required":["version","type","model","ocr","viz","checks"],"properties":{"version":{"type":"integer","description":"Version of the OCR UR JSON schema."},"type":{"type":"string","description":"Document type."},"model":{"type":"string","description":"Document model."},"ocr":{"type":"object","description":"Dictionary of OCR fields processed by widgets (keys without Side/Source/FieldName structure).","additionalProperties":{"$ref":"#/components/schemas/UROCRField"}},"images":{"type":"array","description":"Array containing the images extracted from the document.","items":{"$ref":"#/components/schemas/URImage"}},"viz":{"type":"array","description":"Data extracted through the ML/VIZ source.","items":{"$ref":"#/components/schemas/URViz"}},"mrz":{"type":"array","description":"Data extracted from the MRZ (Machine Readable Zone).","items":{"$ref":"#/components/schemas/URMRZ"}},"encoded":{"type":"array","description":"Data extracted from QR, barcode or PDF417.","items":{"$ref":"#/components/schemas/UREncoded"}},"nfc":{"type":"array","description":"Data extracted through NFC.","items":{"$ref":"#/components/schemas/URNFC"}},"checks":{"$ref":"#/components/schemas/URChecks"}}},"UROCRField":{"type":"object","description":"OCR field with value, confidence and source information.","required":["value"],"properties":{"value":{"type":"string","description":"The extracted value."},"confidence":{"type":"number","description":"Confidence score of the extraction.","minimum":0,"maximum":1},"source":{"$ref":"#/components/schemas/UROCRSource"}}},"UROCRSource":{"type":"object","description":"Source information of an OCR field.","required":["type","index"],"properties":{"type":{"$ref":"#/components/schemas/URSourceType"},"index":{"type":"integer","description":"Index of the source element."}}},"URSourceType":{"type":"string","description":"Type of source of the extracted data.","enum":["viz","encoded","nfc","mrz"]},"URImage":{"type":"object","description":"Image extracted from the document.","required":["type","source"],"properties":{"type":{"$ref":"#/components/schemas/URImageType"},"side":{"type":"integer","description":"Side of the document (0=Front, 1=Back)."},"source":{"$ref":"#/components/schemas/URSourceType"},"content":{"$ref":"#/components/schemas/URImageContent"},"region":{"$ref":"#/components/schemas/URRegion"}}},"URImageType":{"type":"string","description":"Type of extracted image.","enum":["portrait","ghost","signature","fullFrame","document","fingerprint"]},"URImageContent":{"type":"object","description":"Content of an image in base64 format.","required":["data","length"],"properties":{"data":{"type":"string","description":"Image data encoded in base64 RFC4648."},"length":{"type":"integer","description":"Length of the image data."},"mime_type":{"type":"string","description":"MIME type of the image."}}},"URRegion":{"type":"object","description":"Region coordinates that define the location of the extracted data in the image.","required":["top_left","top_right","bottom_left","bottom_right"],"properties":{"top_left":{"$ref":"#/components/schemas/URCoordinates"},"top_right":{"$ref":"#/components/schemas/URCoordinates"},"bottom_left":{"$ref":"#/components/schemas/URCoordinates"},"bottom_right":{"$ref":"#/components/schemas/URCoordinates"}}},"URCoordinates":{"type":"object","description":"X,Y coordinates in the image.","required":["x","y"],"properties":{"x":{"type":"number","description":"X coordinate."},"y":{"type":"number","description":"Y coordinate."}}},"URViz":{"type":"object","description":"Data extracted through the ML/VIZ source.","required":["field","value","side"],"properties":{"field":{"type":"string","description":"Field name."},"value":{"type":"string","description":"Extracted value."},"side":{"type":"integer","description":"Side of the document (0=Front, 1=Back)."},"confidence":{"type":"number","description":"Confidence score.","minimum":0,"maximum":1},"alphabet":{"type":"string","description":"Alphabet used in the field."},"region":{"$ref":"#/components/schemas/URRegion"}}},"URMRZ":{"type":"object","description":"MRZ (Machine Readable Zone) data.","required":["side","raw","fields"],"properties":{"side":{"type":"integer","description":"Side of the document (0=Front, 1=Back)."},"confidence":{"type":"number","description":"Confidence score.","minimum":0,"maximum":1},"raw":{"type":"string","description":"Raw MRZ text (equivalent to the MrzText field)."},"fields":{"type":"object","description":"Dictionary of parsed MRZ fields.","additionalProperties":{"type":"string"}},"region":{"$ref":"#/components/schemas/URRegion"}}},"UREncoded":{"type":"object","description":"Data extracted from encoded formats (QR, barcode, PDF417).","required":["fields","type","side","raw","rawBinary"],"properties":{"fields":{"type":"object","description":"Dictionary of fields parsed from the encoded data.","additionalProperties":{"type":"string"}},"type":{"$ref":"#/components/schemas/UREncodedType"},"side":{"type":"integer","description":"Side of the document (0=Front, 1=Back)."},"raw":{"type":"string","description":"Raw decoded string (QrData, BarcodeData or PdfData)."},"rawBinary":{"type":"string","description":"Original binary data extracted from the encoded image, in base64."},"region":{"$ref":"#/components/schemas/URRegion"}}},"UREncodedType":{"type":"string","description":"Type of encoded data.","enum":["qr","barcode","pdf"]},"URNFC":{"type":"object","description":"Data extracted through the NFC component.","required":["field","value"],"properties":{"field":{"type":"string","description":"NFC field name."},"value":{"type":"string","description":"Value extracted through NFC."},"alphabet":{"type":"string","description":"Alphabet used in the field."}}},"URChecks":{"type":"object","description":"Validation checks performed on the OCR data.","properties":{"field_inconsistency":{"type":"array","description":"List of field inconsistencies found.","items":{"$ref":"#/components/schemas/FieldInconsistency"}}}},"FieldInconsistency":{"type":"object","description":"Inconsistency detected between the values of a field.","required":["field","distance"],"properties":{"field":{"type":"string","description":"Name of the field with an inconsistency."},"values":{"type":"array","description":"Different values found for the same field.","items":{"type":"string"}},"distance":{"type":"integer","description":"Distance metric of the inconsistency."}}}}}}
```

## The UROCRField object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"UROCRField":{"type":"object","description":"OCR field with value, confidence and source information.","required":["value"],"properties":{"value":{"type":"string","description":"The extracted value."},"confidence":{"type":"number","description":"Confidence score of the extraction.","minimum":0,"maximum":1},"source":{"$ref":"#/components/schemas/UROCRSource"}}},"UROCRSource":{"type":"object","description":"Source information of an OCR field.","required":["type","index"],"properties":{"type":{"$ref":"#/components/schemas/URSourceType"},"index":{"type":"integer","description":"Index of the source element."}}},"URSourceType":{"type":"string","description":"Type of source of the extracted data.","enum":["viz","encoded","nfc","mrz"]}}}}
```

## The UROCRSource object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"UROCRSource":{"type":"object","description":"Source information of an OCR field.","required":["type","index"],"properties":{"type":{"$ref":"#/components/schemas/URSourceType"},"index":{"type":"integer","description":"Index of the source element."}}},"URSourceType":{"type":"string","description":"Type of source of the extracted data.","enum":["viz","encoded","nfc","mrz"]}}}}
```

## The URSourceType object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URSourceType":{"type":"string","description":"Type of source of the extracted data.","enum":["viz","encoded","nfc","mrz"]}}}}
```

## The URImage object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URImage":{"type":"object","description":"Image extracted from the document.","required":["type","source"],"properties":{"type":{"$ref":"#/components/schemas/URImageType"},"side":{"type":"integer","description":"Side of the document (0=Front, 1=Back)."},"source":{"$ref":"#/components/schemas/URSourceType"},"content":{"$ref":"#/components/schemas/URImageContent"},"region":{"$ref":"#/components/schemas/URRegion"}}},"URImageType":{"type":"string","description":"Type of extracted image.","enum":["portrait","ghost","signature","fullFrame","document","fingerprint"]},"URSourceType":{"type":"string","description":"Type of source of the extracted data.","enum":["viz","encoded","nfc","mrz"]},"URImageContent":{"type":"object","description":"Content of an image in base64 format.","required":["data","length"],"properties":{"data":{"type":"string","description":"Image data encoded in base64 RFC4648."},"length":{"type":"integer","description":"Length of the image data."},"mime_type":{"type":"string","description":"MIME type of the image."}}},"URRegion":{"type":"object","description":"Region coordinates that define the location of the extracted data in the image.","required":["top_left","top_right","bottom_left","bottom_right"],"properties":{"top_left":{"$ref":"#/components/schemas/URCoordinates"},"top_right":{"$ref":"#/components/schemas/URCoordinates"},"bottom_left":{"$ref":"#/components/schemas/URCoordinates"},"bottom_right":{"$ref":"#/components/schemas/URCoordinates"}}},"URCoordinates":{"type":"object","description":"X,Y coordinates in the image.","required":["x","y"],"properties":{"x":{"type":"number","description":"X coordinate."},"y":{"type":"number","description":"Y coordinate."}}}}}}
```

## The URImageType object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URImageType":{"type":"string","description":"Type of extracted image.","enum":["portrait","ghost","signature","fullFrame","document","fingerprint"]}}}}
```

## The URImageContent object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URImageContent":{"type":"object","description":"Content of an image in base64 format.","required":["data","length"],"properties":{"data":{"type":"string","description":"Image data encoded in base64 RFC4648."},"length":{"type":"integer","description":"Length of the image data."},"mime_type":{"type":"string","description":"MIME type of the image."}}}}}}
```

## The URViz object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URViz":{"type":"object","description":"Data extracted through the ML/VIZ source.","required":["field","value","side"],"properties":{"field":{"type":"string","description":"Field name."},"value":{"type":"string","description":"Extracted value."},"side":{"type":"integer","description":"Side of the document (0=Front, 1=Back)."},"confidence":{"type":"number","description":"Confidence score.","minimum":0,"maximum":1},"alphabet":{"type":"string","description":"Alphabet used in the field."},"region":{"$ref":"#/components/schemas/URRegion"}}},"URRegion":{"type":"object","description":"Region coordinates that define the location of the extracted data in the image.","required":["top_left","top_right","bottom_left","bottom_right"],"properties":{"top_left":{"$ref":"#/components/schemas/URCoordinates"},"top_right":{"$ref":"#/components/schemas/URCoordinates"},"bottom_left":{"$ref":"#/components/schemas/URCoordinates"},"bottom_right":{"$ref":"#/components/schemas/URCoordinates"}}},"URCoordinates":{"type":"object","description":"X,Y coordinates in the image.","required":["x","y"],"properties":{"x":{"type":"number","description":"X coordinate."},"y":{"type":"number","description":"Y coordinate."}}}}}}
```

## The URMRZ object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URMRZ":{"type":"object","description":"MRZ (Machine Readable Zone) data.","required":["side","raw","fields"],"properties":{"side":{"type":"integer","description":"Side of the document (0=Front, 1=Back)."},"confidence":{"type":"number","description":"Confidence score.","minimum":0,"maximum":1},"raw":{"type":"string","description":"Raw MRZ text (equivalent to the MrzText field)."},"fields":{"type":"object","description":"Dictionary of parsed MRZ fields.","additionalProperties":{"type":"string"}},"region":{"$ref":"#/components/schemas/URRegion"}}},"URRegion":{"type":"object","description":"Region coordinates that define the location of the extracted data in the image.","required":["top_left","top_right","bottom_left","bottom_right"],"properties":{"top_left":{"$ref":"#/components/schemas/URCoordinates"},"top_right":{"$ref":"#/components/schemas/URCoordinates"},"bottom_left":{"$ref":"#/components/schemas/URCoordinates"},"bottom_right":{"$ref":"#/components/schemas/URCoordinates"}}},"URCoordinates":{"type":"object","description":"X,Y coordinates in the image.","required":["x","y"],"properties":{"x":{"type":"number","description":"X coordinate."},"y":{"type":"number","description":"Y coordinate."}}}}}}
```

## The UREncoded object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"UREncoded":{"type":"object","description":"Data extracted from encoded formats (QR, barcode, PDF417).","required":["fields","type","side","raw","rawBinary"],"properties":{"fields":{"type":"object","description":"Dictionary of fields parsed from the encoded data.","additionalProperties":{"type":"string"}},"type":{"$ref":"#/components/schemas/UREncodedType"},"side":{"type":"integer","description":"Side of the document (0=Front, 1=Back)."},"raw":{"type":"string","description":"Raw decoded string (QrData, BarcodeData or PdfData)."},"rawBinary":{"type":"string","description":"Original binary data extracted from the encoded image, in base64."},"region":{"$ref":"#/components/schemas/URRegion"}}},"UREncodedType":{"type":"string","description":"Type of encoded data.","enum":["qr","barcode","pdf"]},"URRegion":{"type":"object","description":"Region coordinates that define the location of the extracted data in the image.","required":["top_left","top_right","bottom_left","bottom_right"],"properties":{"top_left":{"$ref":"#/components/schemas/URCoordinates"},"top_right":{"$ref":"#/components/schemas/URCoordinates"},"bottom_left":{"$ref":"#/components/schemas/URCoordinates"},"bottom_right":{"$ref":"#/components/schemas/URCoordinates"}}},"URCoordinates":{"type":"object","description":"X,Y coordinates in the image.","required":["x","y"],"properties":{"x":{"type":"number","description":"X coordinate."},"y":{"type":"number","description":"Y coordinate."}}}}}}
```

## The UREncodedType object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"UREncodedType":{"type":"string","description":"Type of encoded data.","enum":["qr","barcode","pdf"]}}}}
```

## The URNFC object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URNFC":{"type":"object","description":"Data extracted through the NFC component.","required":["field","value"],"properties":{"field":{"type":"string","description":"NFC field name."},"value":{"type":"string","description":"Value extracted through NFC."},"alphabet":{"type":"string","description":"Alphabet used in the field."}}}}}}
```

## The URChecks object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URChecks":{"type":"object","description":"Validation checks performed on the OCR data.","properties":{"field_inconsistency":{"type":"array","description":"List of field inconsistencies found.","items":{"$ref":"#/components/schemas/FieldInconsistency"}}}},"FieldInconsistency":{"type":"object","description":"Inconsistency detected between the values of a field.","required":["field","distance"],"properties":{"field":{"type":"string","description":"Name of the field with an inconsistency."},"values":{"type":"array","description":"Different values found for the same field.","items":{"type":"string"}},"distance":{"type":"integer","description":"Distance metric of the inconsistency."}}}}}}
```

## The FieldInconsistency object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"FieldInconsistency":{"type":"object","description":"Inconsistency detected between the values of a field.","required":["field","distance"],"properties":{"field":{"type":"string","description":"Name of the field with an inconsistency."},"values":{"type":"array","description":"Different values found for the same field.","items":{"type":"string"}},"distance":{"type":"integer","description":"Distance metric of the inconsistency."}}}}}}
```

## The URRegion object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URRegion":{"type":"object","description":"Region coordinates that define the location of the extracted data in the image.","required":["top_left","top_right","bottom_left","bottom_right"],"properties":{"top_left":{"$ref":"#/components/schemas/URCoordinates"},"top_right":{"$ref":"#/components/schemas/URCoordinates"},"bottom_left":{"$ref":"#/components/schemas/URCoordinates"},"bottom_right":{"$ref":"#/components/schemas/URCoordinates"}}},"URCoordinates":{"type":"object","description":"X,Y coordinates in the image.","required":["x","y"],"properties":{"x":{"type":"number","description":"X coordinate."},"y":{"type":"number","description":"Y coordinate."}}}}}}
```

## The URCoordinates object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URCoordinates":{"type":"object","description":"X,Y coordinates in the image.","required":["x","y"],"properties":{"x":{"type":"number","description":"X coordinate."},"y":{"type":"number","description":"Y coordinate."}}}}}}
```

## The ProcessBody object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ProcessBody":{"type":"object","description":"Body for OCR processing","properties":{"type":{"$ref":"#/components/schemas/type"},"model":{"$ref":"#/components/schemas/model"},"files":{"$ref":"#/components/schemas/files"},"isCropped":{"$ref":"#/components/schemas/isCropped"},"forceDetection":{"$ref":"#/components/schemas/forceDetection"},"retrieveImages":{"$ref":"#/components/schemas/retrieveImages"}}},"type":{"type":"string","description":"The type of document to process must be specified, since our service can handle different types of documents.","enum":["id_card","passport","driver_license","foreign_card","invoice","pdf"]},"model":{"type":"string","description":"This parameter specifies the ID of the document to process."},"files":{"type":"array","description":"Array of images as raw buffers encoded in base64 RFC4648.","items":{"type":"string"}},"isCropped":{"type":"boolean","default":false,"deprecated":true,"description":"If the `image` is already cropped and aligned, the service can skip these operations. Only applies to `invoice` documents."},"forceDetection":{"type":"boolean","default":false,"deprecated":true,"description":"If the `invoice` document does not have the correct aspect ratio, the service can perform an operation to correct it and improve document detection. Only applies to `invoice` documents."},"retrieveImages":{"type":"boolean","default":false,"description":"The service will return the cropped image in base64 in the final result."}}}}
```

## The RawBody object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"RawBody":{"type":"object","description":"Body for OCR processing in raw mode","properties":{"type":{"$ref":"#/components/schemas/type"},"image":{"$ref":"#/components/schemas/image"}}},"type":{"type":"string","description":"The type of document to process must be specified, since our service can handle different types of documents.","enum":["id_card","passport","driver_license","foreign_card","invoice","pdf"]},"image":{"type":"string","description":"This parameter specifies the image to process, encoded in base64 RFC4648."}}}}
```

## The RawResultVertice object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"RawResultVertice":{"type":"object","description":"x, y coordinates in clockwise order.","properties":{"x":{"type":"number"},"y":{"type":"number"}}}}}}
```

## The RawResultVertices object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"RawResultVertices":{"type":"array","description":"x, y coordinates in clockwise order.","items":{"$ref":"#/components/schemas/RawResultVertice"}},"RawResultVertice":{"type":"object","description":"x, y coordinates in clockwise order.","properties":{"x":{"type":"number"},"y":{"type":"number"}}}}}}
```

## The RawResult object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"RawResult":{"type":"object","description":"Result of processing an image.","properties":{"description":{"type":"string","description":"Word found."},"vertices":{"type":"array","description":"Four x, y coordinates in clockwise order.","items":{"$ref":"#/components/schemas/RawResultVertices"}},"confidence":{"type":"number","description":"Confidence of the word."}}},"RawResultVertices":{"type":"array","description":"x, y coordinates in clockwise order.","items":{"$ref":"#/components/schemas/RawResultVertice"}},"RawResultVertice":{"type":"object","description":"x, y coordinates in clockwise order.","properties":{"x":{"type":"number"},"y":{"type":"number"}}}}}}
```

## The TimeStamp object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"TimeStamp":{"type":"string","description":"A date/time value in format \"%Y-%m-%dT%H:%M:%SZ\"."}}}}
```

## The BadRequestResult object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"BadRequestResult":{"type":"object","description":"Result when incorrect parameters are received in the request.","properties":{"status":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"A date/time value in format \"%Y-%m-%dT%H:%M:%SZ\"."}}}}
```

## The ExceptionResult object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ExceptionResult":{"type":"object","description":"An error occurred in the call to the OCR-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 format \"%Y-%m-%dT%H:%M:%SZ\"."}}}}
```

## The HealthStatus object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"HealthStatus":{"type":"string","description":"Result of the service health status (whether the SDK is active or not).","enum":["Healthy","No healthy"]}}}}
```

## The HealthResult object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"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 service health status (whether the SDK is active or not).","enum":["Healthy","No healthy"]}}}}
```

## The VersionResult object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"VersionResult":{"type":"object","description":"The result of a version check.","properties":{"message":{"type":"string"}}}}}}
```

## The ConfigResult object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ConfigResult":{"type":"object","description":"JSON object with the service configuration parameters. JWT authentication settings are intentionally omitted."}}}}
```

## The ConfigBody object

```json
{"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ConfigBody":{"type":"object","description":"Body for the configuration request. This endpoint does not accept JWT authentication settings.","properties":{"config_json_string":{"type":"string","description":"JSON string with the configuration parameters to modify. Only the read-write parameters listed in `POST /api/v1/config` are applied."}},"required":["config_json_string"]}}}}
```