Appearance
Crear escaneo de firma para documento
POST
/document/{document-id}/signature-scan
Inicia un proceso de escaneo de firma digital para un documento específico. Este endpoint permite capturar firmas manuscritas digitalmente y asociarlas al documento para validación posterior.
Authorizations
bearerAuth
JWT token de autenticación. Utilice este esquema para autenticar solicitudes con un token JWT.
TypeHTTP (bearer)
Parameters
Path Parameters
document-id*
ID único del documento
Typestring
RequiredExample
123e4567-e89b-12d3-a456-426614174000format
uuidRequest Body
application/json
JSON
{
"signerInfo": {
"signerId": "456b7890-c123-45d6-e789-012345678901",
"signerName": "Juan Carlos Pérez García",
"signerPhone": "+573001234567",
"documentType": "string",
"documentNumber": "12345678"
},
"signatureType": "string",
"signatureFields": [
{
"fieldId": "signature_field_1",
"fieldName": "Firma del Deudor",
"pageNumber": 1,
"coordinates": {
"x": 100.5,
"y": 200.3,
"width": 150,
"height": 50
},
"required": true
}
],
"validationOptions": {
"requireOTP": true,
"otpDeliveryMethod": "string",
"requireBiometric": false,
"allowMultipleAttempts": true,
"maxAttempts": 3,
"expirationMinutes": 30
},
"notificationSettings": {
"sendEmailNotification": true,
"sendSMSNotification": true,
"customMessage": "Por favor firme el documento de crédito adjunto",
"callbackUrl": "https://api.cliente.com/webhook/signature-completed"
},
"metadata": {
"purpose": "Firma de contrato de crédito",
"legalBasis": "Artículo 123 del Código de Comercio",
"organizationId": "789f0123-4567-89ab-cdef-012345678901"
}
}
Responses
Escaneo de firma creado exitosamente
application/json
JSON
{
"success": true,
"message": "Escaneo de firma creado exitosamente",
"data": {
"signatureScanId": "789f0123-4567-89ab-cdef-012345678901",
"documentId": "123e4567-e89b-12d3-a456-426614174000",
"status": "string",
"signatureUrl": "https://signatures.kuenta.co/sign/789f0123-4567-89ab-cdef-012345678901",
"qrCode": "https://signatures.kuenta.co/qr/789f0123-4567-89ab-cdef-012345678901.png",
"expiresAt": "2024-01-15T17:30:00Z",
"tracking": {
"trackingId": "TRK-240115-001",
"estimatedCompletion": "5-10 minutos",
"nextStep": "Enviar notificación al firmante"
},
"securityInfo": {
"encryptionLevel": "AES-256",
"certificateInfo": "SSL Certificate válido hasta 2025-12-31",
"auditTrail": true
},
"createdAt": "2024-01-15T16:30:00Z"
}
}