Saltar al contenido principal
GET
@firma-dev/sdk

Autorizaciones

Authorization
string
header
requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Parámetros de ruta

id
string<uuid>
requerido

Respuesta

Solicitud de Firma recuperada correctamente. Devuelve una estructura anidada detallada con status como un objeto y las marcas de tiempo agrupadas.

Solicitud de Firma detallada, tal como la devuelve GET /signing-requests/{id} (forma anidada con objeto status y timestamps)

id
string<uuid>
requerido

Identificador único de la Solicitud de Firma

name
string
requerido

Nombre de la Solicitud de Firma

companies_workspaces_id
string<uuid>
requerido

ID del Espacio de Trabajo al que pertenece esta Solicitud de Firma

status
object
requerido

Indicadores de estado (pueden ser true varios a la vez en estados terminales)

template_description
string | null

Descripción de la Plantilla

document_url
string<uri>

URL prefirmada al documento PDF

document_url_expires_at
string<date-time> | null
document_page_count
integer

Cantidad de páginas del documento

Rango requerido: x >= 1
expiration_hours
integer

Horas hasta que expira la Solicitud de Firma

expires_at
string<date-time> | null

Timestamp ISO 8601 de cuándo expira la Solicitud de Firma. Se calcula a partir de sent_on + expiration_hours. Es null si aún no se envió o si no se estableció expiration_hours.

credit_cost
integer

Créditos consumidos al enviarse

timestamps
object

Todos los timestamps relevantes del ciclo de vida de la Solicitud de Firma

settings
object

Configuración devuelta por los endpoints de listado y detalle de Solicitudes de Firma. Las Plantillas usan el esquema TemplateSettings (sin campos de identidad).

use_signing_order
enum<integer>
obsoleto
Opciones disponibles:
0,
1
allow_download
enum<integer>
obsoleto
Opciones disponibles:
0,
1
allow_editing_before_sending
enum<integer>
obsoleto
Opciones disponibles:
0,
1
hand_drawn_only
enum<integer>
obsoleto
Opciones disponibles:
0,
1
attach_pdf_on_finish
enum<integer>
obsoleto
Opciones disponibles:
0,
1
certificate
object | null

Información del estado de generación del certificado

final_document_download_url
string<uri> | null

URL firmada para descargar el documento final firmado (PDF con certificado). La URL expira después de 1 hora.

final_document_download_error
enum<string> | null
Opciones disponibles:
file_not_accessible,
null
document_only_download_url
string<uri> | null

URL firmada para descargar el PDF solo del documento. La URL expira después de 1 hora.

document_only_download_error
enum<string> | null
Opciones disponibles:
file_not_accessible,
null
certificate_only_download_url
string<uri> | null

URL firmada para descargar el PDF solo del certificado. La URL expira después de 1 hora.

certificate_only_download_error
enum<string> | null
Opciones disponibles:
file_not_accessible,
null