Respuestas por tipo de ítem
Este documento describe la estructura de respuesta del API para cadaitem_type. Úsalo para validar contratos y mapear las respuestas.
- Ver listado de tipos: Tipos de Ítems
- Cómo leer las respuestas: Leer información vía API
- Estados y flujos: Estados de verificación
Estructura base de un ítem en las respuestas
A nivel superior, todos los ítems comparten la misma estructura.Nota:item_typees el código del ítem (por ejemplo,ac_mx,csf_mx,siger,ubos). El campoitem_valueusasnake_casey su estructura depende delitem_type.
item_error: Campo opcional que indica errores públicos relacionados con el procesamiento del ítem. Valores permitidos:
password_protected_pdf: El PDF subido está protegido con contraseña y no puede ser procesado.get_input_file_info_failed: Falló la obtención de información del archivo de entrada.
Índice rápido
- Documentos México:
ac_mx,aa_mx,fme_mx,pw_mx,csf_mx,person_id,proof_address,bank_statement,curp_item - Consultas México:
siger,public_sat_signatures - Documentos Colombia:
sc_co,rut_co - Consultas Colombia:
rues,public_rut_co,public_address_cc_co,cc_co_ops - Widgets:
ubos,forms - Integraciones:
aml_validation,signatory_validation - Otros:
document,doc_classification,public_sat_signatures,unknown,generic,error
México
ac_mx — Acta constitutiva
Información detallada sobre roles y firmantes:Para obtener información más detallada sobre la estructura de roles, poderes y firmantes, consulta la guía completa: Extraer Apoderados de Actas y Poderes
aa_mx — Asamblea
Misma estructura pública que ac_mx.
fme_mx — Folio mercantil electrónico
Misma estructura pública que ac_mx.
pw_mx — Poder notarial
Misma estructura pública que ac_mx.
csf_mx — Constancia de situación fiscal
person_id — Identificación oficial (persona)
- ine_mx: Identificación oficial mexicana (INE).
- passport: Pasaporte (documento oficial de viaje).
- residence_mx: Tarjeta/documento de residencia en México (para no mexicanos).
- cc: Cédula de ciudadanía colombiana.
due_date, place_of_issue, sex, numero_id_nacional y curp pueden ser null porque son campos opcionales y su presencia depende del tipo de person_id y de si el documento los incluye explícitamente (por ejemplo, curp solo aplica para documentos mexicanos; place_of_issue aplica para la cédula de ciudadanía colombiana).
Validación del INE
Para un item de tipoperson_id, si su tipo es ine_mx, se realiza una validación del INE. Los datos de esta validación se encuentran dentro de item_value bajo la clave ine_validation_data. El estado de este proceso se puede identificar mediante dos claves: ine_validation_result y ine_validation_message.
Estructura de ine_validation_data:
El objeto ine_validation_data.data contiene la siguiente información extraída del INE:
cic(string): Clave de Identificación Ciudadana (CIC).numero_ocr(string): Número OCR del documento.ano_de_emision(string): Año de emisión del documento.distrito_local(string): Distrito local electoral.ano_de_registro(string): Año de registro del documento.expiration_date(string): Fecha de expiración del documento.clave_de_elector(string): Clave de elector.distrito_federal(string): Distrito federal electoral.numero_de_emision(string): Número de emisión del documento.fecha_de_actualizacion_de_la_informacion(string): Fecha de actualización de la información.
ine_validation_result:
valid_id: Indica que la validación del INE fue exitosa.invalid_id: Indica que el INE es inválido.failed: Indica que la validación falló, lo cual puede ser temporal o debido a datos incorrectos.error: Indica que ocurrió una excepción durante el proceso de validación.missing_parameters: Indica que faltan parámetros específicos requeridos para la validación.maximum_retries_reached: Indica que se alcanzó el número máximo de reintentos para la validación.missing_validation_parameters: Indica que el item no puede ser validado debido a la configuración (por ejemplo, no es un INE).
ine_validation_message:
ID succesfully validated: Indica que la identificación fue validada exitosamente.A problem occured trying to validate the INE information: Indica que ocurrió un problema durante el intento de validar la información del INE.
La validación del INE solo se realiza cuando el
id_type del item person_id es ine_mx. Para otros tipos de identificación (como passport, residence_mx o cc), estos campos vendrán en null.Ejemplo de salida para cédula de ciudadanía colombiana
Ejemplo de salida para pasaporte
proof_address — Comprobante de domicilio
bank_statement — Estado de cuenta bancario
curp_item — Consulta/validación CURP
Información detallada sobre el tipo
curp_item:curp_validation_data - Datos extraídos de la consulta CURP:curp_status: Estado del CURP en el registro:alta_normal: Persona activa en el registrobaja_por_defuncion: Persona fallecidaotro: Otros estadosno_encontrado: CURP no encontrado
curp_validation_result - Resultado de la validación:curp_found: CURP encontrado y válidocurp_not_found: CURP no encontrado
curp_validation_status - Estado de la validación:valid: Validación exitosainvalid: Validación fallida
siger — SIGER (México)
Análisis automático de minutas (FME)
El campofme_assembly_minute_extractor contiene el análisis automático mediante IA de los eventos relevantes identificados en cada acto. Este análisis intenta procesar todos los actos independientemente de la configuración de flags, pero tiene un límite de tiempo de 13 minutos por razones de seguridad y confiabilidad. Los actos se procesan en orden cronológico inverso (más recientes primero), asegurando que los documentos más relevantes se analicen primero.
Estructura del campo:
Cada acto incluye un array de grupos de eventos con la siguiente información:
event_group_name: Nombre del grupo de eventos (company_events, shareholders_events, administration_events, supervision_events, signatories_holders_events)explanation: Descripción generada por IA sobre los eventos encontrados en el actoevents: Array de eventos identificados en el acto
- company_events: Eventos relacionados con la empresa (nombre, tipo societario, duración, domicilio, objeto social)
- shareholders_events: Eventos de accionistas (adiciones, transferencias, modificaciones de capital)
- administration_events: Eventos de administración (cambios en órganos de administración)
- supervision_events: Eventos de vigilancia (cambios en órganos de vigilancia)
- signatories_holders_events: Eventos de firmantes (adiciones, remociones, modificaciones de poderes)
El análisis FME se almacena en el ítem SIGER para los actos procesados y está disponible para consulta incluso si no se crearon items de tipo acta automáticamente.
Creación automática de items de tipo acta
Cuando el flagsiger_data_extraction está activado, el sistema analiza los eventos extraídos y crea automáticamente items de tipo acta para aquellos actos que contienen eventos relevantes. Estos items aparecerán como items adicionales en la verificación con:
item_type: Puede serac_mx(acta constitutiva),aa_mx(acta de asamblea), ofme_mx(folio mercantil)file_source_info: Contiene información sobre el acto de SIGER del que proviene el itemitem_type: “siger”item_id: ID del item SIGER fuente
Error en la consulta SIGER
Cuando el ítemsiger tiene "item_internal_status": "siger_error", es porque se presentó algún error relacionado al mal funcionamiento de la página o comportamientos inesperados.
siger_shareholders — Empresas relacionadas por accionistas (México)
Este ítem permite buscar en SIGER empresas relacionadas a una lista de accionistas (personas físicas). Por cada accionista, retorna una lista de coincidencias.
Puedes obtener este ítem de dos formas:
- Creación manual (sin item
siger): si ya tienes una lista de accionistas, puedes crear el ítemsiger_shareholdersdirectamente en elPOST /verificationsconoptions.shareholders. - Creación automática (desde item
siger): si estás consultando una empresa en SIGER y quieres buscar los mismos accionistas detectados para esa empresa, no crees este ítem manualmente. En su lugar, envía el flagsearch_related_companies_siger: trueen el ítemsigery el sistema crearásiger_shareholdersautomáticamente.
Límite: Solo 1 accionista por ítem
siger_shareholders.-
shareholders: Lista de accionistas de la empresa consultadaname: Nombre del accionistapaternal_surname: Apellido paternomaternal_surname: Apellido materno
-
data: Detalle de empresas relacionadas por cada accionistashareholder: Información del accionistarelated_companies: Array de empresas donde participa el accionistaname: Nombre de la empresa relacionadafme: Folio mercantil electrónico de la empresa
scraped_at: Fecha y hora en que se realizó la consulta
Este ítem es útil para análisis de beneficiarios finales (UBOs) y para identificar estructuras corporativas relacionadas en procesos de due diligence.
public_sat_signatures — SAT firmas/certificados (México)
Colombia
sc_co — Composición accionaria
rut_co — Registro Único Tributario
rues — Consulta RUES
public_rut_co — RUT fuente pública
public_address_cc_co — Dirección pública Cámara de Comercio
cc_co_ops — Certificado CC (ops)
Widgets
ubos — Beneficiarios finales
forms — Formularios de onboarding
Integraciones
aml_validation
signatory_validation
Otros
document — Extractor de documentos (genérico)
Este ítem agrupa distintos extractores de documentos bajo un mismo item_type. La forma de la respuesta es:
- “type”: uno de los tipos soportados.
- “payload”: objeto JSON con los datos extraídos. La estructura varía por tipo y corresponde a los esquemas JSON del AI Prompter.
type):
property_deedlien_certificateproperty_tax_receiptpayroll_receiptcamara_comercio_co_extractortrust_contract_fideicomiso_extractorunion_documents_extractordesignacion_responsable_cumplimiento_extractorregistro_actividades_vulnerables_extractorirs_ein_assignment_letter_extractorcertificate_of_incumbency_extractorcertificate_of_incorporation_extractorfincen_msb_registration_extractor
- La estructura exacta de
payloaddepende deltypey se define en los esquemas del AI Prompter (archivoai-prompter/src/utils/json_schemas.py). - La respuesta pública expone
payloadya “normalizado” como JSON plano según el esquema correspondiente.
Estructuras por type
A continuación se documenta el payload esperado por cada type. Los ejemplos son esqueletos de referencia y pueden contener campos opcionales.
property_deed
lien_certificate
property_tax_receipt
camara_comercio_co_extractor
trust_contract_fideicomiso_extractor
union_documents_extractor
designacion_responsable_cumplimiento_extractor
registro_actividades_vulnerables_extractor
irs_ein_assignment_letter_extractor
certificate_of_incumbency_extractor
certificate_of_incorporation_extractor
fincen_msb_registration_extractor
payroll_receipt