Kuenta Docs

Appearance

Obtener detalles de sobre de documentos​

GET
/envelope/{envelope-id}

Obtiene información detallada de un sobre de documentos específico.

Información Incluida:

  • Metadatos del sobre (estado, fechas, remitente)
  • Lista de documentos contenidos
  • Información de destinatarios y estado de firmas
  • Configuración de workflow de firmas
  • Historial de actividades y notificaciones

Authorizations​

test

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://test-api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones
or
stage

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://stage-api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones
or
demo

OAuth 2.0 Client Credentials Grant (RFC 6749 §4.4).
Utilice este flow para autenticación de aplicación-a-aplicación sin intervención del usuario.
Ideal para servicios backend y integración entre sistemas.

clientCredentials Flow
Token URLhttps://demo-api.kuenta.co/v1/oauth/token
Scopes:
  • *Acceso completo (administrador)
  • users:readLectura de usuarios
  • users:writeEscritura de usuarios
  • users.info:writeEscritura de información de usuarios
  • clients:readLectura de clientes OAuth
  • clients:writeEscritura de clientes OAuth
  • verifications:writeEscritura de verificaciones
  • passwords:writeEscritura de contraseñas
  • keys:readLectura de claves
  • settings:readLectura de configuraciones
  • settings:writeEscritura de configuraciones

Parameters​

Path Parameters

envelope-id*

Identificador único del sobre de documentos

Typestring
Required
Exampled4e5f607-8901-2345-bcde-f23456789012
formatuuid

Responses​

Detalles del sobre obtenidos exitosamente
application/json
JSON
{
"status": "success",
"data": {
"envelope": {
"id": "d4e5f607-8901-2345-bcde-f23456789012",
"status": "string",
"subject": "Contrato de Crédito Vehicular",
"message": "Por favor revise y firme el contrato de crédito adjunto",
"senderInfo": {
"entityId": "string",
"organizationName": "Financiera Kuenta",
"senderName": "Carlos López",
"senderEmail": "[email protected]"
},
"documents": [
{
"documentId": "string",
"title": "Contrato de Crédito Vehicular #12345",
"status": "pending_signature"
}
],
"recipients": [
{
"recipientId": "string",
"name": "Ana María Rodríguez",
"email": "[email protected]",
"role": "signer",
"status": "pending",
"order": 1
}
],
"workflow": {
"type": "string",
"allowDecline": true,
"requireAllSignatures": true
},
"createdAt": "2024-01-15T10:00:00Z",
"expiresAt": "2024-01-22T10:00:00Z"
}
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI