/api/v1/process

Procesa el alfabeto latino mediante OCR

post

Authorizations

BearerAuthApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Cuerpo para el procesamiento OCR

typestring · enumOptional

Es necesario especificar el tipo de documento que se desea procesar, ya que nuestro servicio puede gestionar diferentes tipos de documentos.

Example: id_cardPossible values:

modelstringOptional

Este parámetro especifica el ID del documento que se va a procesar.

Example: ARG

filesstring[]Optional

Array de imágenes en formato de buffer en bruto codificadas en base64 RFC4648.

Example: ["iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC.b64"]

isCroppedbooleanOptionalDeprecated

Si la image ya está recortada y alineada, el servicio puede evitar realizar estas operaciones. Solo aplica a documentos invoice.

Default: false

forceDetectionbooleanOptionalDeprecated

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.

Default: false

retrieveImagesbooleanOptional

El servicio devolverá la imagen recortada en base64 en el resultado final.

Default: false

Responses

200

El resultado del procesamiento OCR

application/json

Resultado del procesamiento de una imagen.

typestring · enumOptional

Es necesario especificar el tipo de documento que se desea procesar, ya que nuestro servicio puede gestionar diferentes tipos de documentos.

Example: id_cardPossible values:

modelstringOptional

Este parámetro especifica el ID del documento que se va a procesar.

Example: ARG

versionstringOptional

Versión del documento detectado.

Example: 2020

sidestringOptional

Lado del documento detectado.

Example: front

croppedImagestringOptional

Imagen recortada codificada en base64 RFC4648.

Example: /9j/4AAQSkZJRgABAQEAtAC0AAD...

400

Llegan parámetros incorrectos en la petición.

application/json

500

Se ha producido un error en la llamada al backend de OCR-SDK.

application/json

post/api/v1/process

HTTPcURLJavaScriptPython

POST /api/v1/process HTTP/1.1
Host: 127.0.0.1:6982/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "type": "id_card",
  "model": "ARG",
  "files": [
    "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAFUlEQVR42mP8z8BQz0AEYBxVSF+FABJADveWkH6oAAAAAElFTkSuQmCC.b64"
  ],
  "retrieveImages": false
}

{
  "dictionary": {
    "DateOfBirth": "1900-01-01",
    "DateOfExpiry": "1900-01-01",
    "DateOfIssue": "1901-01-01",
    "DocumentCaptured": "ARG/v1",
    "DocumentNumber": "12345678A",
    "FirstName": "Alicia",
    "Nationality": "ESP"
  },
  "type": "id_card",
  "model": "ARG",
  "version": "2020",
  "side": "front",
  "croppedImage": "/9j/4AAQSkZJRgABAQEAtAC0AAD..."
}