Esta guía explica cómo usar el endpointDocumentation Index
Fetch the complete documentation index at: https://gotrebol.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
POST /verifications para crear verificaciones vía API. Para entender las 3 formas de procesar documentos (clasificación, validación, extracción), consulta Cómo funciona Vía API.
Para el schema técnico completo del endpoint con tipos, validaciones y ejemplos generados del OpenAPI spec, consulta API Reference — Crear una nueva verificación.
Requisitos comunes
Cuando envías documentos confile_url (aplica a todas las formas de procesamiento):
¿No tienes un
file_url? Si tus documentos están en almacenamiento privado o se generan dinámicamente, usa el flujo de carga directa, donde Trébol te proporciona una upload_url para subir el archivo directamente.Variantes del endpoint
POST /verifications acepta dos esquemas en el body, dependiendo de si usas un account-flow predefinido o envías los items directamente:
| Variante | Cuándo usar | Campos requeridos |
|---|---|---|
Con items (API sin flow) | Cada verificación define sus propios items. Máxima flexibilidad. Es la forma más común en integración API. | country, tag, items |
Con flow_id (con account-flow) | Reutilizas una configuración de flow previamente creada. Más común en widget; poco frecuente en API directa. | country, tag, flow_id, tax_id |
Atributos principales
| Atributo | Tipo | Requerido | Descripción |
|---|---|---|---|
country | string | Sí | Código del país. Valores soportados: mx, co. Otros valores se procesan como not_specified. |
tag | string | Sí | Identificador único de la verificación (tu ID interno del cliente o solicitud). |
tax_id | string | Depende | RFC / NIT de la empresa. Requerido cuando usas flow_id. |
friendly_name | string | No | Nombre descriptivo de la empresa o persona asociada a la verificación. |
email | string | No | Email del cliente de la verificación. |
flow_id | string | Depende | ID de un account-flow predefinido. Usar sin items. |
items | array | Depende | Items a procesar. Usar sin flow_id. Ver las 3 formas en Cómo funciona Vía API. |
options | object | No | Flags específicos del caso de uso (ej: skip_siger). |
metadata | object | No | Información adicional para tu integración (no procesada por Trébol). |
key_people | array | No | Solo KYB México. Apoderados con poderes legales. Ver Overview KYB México. |
Siguiente paso: elige tu forma de procesamiento
Cada forma tiene ejemplos de payload completos y estructura de respuesta:Forma 1: Clasificación
Trébol detecta el tipo del documento (item
generic).Forma 2: Validación
Verifica tipo y reglas (item
doc_validation).Forma 3: Extracción
Extrae directamente con tipo directo.
Ejemplos de payload por caso de uso
Cada caso de uso tiene su overview con variaciones de creación y ejemplos de payload completos copy-pasteables:KYB México
Verificación de empresas mexicanas: SIGER, SAT, actas, apoderados.
KYB Colombia
Verificación de empresas colombianas: RUES, RUT, Cámara de Comercio.
KYB Estados Unidos
Verificación de empresas en EEUU: certificate of incorporation, IRS EIN, FinCEN.
KYB Todos los países
Items universales para KYB: person_id, proof_address, bank_statement, etc.
Hipotecas
Escrituras de propiedad, certificados de gravámenes, avalúos.
Nómina
Recibos de nómina y pensión.