Kuenta Docs

Appearance

Listar sobres de documentos​

GET
/envelopes

Obtiene una lista de sobres de documentos (envelopes) que contienen múltiples documentos para proceso de firma. Los sobres permiten agrupar documentos relacionados y gestionar workflows de firma complejos con múltiples firmantes y documentos.

Authorizations​

bearerAuth

JWT token de autenticación. Utilice este esquema para autenticar solicitudes con un token JWT.

TypeHTTP (bearer)

Parameters​

Query Parameters

page

Número de página para paginación

Typeinteger
Example1
minimum1
default1
limit

Número de elementos por página

Typeinteger
Example20
minimum1
maximum100
default20
status

Filtrar por estado del sobre

Typestring
Enum
draftsentin_progresscompletedexpiredcancelledpending_review
Examplein_progress
recipient_email

Filtrar por email del destinatario

Typestring
Example[email protected]
formatemail
document_type

Filtrar por tipo de documento en el sobre

Typestring
Enum
credit_contractmortgage_agreementloan_applicationinsurance_policylegal_documentother
Examplecredit_contract
created_from

Fecha de creación desde (formato ISO 8601)

Typestring
Example2024-01-01T00:00:00Z
formatdate-time
created_to

Fecha de creación hasta (formato ISO 8601)

Typestring
Example2024-01-31T23:59:59Z
formatdate-time
expiration_status

Filtrar por estado de expiración

Typestring
Enum
activeexpiring_soonexpired
Exampleexpiring_soon
sender_id

Filtrar por ID del remitente

Typestring
Example123e4567-e89b-12d3-a456-426614174000
formatuuid
organization_id

Filtrar por ID de la organización

Typestring
Example789f0123-4567-89ab-cdef-012345678901
formatuuid
priority

Filtrar por nivel de prioridad

Typestring
Enum
lownormalhighurgent
Examplehigh
signature_method

Filtrar por método de firma requerido

Typestring
Enum
electronicdigitalbiometricmanual
Exampleelectronic
search

Búsqueda de texto libre en título y descripción

Typestring
Examplecontrato crédito juan
maxLength100
sort_by

Campo por el cual ordenar

Typestring
Enum
created_atupdated_atexpires_atprioritystatussender_name
Exampleexpires_at
defaultcreated_at
sort_order

Orden de clasificación

Typestring
Enum
ascdesc
Exampleasc
defaultdesc

Responses​

Lista de sobres obtenida exitosamente
application/json
JSON
{
"success": true,
"message": "success",
"data": {
"envelopes": [
{
"envelopeId": "123e4567-e89b-12d3-a456-426614174000",
"title": "Documentos de Crédito - Juan Pérez",
"description": "Documentos para aprobación de crédito de vivienda",
"status": "string",
"priority": "string",
"senderInfo": {
"senderId": "456b7890-c123-45d6-e789-012345678901",
"senderName": "María García - Analista de Crédito",
"senderEmail": "[email protected]",
"organizationName": "Kuenta Financial Services"
},
"recipientsInfo": {
"totalRecipients": 2,
"completedRecipients": 1,
"pendingRecipients": 1,
"recipients": [
{
"recipientId": "789f0123-4567-89ab-cdef-012345678901",
"recipientName": "Juan Carlos Pérez García",
"recipientEmail": "[email protected]",
"role": "primary_debtor",
"status": "string",
"lastActivity": "2024-01-15T16:30:00Z"
}
]
},
"documentsInfo": {
"totalDocuments": 3,
"completedDocuments": 2,
"pendingDocuments": 1,
"documentTypes": [
[
"credit_contract",
"insurance_policy",
"guarantee_letter"
]
],
"totalSignatures": 6,
"completedSignatures": 4
},
"progressInfo": {
"overallProgress": 66.7,
"documentsProgress": 66.7,
"signaturesProgress": 66.7,
"estimatedCompletion": "2024-01-16T18:00:00Z",
"nextAction": "Esperando firma del documento de garantía"
},
"timestamps": {
"createdAt": "2024-01-15T14:00:00Z",
"sentAt": "2024-01-15T14:15:00Z",
"lastActivity": "2024-01-15T16:30:00Z",
"expiresAt": "2024-01-20T14:15:00Z",
"completedAt": "string"
},
"workflowInfo": {
"workflowType": "credit_approval_sequential",
"currentStage": "primary_debtor_signature",
"totalStages": 4,
"completedStages": 2,
"autoReminders": true,
"nextReminderAt": "2024-01-16T14:15:00Z"
},
"securityInfo": {
"encryptionLevel": "AES-256",
"accessRestrictions": [
[
"ip_restriction",
"time_limit",
"device_limit"
]
],
"auditTrailEnabled": true,
"complianceLevel": "ESIGN_ACT_COMPLIANT"
},
"tags": [
[
"credit",
"urgent",
"premium_client"
]
],
"actions": {
"canView": true,
"canEdit": false,
"canCancel": true,
"canResend": true,
"canDownload": true
}
}
],
"pagination": {
"currentPage": 1,
"totalPages": 5,
"totalItems": 97,
"itemsPerPage": 20,
"hasNextPage": true,
"hasPreviousPage": false
},
"summary": {
"totalEnvelopes": 97,
"statusCounts": {
"draft": 5,
"sent": 12,
"in_progress": 25,
"completed": 45,
"expired": 8,
"cancelled": 2
},
"priorityCounts": {
"low": 20,
"normal": 35,
"high": 30,
"urgent": 12
},
"averageCompletionTime": "2.5 días",
"expiringThisWeek": 8
}
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI