> ## 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. # Listar flujos de cuenta > Obtiene una lista de todos los flujos de cuenta ## OpenAPI ````yaml /api-reference/openapi.yaml get /account-flows openapi: 3.0.0 info: title: Coleccion de API KYB MX description: > La Colección de API KYB MX proporciona puntos finales para crear y gestionar verificaciones de empresas en México. La verificación de empresas implica validar la información proporcionada por un cliente comercial, incluyendo documentos y fuentes de datos, para asegurar su legitimidad y precisión. Cada verificación de empresa puede incluir múltiples ítems, como Actas Constitutivas, Constancias de Situación Fiscal, Identificaciones Personales y Comprobantes de Domicilio. Trebol maneja automáticamente la clasificación de documentos, lo que te permite enviar todos los documentos requeridos como URLs descargables (por ejemplo, URLs prefirmadas de AWS o GCP). **Autenticación**: La API utiliza una clave API para la autenticación, pasada en el encabezado `x-api-key`. Para obtener una clave API, por favor [contáctanos](mailto:sales@gotrebol.com). version: 1.0.0 servers: - url: https://api.gotrebol.com - url: http://{{trebol_api_base_url}} security: [] tags: - name: Creacion de Verificacion description: Endpoints para crear nuevas verificaciones. - name: Leer información de la empresa description: >- Endpoints v2 para obtener información detallada de empresas y verificaciones. - name: Leer por Etiqueta description: >- Endpoints para obtener información detallada sobre empresas mediante etiquetas. - name: Leer por ID de Verificacion description: >- Endpoints para obtener información detallada sobre verificaciones mediante ID. - name: Gestión de IPs Permitidas description: >- Endpoints para gestionar la lista de IPs permitidas (whitelist) para la cuenta del cliente. - name: Gestión de API Keys description: Endpoints para crear, listar y eliminar API keys de la cuenta del usuario. - name: Gestion de item Ids description: Endpoints para gestionar items de verificaciones. - name: Invalidar un documento description: Endpoints para invalidar documentos de verificaciones. - name: Labels de Verificacion description: Endpoints para gestionar labels de verificaciones. - name: Actualizar personas clave de una verificacion description: Endpoints para actualizar personas clave de verificaciones. - name: Agregar items a una verificacion description: Endpoints para agregar items a verificaciones existentes. - name: Estado de validacion de documentos description: Endpoints para obtener el estado de validación de documentos. - name: Gestión de Flujos de Cuenta description: Endpoints para gestionar flujos de cuenta. - name: Gestión de Webhooks description: Endpoints para crear, listar, actualizar y eliminar webhooks de la cuenta. - name: Gestión de Política de Retención description: Endpoints para gestionar la política de retención de datos de la cuenta. - name: Exportación de Verificaciones description: >- Endpoints para exportar datos de verificaciones a documentos personalizados. - name: Leer información de la empresa v1 description: >- Endpoints v1 (legacy) para obtener información detallada de empresas y verificaciones. Te recomendamos migrar a los endpoints v2. - name: Tipos de Ítem Personalizados description: >- Endpoints para crear y gestionar tipos de ítem personalizados con procesos configurables de clasificación, validación y extracción. paths: /account-flows: get: tags: - Gestión de Flujos de Cuenta summary: Listar flujos de cuenta description: Obtiene una lista de todos los flujos de cuenta responses: '200': description: Lista de flujos recuperada exitosamente content: application/json: schema: type: array items: allOf: - $ref: '#/components/schemas/AccountFlow' '401': $ref: '#/components/responses/UnauthorizedError' '404': $ref: '#/components/responses/NotFoundError' '500': $ref: '#/components/responses/InternalServerError' security: - ApiKeyAuth: [] components: schemas: AccountFlow: type: object properties: id: type: string account_id: type: string friendly_name: type: string id_slug: type: string description: >- Identificador único del flujo. Solo puede contener letras, números, guiones(-) y guiones bajos(_). example: id-test-flow flow_items: $ref: '#/components/schemas/VerificationTemplate' record_validation_schema: $ref: '#/components/schemas/RecordValidationSchema' VerificationTemplate: type: object properties: id: type: string description: ID con el que se identifica el template de verificación. items: type: array description: Lista de items que conforman el template de verificación items: type: object required: - type properties: type: type: string description: Tipo de item de verificación example: generic options: type: object properties: is_optional: type: boolean description: >- Indica si el item es opcional, si es true, el item no sera requerido para que finalice la verificacion. ubos_threshold: type: integer description: >- Indica el porcentaje mínimo que debe tener un accionista para tener que ser declarado en la sección de UBOs. **Aplicara solo para items de tipo `ubos` y es opcional**. example: 25 ubos_form_schema: type: string enum: - mx_form - co_form description: >- Especifica el esquema de formulario que se debe usar para la sección de UBOs. Para más información sobre los esquemas de formulario, consulta la sección [Personalizar Widget](/guia-devs/personalizar-widget#1-configurando-la-experiencia-flow_items). **Aplicara solo para items de tipo `ubos` y es opcional**. example: mx_form ubos_schema_id: type: string description: >- ID de un esquema de formulario personalizado creado con el endpoint de esquemas de formularios. Cuando se especifica, el widget usa este esquema en lugar de los predeterminados (`mx_form` / `co_form`). El esquema debe existir en la cuenta. Debe ser diferente a `mx_form` o `co_form`(Estos se especifican con `ubos_form_schema`). **Aplicará solo para items de tipo `ubos` y es opcional**. example: ubos-custom-001 schema_id: type: string description: > ID del esquema de formulario. **Requerido para items de tipo `forms`**. Debe corresponder a un esquema de formulario existente en la cuenta. example: some-test-form-schema additionalProperties: true options: type: object description: Opciones adicionales para la verificacion. properties: creator_email: type: string format: email description: Email del creador de la verificacion, el usuario empresarial. next_steps_checkout: type: array description: >- Lista de pasos a seguir para tu prospecto al finalizar el flujo de onboarding. Se puede enviar un array vacío para no mostrar ningún paso. example: - title: Documentos adicionales description: >- Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo. - title: Firma del contrato description: >- Cuando se complete toda la información, un representante de ventas se pondrá en contacto contigo para firmar el contrato. items: type: object properties: title: type: string description: Titulo del paso. example: Documentos adicionales description: type: string description: Descripción del paso. example: >- Es posible que se necesiten documentos adicionales para completar tu onboarding. En ese caso nos pondremos en contacto contigo. additionalProperties: true RecordValidationSchema: type: object description: >- Schema de validación para el expediente de la verificacion. Las reglas que se definan aqui sera la que determine la finalizacion de la verificacion. properties: version: type: number description: Version del schema de validacion, ahora solo soporta la version 2. enum: - 2 requirements: type: object description: >- Mapa de requerimientos donde la clave es un ID personalizado (por ejemplo, "doc_1") additionalProperties: $ref: '#/components/schemas/RequirementDefinition' example: doc_1: ui_options: label: Constancia de Situación Fiscal description: >- Documento que certifica que la empresa está al día con sus obligaciones fiscales. conditional_render: true conditional_render_label: >- ¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial? allowed_item_types: - csf_mx validation_options: on_invalid_type_error: invalidate optional_requirements: type: object description: >- Mapa de requerimientos opcionales donde la clave es un ID personalizado (por ejemplo, "doc_1") additionalProperties: $ref: '#/components/schemas/RequirementDefinition' ErrorResponse: type: object properties: success: type: boolean example: false message: type: string example: Descripción breve y accionable del error code: oneOf: - type: string enum: - VALIDATION_ERROR - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - DUPLICATE_RESOURCE - INTERNAL_SERVER_ERROR - type: string description: Código de dominio específico (p.ej., items_not_provided) example: VALIDATION_ERROR timestamp: type: string format: date-time example: '2025-01-01T12:34:56.000Z' RequirementDefinition: type: object properties: ui_options: type: object properties: label: type: string description: Etiqueta que se mostrará en la interfaz de usuario example: Constancia de Situación Fiscal description: type: string description: Descripción detallada del requerimiento example: >- Documento que certifica que la empresa está al día con sus obligaciones fiscales. conditional_render: type: boolean description: >- Indica si el campo debe ser renderizado condicionalmente mediante un checkbox, que tiene como leyenda la propiedad conditional_render_label. conditional_render_label: type: string description: >- Etiqueta que se mostrará en la interfaz de usuario para el campo condicional. example: >- ¿Los poderes del representante legal figuran en un acta de asamblea o poder notarial? allowed_item_types: type: array description: Lista de tipos de items permitidos para este requerimiento items: $ref: '#/components/schemas/AllowedItemType' example: - csf_mx validation_options: type: object properties: on_invalid_type_error: type: string description: > Determina el comportamiento cuando el documento no pasa la validación de tipo o de ruleset. - `"invalidate"` (default): el widget muestra al prospecto una alerta de error. El prospecto puede subir otro documento o continuar con el actual. El requerimiento se marca como `status: "error"`. - `"ignore"`: el widget muestra al prospecto el requerimiento como "en revisión" sin error. El operador del dashboard resuelve manualmente desde la webapp con 3 opciones: invalidar y pedir nuevo documento, descartar sin acción, o aceptar y elegir el tipo de ítem para extracción. Esta configuración aplica por igual a errores de tipo de documento y a fallos de reglas del `ruleset`. Los errores de sistema (`validation_request_failed`) siempre se tratan como error independientemente de este valor. Consulta la [guía de Flujos de onboarding](/guia-devs/account-flows#comportamiento-ante-error-de-validación-validation_optionson_invalid_type_error) para más detalles. enum: - invalidate - ignore ruleset: type: array description: > Lista de reglas de validación de negocio que se evaluarán automáticamente sobre el documento mediante IA. Consulta la guía de [flujo de validación de documentos](/guia-devs/flujo-validacion-documentos#reglas-de-validación-predefinidas-de-trébol) de documentos para la documentación completa de reglas predefinidas (`vr_trebol_*`) y personalizadas. **Nota:** el campo `error_message` es requerido para este caso en particular. items: type: object required: - id - error_message properties: id: type: string description: >- Identificador de la regla. Para reglas predefinidas de Trébol usa el prefijo `vr_trebol_`. Para reglas personalizadas, cualquier identificador único. example: vr_trebol_antiguedad error_message: type: string description: >- Mensaje de error personalizado que se mostrará al usuario cuando la regla no se cumpla. Requerido al configurar el ruleset en un account flow. example: La CSF debe tener menos de 60 días de antigüedad validation_rule: type: string description: >- Texto completo de la pregunta de validación para reglas personalizadas. No incluir en reglas predefinidas de Trébol (`vr_trebol_*`). example: >- ¿El RFC visible en el documento coincide con el RFC registrado de la empresa? params: type: object description: >- Parámetros para sustituir placeholders en reglas predefinidas de Trébol. additionalProperties: oneOf: - type: string - type: number example: days: 60 allowed_item_subtype: type: string description: >- El subtipo de item que se permite para este requerimiento, solo algunos items tienen subtipos, como los csf, o los bank statements. enum: - business - individual example: business required_options: type: object properties: people_scope: type: array items: type: string description: >- El alcance de las personas que deben ser consideradas en la verificación, aplica cuando el tipo de item es un person_id. enum: - powers required: - ui_options - allowed_item_types AllowedItemType: type: string description: Los siguientes son items basados en documentos. enum: - aa_mx - ac_mx - bank_statement - cc_co_ops - csf_mx - fme_mx - person_id - proof_address - pw_mx - property_deed - lien_certificate - property_tax_receipt - payroll_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 - financial_statements_any - unkown(cuando el ítem no corresponde a ninguno) responses: UnauthorizedError: description: No autorizado content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Unauthorized: summary: Falta API key o inválida value: success: false message: Unauthorized code: UNAUTHORIZED timestamp: '2025-01-01T12:34:56.000Z' NotFoundError: description: Recurso no encontrado content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: NotFound: summary: Recurso inexistente value: success: false message: Entity not found code: NOT_FOUND timestamp: '2025-01-01T12:34:56.000Z' InternalServerError: description: Error interno del servidor content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: ServerError: summary: Error inesperado value: success: false message: Internal server error code: INTERNAL_SERVER_ERROR timestamp: '2025-01-01T12:34:56.000Z' securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ````