Uso de la API de OCR

Nuestra API de OCR permite el procesamiento directo de documentos para soluciones personalizadas.

---

Implementación Básica

Esta guía explica cómo configurar y utilizar el endpoint /api/process.

---

1. Detalles del Endpoint

URL

POST /api/process

Headers

Requeridos:

• Authorization: Su clave de acceso personal (proporcionada por nuestro equipo).

Body

Requerido:

{
  "documents": [
    "data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  ]
}

---

2. Ejemplo de Solicitud

curl -X POST https://api.onboarding.com/api/process \
-H "Authorization: YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
  "documents": [
    "data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  ]
}'

---

3. Ejemplo de Respuesta

Respuesta Exitosa (200)

{
  "id": "5ad67ada-cbd3-45a8-a1aa-7acc35476365",
  "startTimestamp": 1650451011751,
  "endTimestamp": 1650453826335,
  "value": {
    "types": [
      {
        "name": "IDCARD",
        "probability": 0.89302659034729,
        "year": "2015",
        "country": "ESP",
        "id": "ESP_IDCARD_2015"
      }
    ],
    "fields": [
      {
        "name": "DATE_OF_EXPIRY",
        "value": "2028-11-14"
      }
    ],
    "images": [
      {
        "name": "PORTRAIT",
        "value": "/9j/4AAQSkZJRgABAQEAxwDHAAD/"
      }
    ],
    "authenticity": [
      {
        "name": "PATTERN_CHECKS",
        "value": true
      }
    ],
    "validations": [
      {
        "name": "OVERALL",
        "value": true
      }
    ]
  }
}

Campos de Respuesta

La respuesta incluye resultados detallados del proceso de OCR. Para una descripción completa de todas las claves y sus posibles valores, consulte la Guía de la API. Esta guía proporciona una explicación exhaustiva de cada campo devuelto por la API.

Respuesta de Error

Códigos de Error Comunes

• 400: Solicitud Incorrecta: La solicitud es inválida.
• 403: Prohibido: Clave de autorización inválida o faltante.

---

4. Notas

• Asegúrese de que las imágenes estén codificadas correctamente en Base64 antes de enviarlas.
• La API admite múltiples documentos en una sola solicitud.
• Contacte al soporte para obtener documentación adicional.

---