> 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":"Es necesario especificar el tipo de documento que se desea procesar, ya que nuestro servicio puede gestionar diferentes tipos de documentos.","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":"Este parámetro especifica el ID del documento que se va a procesar."}}}} ``` ## The image object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"image":{"type":"string","description":"Este parámetro especifica la imagen a procesar codificada en 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":"Si la `image` ya está recortada y alineada, el servicio puede evitar realizar estas operaciones. Solo aplica a documentos `invoice`."}}}} ``` ## 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":"Si el documento `invoice` no tiene la relación de aspecto correcta, el servicio puede realizar una operación para corregirla y mejorar la detección del documento. Solo aplica a documentos `invoice`."}}}} ``` ## 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 de imágenes en formato de buffer en bruto codificadas en 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":"El servicio devolverá la imagen recortada en base64 en el resultado final."}}}} ``` ## The DictionaryResult object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"DictionaryResult":{"type":"object","description":"Campos detectados en una imagen. Serán diferentes en función de la imagen.","properties":{"DateOfBirth":{"type":"string","description":"Fecha de nacimiento."},"DateOfExpiry":{"type":"string","description":"Fecha de caducidad."},"DateOfIssue":{"type":"string","description":"Fecha de expedición."},"DocumentCaptured":{"type":"string","description":"Tipo de documento capturado."},"DocumentNumber":{"type":"string","description":"Número de documento."},"FirstName":{"type":"string","description":"Nombre."},"Nationality":{"type":"string","description":"Nacionalidad."}}}}}} ``` ## The ProcessResult object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ProcessResult":{"type":"object","description":"Resultado del procesamiento de una imagen.","properties":{"dictionary":{"$ref":"#/components/schemas/DictionaryResult"},"type":{"$ref":"#/components/schemas/type"},"model":{"$ref":"#/components/schemas/model"},"version":{"type":"string","description":"Versión del documento detectado."},"side":{"type":"string","description":"Lado del documento detectado."},"croppedImage":{"type":"string","description":"Imagen recortada codificada en base64 RFC4648."}}},"DictionaryResult":{"type":"object","description":"Campos detectados en una imagen. Serán diferentes en función de la imagen.","properties":{"DateOfBirth":{"type":"string","description":"Fecha de nacimiento."},"DateOfExpiry":{"type":"string","description":"Fecha de caducidad."},"DateOfIssue":{"type":"string","description":"Fecha de expedición."},"DocumentCaptured":{"type":"string","description":"Tipo de documento capturado."},"DocumentNumber":{"type":"string","description":"Número de documento."},"FirstName":{"type":"string","description":"Nombre."},"Nationality":{"type":"string","description":"Nacionalidad."}}},"type":{"type":"string","description":"Es necesario especificar el tipo de documento que se desea procesar, ya que nuestro servicio puede gestionar diferentes tipos de documentos.","enum":["id_card","passport","driver_license","foreign_card","invoice","pdf"]},"model":{"type":"string","description":"Este parámetro especifica el ID del documento que se va a procesar."}}}} ``` ## The ProcessResultUniversal object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ProcessResultUniversal":{"type":"object","description":"Resultado en formato de respuesta universal de un procesamiento de imagen (soporte multialfabeto).","required":["version","type","model","ocr","viz","checks"],"properties":{"version":{"type":"integer","description":"Versión del esquema JSON UR de OCR."},"type":{"type":"string","description":"Tipo de documento."},"model":{"type":"string","description":"Modelo del documento."},"ocr":{"type":"object","description":"Diccionario de campos OCR procesados por widgets (claves sin estructura Side/Source/FieldName).","additionalProperties":{"$ref":"#/components/schemas/UROCRField"}},"images":{"type":"array","description":"Array que contiene las imágenes extraídas del documento.","items":{"$ref":"#/components/schemas/URImage"}},"viz":{"type":"array","description":"Datos extraídos mediante la fuente ML/VIZ.","items":{"$ref":"#/components/schemas/URViz"}},"mrz":{"type":"array","description":"Datos extraídos de la MRZ (Machine Readable Zone).","items":{"$ref":"#/components/schemas/URMRZ"}},"encoded":{"type":"array","description":"Datos extraídos de QR, código de barras o PDF417.","items":{"$ref":"#/components/schemas/UREncoded"}},"nfc":{"type":"array","description":"Datos extraídos mediante NFC.","items":{"$ref":"#/components/schemas/URNFC"}},"checks":{"$ref":"#/components/schemas/URChecks"}}},"UROCRField":{"type":"object","description":"Campo OCR con información de valor, confianza y origen.","required":["value"],"properties":{"value":{"type":"string","description":"El valor extraído."},"confidence":{"type":"number","description":"Puntuación de confianza de la extracción.","minimum":0,"maximum":1},"source":{"$ref":"#/components/schemas/UROCRSource"}}},"UROCRSource":{"type":"object","description":"Información de origen de un campo OCR.","required":["type","index"],"properties":{"type":{"$ref":"#/components/schemas/URSourceType"},"index":{"type":"integer","description":"Índice del elemento de origen."}}},"URSourceType":{"type":"string","description":"Tipo de origen de los datos extraídos.","enum":["viz","encoded","nfc","mrz"]},"URImage":{"type":"object","description":"Imagen extraída del documento.","required":["type","source"],"properties":{"type":{"$ref":"#/components/schemas/URImageType"},"side":{"type":"integer","description":"Lado del documento (0=Anverso, 1=Reverso)."},"source":{"$ref":"#/components/schemas/URSourceType"},"content":{"$ref":"#/components/schemas/URImageContent"},"region":{"$ref":"#/components/schemas/URRegion"}}},"URImageType":{"type":"string","description":"Tipo de imagen extraída.","enum":["portrait","ghost","signature","fullFrame","document","fingerprint"]},"URImageContent":{"type":"object","description":"Contenido de una imagen en formato base64.","required":["data","length"],"properties":{"data":{"type":"string","description":"Datos de la imagen codificados en base64 RFC4648."},"length":{"type":"integer","description":"Longitud de los datos de la imagen."},"mime_type":{"type":"string","description":"Tipo MIME de la imagen."}}},"URRegion":{"type":"object","description":"Coordenadas de la región que definen la ubicación de los datos extraídos en la imagen.","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":"Coordenadas X,Y en la imagen.","required":["x","y"],"properties":{"x":{"type":"number","description":"Coordenada X."},"y":{"type":"number","description":"Coordenada Y."}}},"URViz":{"type":"object","description":"Datos extraídos mediante la fuente ML/VIZ.","required":["field","value","side"],"properties":{"field":{"type":"string","description":"Nombre del campo."},"value":{"type":"string","description":"Valor extraído."},"side":{"type":"integer","description":"Lado del documento (0=Anverso, 1=Reverso)."},"confidence":{"type":"number","description":"Puntuación de confianza.","minimum":0,"maximum":1},"alphabet":{"type":"string","description":"Alfabeto utilizado en el campo."},"region":{"$ref":"#/components/schemas/URRegion"}}},"URMRZ":{"type":"object","description":"Datos de la MRZ (Machine Readable Zone).","required":["side","raw","fields"],"properties":{"side":{"type":"integer","description":"Lado del documento (0=Anverso, 1=Reverso)."},"confidence":{"type":"number","description":"Puntuación de confianza.","minimum":0,"maximum":1},"raw":{"type":"string","description":"Texto MRZ en bruto (equivalente al campo MrzText)."},"fields":{"type":"object","description":"Diccionario de campos MRZ analizados.","additionalProperties":{"type":"string"}},"region":{"$ref":"#/components/schemas/URRegion"}}},"UREncoded":{"type":"object","description":"Datos extraídos de formatos codificados (QR, código de barras, PDF417).","required":["fields","type","side","raw","rawBinary"],"properties":{"fields":{"type":"object","description":"Diccionario de campos analizados a partir de los datos codificados.","additionalProperties":{"type":"string"}},"type":{"$ref":"#/components/schemas/UREncodedType"},"side":{"type":"integer","description":"Lado del documento (0=Anverso, 1=Reverso)."},"raw":{"type":"string","description":"Cadena decodificada en bruto (QrData, BarcodeData o PdfData)."},"rawBinary":{"type":"string","description":"Datos binarios originales extraídos de la imagen codificada, en base64."},"region":{"$ref":"#/components/schemas/URRegion"}}},"UREncodedType":{"type":"string","description":"Tipo de dato codificado.","enum":["qr","barcode","pdf"]},"URNFC":{"type":"object","description":"Datos extraídos mediante el componente NFC.","required":["field","value"],"properties":{"field":{"type":"string","description":"Nombre del campo NFC."},"value":{"type":"string","description":"Valor extraído mediante NFC."},"alphabet":{"type":"string","description":"Alfabeto utilizado en el campo."}}},"URChecks":{"type":"object","description":"Comprobaciones de validación realizadas sobre los datos OCR.","properties":{"field_inconsistency":{"type":"array","description":"Lista de inconsistencias de campo encontradas.","items":{"$ref":"#/components/schemas/FieldInconsistency"}}}},"FieldInconsistency":{"type":"object","description":"Inconsistencia detectada entre los valores de un campo.","required":["field","distance"],"properties":{"field":{"type":"string","description":"Nombre del campo con inconsistencia."},"values":{"type":"array","description":"Diferentes valores encontrados para el mismo campo.","items":{"type":"string"}},"distance":{"type":"integer","description":"Métrica de distancia de la inconsistencia."}}}}}} ``` ## The UROCRField object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"UROCRField":{"type":"object","description":"Campo OCR con información de valor, confianza y origen.","required":["value"],"properties":{"value":{"type":"string","description":"El valor extraído."},"confidence":{"type":"number","description":"Puntuación de confianza de la extracción.","minimum":0,"maximum":1},"source":{"$ref":"#/components/schemas/UROCRSource"}}},"UROCRSource":{"type":"object","description":"Información de origen de un campo OCR.","required":["type","index"],"properties":{"type":{"$ref":"#/components/schemas/URSourceType"},"index":{"type":"integer","description":"Índice del elemento de origen."}}},"URSourceType":{"type":"string","description":"Tipo de origen de los datos extraídos.","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":"Información de origen de un campo OCR.","required":["type","index"],"properties":{"type":{"$ref":"#/components/schemas/URSourceType"},"index":{"type":"integer","description":"Índice del elemento de origen."}}},"URSourceType":{"type":"string","description":"Tipo de origen de los datos extraídos.","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":"Tipo de origen de los datos extraídos.","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":"Imagen extraída del documento.","required":["type","source"],"properties":{"type":{"$ref":"#/components/schemas/URImageType"},"side":{"type":"integer","description":"Lado del documento (0=Anverso, 1=Reverso)."},"source":{"$ref":"#/components/schemas/URSourceType"},"content":{"$ref":"#/components/schemas/URImageContent"},"region":{"$ref":"#/components/schemas/URRegion"}}},"URImageType":{"type":"string","description":"Tipo de imagen extraída.","enum":["portrait","ghost","signature","fullFrame","document","fingerprint"]},"URSourceType":{"type":"string","description":"Tipo de origen de los datos extraídos.","enum":["viz","encoded","nfc","mrz"]},"URImageContent":{"type":"object","description":"Contenido de una imagen en formato base64.","required":["data","length"],"properties":{"data":{"type":"string","description":"Datos de la imagen codificados en base64 RFC4648."},"length":{"type":"integer","description":"Longitud de los datos de la imagen."},"mime_type":{"type":"string","description":"Tipo MIME de la imagen."}}},"URRegion":{"type":"object","description":"Coordenadas de la región que definen la ubicación de los datos extraídos en la imagen.","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":"Coordenadas X,Y en la imagen.","required":["x","y"],"properties":{"x":{"type":"number","description":"Coordenada X."},"y":{"type":"number","description":"Coordenada Y."}}}}}} ``` ## The URImageType object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URImageType":{"type":"string","description":"Tipo de imagen extraída.","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":"Contenido de una imagen en formato base64.","required":["data","length"],"properties":{"data":{"type":"string","description":"Datos de la imagen codificados en base64 RFC4648."},"length":{"type":"integer","description":"Longitud de los datos de la imagen."},"mime_type":{"type":"string","description":"Tipo MIME de la imagen."}}}}}} ``` ## The URViz object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URViz":{"type":"object","description":"Datos extraídos mediante la fuente ML/VIZ.","required":["field","value","side"],"properties":{"field":{"type":"string","description":"Nombre del campo."},"value":{"type":"string","description":"Valor extraído."},"side":{"type":"integer","description":"Lado del documento (0=Anverso, 1=Reverso)."},"confidence":{"type":"number","description":"Puntuación de confianza.","minimum":0,"maximum":1},"alphabet":{"type":"string","description":"Alfabeto utilizado en el campo."},"region":{"$ref":"#/components/schemas/URRegion"}}},"URRegion":{"type":"object","description":"Coordenadas de la región que definen la ubicación de los datos extraídos en la imagen.","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":"Coordenadas X,Y en la imagen.","required":["x","y"],"properties":{"x":{"type":"number","description":"Coordenada X."},"y":{"type":"number","description":"Coordenada Y."}}}}}} ``` ## The URMRZ object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URMRZ":{"type":"object","description":"Datos de la MRZ (Machine Readable Zone).","required":["side","raw","fields"],"properties":{"side":{"type":"integer","description":"Lado del documento (0=Anverso, 1=Reverso)."},"confidence":{"type":"number","description":"Puntuación de confianza.","minimum":0,"maximum":1},"raw":{"type":"string","description":"Texto MRZ en bruto (equivalente al campo MrzText)."},"fields":{"type":"object","description":"Diccionario de campos MRZ analizados.","additionalProperties":{"type":"string"}},"region":{"$ref":"#/components/schemas/URRegion"}}},"URRegion":{"type":"object","description":"Coordenadas de la región que definen la ubicación de los datos extraídos en la imagen.","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":"Coordenadas X,Y en la imagen.","required":["x","y"],"properties":{"x":{"type":"number","description":"Coordenada X."},"y":{"type":"number","description":"Coordenada Y."}}}}}} ``` ## The UREncoded object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"UREncoded":{"type":"object","description":"Datos extraídos de formatos codificados (QR, código de barras, PDF417).","required":["fields","type","side","raw","rawBinary"],"properties":{"fields":{"type":"object","description":"Diccionario de campos analizados a partir de los datos codificados.","additionalProperties":{"type":"string"}},"type":{"$ref":"#/components/schemas/UREncodedType"},"side":{"type":"integer","description":"Lado del documento (0=Anverso, 1=Reverso)."},"raw":{"type":"string","description":"Cadena decodificada en bruto (QrData, BarcodeData o PdfData)."},"rawBinary":{"type":"string","description":"Datos binarios originales extraídos de la imagen codificada, en base64."},"region":{"$ref":"#/components/schemas/URRegion"}}},"UREncodedType":{"type":"string","description":"Tipo de dato codificado.","enum":["qr","barcode","pdf"]},"URRegion":{"type":"object","description":"Coordenadas de la región que definen la ubicación de los datos extraídos en la imagen.","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":"Coordenadas X,Y en la imagen.","required":["x","y"],"properties":{"x":{"type":"number","description":"Coordenada X."},"y":{"type":"number","description":"Coordenada Y."}}}}}} ``` ## The UREncodedType object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"UREncodedType":{"type":"string","description":"Tipo de dato codificado.","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":"Datos extraídos mediante el componente NFC.","required":["field","value"],"properties":{"field":{"type":"string","description":"Nombre del campo NFC."},"value":{"type":"string","description":"Valor extraído mediante NFC."},"alphabet":{"type":"string","description":"Alfabeto utilizado en el campo."}}}}}} ``` ## The URChecks object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URChecks":{"type":"object","description":"Comprobaciones de validación realizadas sobre los datos OCR.","properties":{"field_inconsistency":{"type":"array","description":"Lista de inconsistencias de campo encontradas.","items":{"$ref":"#/components/schemas/FieldInconsistency"}}}},"FieldInconsistency":{"type":"object","description":"Inconsistencia detectada entre los valores de un campo.","required":["field","distance"],"properties":{"field":{"type":"string","description":"Nombre del campo con inconsistencia."},"values":{"type":"array","description":"Diferentes valores encontrados para el mismo campo.","items":{"type":"string"}},"distance":{"type":"integer","description":"Métrica de distancia de la inconsistencia."}}}}}} ``` ## The FieldInconsistency object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"FieldInconsistency":{"type":"object","description":"Inconsistencia detectada entre los valores de un campo.","required":["field","distance"],"properties":{"field":{"type":"string","description":"Nombre del campo con inconsistencia."},"values":{"type":"array","description":"Diferentes valores encontrados para el mismo campo.","items":{"type":"string"}},"distance":{"type":"integer","description":"Métrica de distancia de la inconsistencia."}}}}}} ``` ## The URRegion object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URRegion":{"type":"object","description":"Coordenadas de la región que definen la ubicación de los datos extraídos en la imagen.","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":"Coordenadas X,Y en la imagen.","required":["x","y"],"properties":{"x":{"type":"number","description":"Coordenada X."},"y":{"type":"number","description":"Coordenada Y."}}}}}} ``` ## The URCoordinates object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"URCoordinates":{"type":"object","description":"Coordenadas X,Y en la imagen.","required":["x","y"],"properties":{"x":{"type":"number","description":"Coordenada X."},"y":{"type":"number","description":"Coordenada Y."}}}}}} ``` ## The ProcessBody object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ProcessBody":{"type":"object","description":"Cuerpo para el procesamiento OCR","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":"Es necesario especificar el tipo de documento que se desea procesar, ya que nuestro servicio puede gestionar diferentes tipos de documentos.","enum":["id_card","passport","driver_license","foreign_card","invoice","pdf"]},"model":{"type":"string","description":"Este parámetro especifica el ID del documento que se va a procesar."},"files":{"type":"array","description":"Array de imágenes en formato de buffer en bruto codificadas en base64 RFC4648.","items":{"type":"string"}},"isCropped":{"type":"boolean","default":false,"deprecated":true,"description":"Si la `image` ya está recortada y alineada, el servicio puede evitar realizar estas operaciones. Solo aplica a documentos `invoice`."},"forceDetection":{"type":"boolean","default":false,"deprecated":true,"description":"Si el documento `invoice` no tiene la relación de aspecto correcta, el servicio puede realizar una operación para corregirla y mejorar la detección del documento. Solo aplica a documentos `invoice`."},"retrieveImages":{"type":"boolean","default":false,"description":"El servicio devolverá la imagen recortada en base64 en el resultado final."}}}} ``` ## The RawBody object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"RawBody":{"type":"object","description":"Cuerpo para el procesamiento OCR en modo raw","properties":{"type":{"$ref":"#/components/schemas/type"},"image":{"$ref":"#/components/schemas/image"}}},"type":{"type":"string","description":"Es necesario especificar el tipo de documento que se desea procesar, ya que nuestro servicio puede gestionar diferentes tipos de documentos.","enum":["id_card","passport","driver_license","foreign_card","invoice","pdf"]},"image":{"type":"string","description":"Este parámetro especifica la imagen a procesar codificada en 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":"Coordenadas x, y en sentido horario.","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":"Coordenadas x, y en sentido horario.","items":{"$ref":"#/components/schemas/RawResultVertice"}},"RawResultVertice":{"type":"object","description":"Coordenadas x, y en sentido horario.","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":"Resultado del procesamiento de una imagen.","properties":{"description":{"type":"string","description":"Palabra encontrada."},"vertices":{"type":"array","description":"Cuatro coordenadas x, y en sentido horario.","items":{"$ref":"#/components/schemas/RawResultVertices"}},"confidence":{"type":"number","description":"Confianza de la palabra."}}},"RawResultVertices":{"type":"array","description":"Coordenadas x, y en sentido horario.","items":{"$ref":"#/components/schemas/RawResultVertice"}},"RawResultVertice":{"type":"object","description":"Coordenadas x, y en sentido horario.","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":"Un valor de fecha/hora en formato \"%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":"Resultado cuando llegan parámetros incorrectos en la petición.","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":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ExceptionResult":{"type":"object","description":"Se ha producido un error en la llamada al backend de OCR-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":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"HealthStatus":{"type":"string","description":"Resultado del estado de salud del servicio (si el SDK está activo o no).","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":"El resultado de una comprobación de salud (health check).","properties":{"message":{"$ref":"#/components/schemas/HealthStatus"}}},"HealthStatus":{"type":"string","description":"Resultado del estado de salud del servicio (si el SDK está activo o no).","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":"El resultado de una comprobación de versión.","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":"Objeto JSON con los parámetros de configuración del servicio. Los ajustes de autenticación JWT se omiten intencionadamente."}}}} ``` ## The ConfigBody object ```json {"openapi":"3.0.0","info":{"title":"OCR Service Rest API","version":"2.18.2"},"components":{"schemas":{"ConfigBody":{"type":"object","description":"Cuerpo para la petición de configuración. Este endpoint no acepta ajustes de autenticación JWT.","properties":{"config_json_string":{"type":"string","description":"Cadena JSON con los parámetros de configuración del servicio que se pueden actualizar en tiempo de ejecución."}},"required":["config_json_string"]}}}} ```