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)
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 o residence_mx), estos campos no estarán presentes.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)
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.
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