> ## Documentation Index > Fetch the complete documentation index at: https://docs.pruff.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar requerimientos de documentos > Devuelve los requerimientos (tipos de archivo que se piden para un documento) configurados para tu empresa y que aplican a documentos de factoring y confirming. Los requerimientos de otras categorías, como los de onboarding o de créditos, no se incluyen. Se ordenan por `id` ascendente. Usa el `id` de cada requerimiento como `requirementTemplateId` en el endpoint **Subir documento a un requerimiento**. Este endpoint no recibe parámetros. ## OpenAPI ````yaml openapi/clients.yaml GET /requirements openapi: 3.1.0 info: title: API de clientes de Pruff version: '1' description: >- Endpoints que tus sistemas llaman para leer y operar los datos de tu empresa en Pruff. Todas las solicitudes van por HTTPS y se autentican con el header `x-api-key`. Las convenciones de formato, paginación y errores se describen en https://docs.pruff.com/api/introduccion. servers: - url: https://api.pruff.com/api/clients security: - ApiKeyAuth: [] tags: - name: Facturas description: Consulta de facturas electrónicas, facturas transables y cesiones. - name: Documentos description: Consulta y creación de documentos asociados a tus clientes. - name: Archivos description: Carga de archivos a operaciones y a los requerimientos de tus documentos. - name: Financiamiento description: >- Simula créditos, crea solicitudes de factoring y consulta las prórrogas de tu empresa. - name: Comité description: >- Consulta las aprobaciones de una solicitud en los comités de riesgo y de operaciones, y registra nuevas firmas. - name: Chat description: Exporta y envía mensajes del chat de una solicitud. - name: Reportes description: >- Reportes de operaciones, cartera, recaudaciones, cuentas pendientes y flujos de tu empresa. - name: Datahub description: >- Consulta de la información tributaria, financiera y de riesgo que Pruff tiene de tus clientes y deudores. - name: Mercado Público description: >- Licitaciones y órdenes de compra de Mercado Público (ChileCompra) cargadas en Pruff. - name: CRM description: >- Datos comerciales de tu CRM en Pruff: empresas con su ficha, pipeline, prospectos, gestiones y simulaciones. - name: SGR description: Operaciones SGR (garantías) de tu empresa. - name: Sincronizador description: >- Pide sincronizar a un cliente con el SII o la TGR para obtener su información más actualizada, y consulta el estado de esas sincronizaciones. - name: Usuarios description: >- Administra los usuarios de tu empresa en Pruff (crear, editar, eliminar, consultar su perfil y asignar subordinados) y consulta las cuentas (empresas conectadas) a las que cada usuario tiene acceso. - name: Contactos description: Crea contactos asociados a las empresas de tu cartera. paths: /requirements: get: tags: - Archivos summary: Listar requerimientos de documentos description: >- Devuelve los requerimientos (tipos de archivo que se piden para un documento) configurados para tu empresa y que aplican a documentos de factoring y confirming. Los requerimientos de otras categorías, como los de onboarding o de créditos, no se incluyen. Se ordenan por `id` ascendente. Usa el `id` de cada requerimiento como `requirementTemplateId` en el endpoint **Subir documento a un requerimiento**. Este endpoint no recibe parámetros. operationId: getRequirements responses: '200': description: Requerimientos configurados. content: application/json: schema: $ref: '#/components/schemas/RequirementListResponse' example: requirements: - id: 1 name: Factura description: PDF de la factura requiresFile: true required: false category: factoringDocument '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' '504': $ref: '#/components/responses/Timeout' components: schemas: RequirementListResponse: type: object required: - requirements properties: requirements: type: array description: >- Requerimientos configurados, ordenados por `id` ascendente. Arreglo vacío si no hay ninguno. items: $ref: '#/components/schemas/RequirementTemplate' RequirementTemplate: type: object description: Requerimiento de documento configurado para tu empresa. required: - id - name - description - requiresFile - required - category properties: id: type: integer description: >- Identificador del requerimiento. Úsalo como `requirementTemplateId` al subir un archivo. example: 1 name: type: string description: Nombre del requerimiento. example: Factura description: type: - string - 'null' description: Descripción del requerimiento. Es null si no tiene. example: PDF de la factura requiresFile: type: boolean description: >- Indica si el requerimiento exige adjuntar un archivo. Si es `true`, el archivo es obligatorio al registrarlo. example: true required: type: boolean description: >- Indica si el requerimiento es obligatorio según la configuración de tu empresa. example: false category: type: string enum: - factoringDocument - confirmingDocument description: >- Categoría del requerimiento, según el tipo de operación al que aplica. example: factoringDocument Error: type: object required: - message properties: message: type: string description: >- Identifica el error. En algunos casos es un texto en inglés con valores variables. Para tu lógica, usa el código HTTP y, cuando exista, `data.code`. displayMessage: type: string description: >- Mensaje pensado para mostrarlo a una persona. Normalmente en español; algunos mensajes de validación vienen en inglés. data: description: Detalle adicional del error, cuando existe. responses: Unauthorized: description: >- Falta el header `x-api-key`, su valor no es válido o la cuenta de API de tu empresa no está habilitada. content: application/json: schema: type: object required: - message properties: message: type: string example: message: 'Unauthorized: Invalid API Key' TooManyRequests: description: >- Tu empresa superó el límite de solicitudes. Todas las API keys de tu empresa comparten el mismo límite. Espera los segundos que indica el header `Retry-After` (o `data.retryAfterSeconds`) antes de reintentar. headers: Retry-After: description: Segundos que debes esperar antes de reintentar. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' example: message: >- Rate limit exceeded: 501 requests in the current 60s window, limit is 500. Retry in 12s. displayMessage: >- Superaste el límite de 500 solicitudes cada 60 segundos. Vuelve a intentarlo en 12 segundos. data: code: RATE_LIMIT_EXCEEDED scope: All API keys of your company share this budget. limit: 500 used: 501 windowSeconds: 60 retryAfterSeconds: 12 resetAt: '2026-11-04T15:00:12.000Z' hint: >- Wait until resetAt (or honor the Retry-After header) before retrying. Avoid repeating identical requests: reuse responses you already fetched, use filters and larger pageSize values instead of one request per item, and cap your client concurrency. InternalError: description: >- Error inesperado en Pruff. El texto de `message` puede variar (por ejemplo en mayúsculas); no dependas de él. content: application/json: schema: $ref: '#/components/schemas/Error' example: message: Internal server error Timeout: description: >- La solicitud superó el tiempo máximo de 55 segundos. La operación puede haberse completado igual: antes de reintentar una solicitud que crea o modifica datos, verifica su estado. content: application/json: schema: $ref: '#/components/schemas/Error' example: message: request_timeout displayMessage: La solicitud excedió el tiempo máximo permitido securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: API key que Pruff entrega a tu empresa. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.