Skip to main content

Documentation Index

Fetch the complete documentation index at: https://gotrebol.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

En esta forma, envías el documento con un tipo directo (el código del item específico según el caso de uso, ej: ac_mx para actas constitutivas mexicanas, csf_mx para constancias de situación fiscal, rut_co para RUT colombiano, etc.) y Trébol extrae directamente la información estructurada. Cuándo usar:
  • Ya sabes el tipo del documento con certeza
  • Confías en que el archivo es correcto (o ya lo validaste por tu lado / con Forma 2)
  • Solo necesitas los datos extraídos, no una validación previa

​
Cómo funciona

  1. Envías el item con type igual al código del item específico (ej: csf_mx), y el file_url
  2. Trébol extrae directamente la información según la estructura de ese tipo
  3. El resultado incluye todos los campos extraídos según el esquema del tipo
Trébol no verifica que el documento realmente sea del tipo que declaraste. Si envías un archivo que no corresponde, la extracción fallará o devolverá campos vacíos. Si necesitas verificar el tipo antes, usa Forma 2: Validación.

​
Payload

{
  "country": "mx",
  "tag": "uuid-cliente-1234",
  "items": [
    {
      "type": "csf_mx",
      "options": {
        "file_url": "https://www.ejemplo.com/constancia-situacion-fiscal.pdf"
      }
    }
  ]
}
Los valores válidos de type dependen del caso de uso. Consulta las guías específicas:

​
Resultado

Trébol devuelve el item completo con la información extraída según la estructura del tipo. Por ejemplo, para csf_mx: 
{
  "id": 12345,
  "item_type": "csf_mx",
  "item_status": "complete",
  "item_value": {
    "document_date": "2024-01-01",
    "tax_id_number": "ABC123456789",
    "company_legal_name": "EMPRESA EJEMPLO SA DE CV",
    "business_activities": [ /* ... */ ],
    /* ... resto de campos según la estructura de csf_mx ... */
  }
}
Consulta la estructura de respuesta específica de cada tipo en la guía del caso de uso correspondiente.

​
Combinar con validación

Si quieres primero validar y después extraer solo si la validación fue exitosa, construye la lógica combinando Forma 2 y Forma 3:
  1. Crea un item doc_validation (Forma 2) para validar
  2. Espera el resultado de la validación vía webhook o consulta
  3. Si la validación pasó, agrega un item con tipo directo usando PUT /verifications/{id}/add-items
// Paso 3: agregar item de extracción después de validar
{
  "items": [
    {
      "type": "csf_mx",
      "options": {
        "file_url": "https://www.ejemplo.com/csf.pdf"
      }
    }
  ]
}
Trébol no ejecuta esta lógica condicional automáticamente. Si la validación falla, tú decides qué hacer (rechazar el documento, pedir uno nuevo, etc.). La extracción solo la disparas si decides que la validación fue exitosa.

​
Siguientes pasos