Ir al contenido

Crear un documento.

El primer paso para iniciar un proceso de firmado legalmente vinculante es la configuración inicial. Aquí definirás quién firma, cómo firma y qué notificaciones recibirá.

  1. Configuración del Proceso: Define métodos de firma, proveedores y orden de ejecución.
  2. Definición de Participantes: Indica quiénes son los firmantes y espectadores.
  3. Personalización: Configura notificaciones, recordatorios y webhooks.

Para crear un nuevo documento, realiza una petición al siguiente endpoint:

Método: POST https://api.digitafirma.com/v1/documents

Identity Providers

Define qué tecnología validará la identidad:

  • VERIFICAMEX: Firma con identidad (INE vigente).
  • LOCAL: Firma simple (ideal para extranjeros).

Sign Modes

Determina cómo se visualizarán las firmas:

  • PDF_SIGNATURE: Firma incrustada en el PDF.
  • CLASSIC: Firma tradicional.
  • CLASSIC_BATCH: Firmado masivo.

CampoTipoDescripción
company_idstringID de la carpeta de trabajo (consulta Listar carpetas de trabajo).
sign_modeenumModo de firmado (CLASSIC, PDF_SIGNATURE, CLASSIC_BATCH).
sign_positionenumPosición de la firma en el documento: UPPER_RIGHT, UPPER_LEFT, LOWER_RIGHT, LOWER_LEFT, NONE o CUSTOM (coordenadas manuales, ver Firma con posiciones personalizadas).
webhookstringURL que recibirá notificaciones de estado.
sign_orderedenumACTIVE para forzar el orden del array de firmantes.
redirect_urlstringURL a la que se redirige al firmante al concluir el proceso. Opcional y 100% retrocompatible. Ver URL de redirección por documento.

identity_providers vs. allow_type_signatures

Sección titulada «identity_providers vs. allow_type_signatures»

Estos dos campos de config resuelven preguntas distintas y son independientes entre sí. La confusión más común es asumir que uno reemplaza al otro, o que con configurar uno de los dos es suficiente.

CampoResponde a…¿Cuándo importa?
allow_type_signatures¿Qué certificado se acepta como válido para firmar criptográficamente?Siempre. Es lo único que el backend valida al momento de firmar.
identity_providers¿Cómo se valida que el firmante es quien dice ser?Solo dentro del flujo guiado (ver regla clave abajo).

allow_type_signatures: qué certificados se aceptan

Sección titulada «allow_type_signatures: qué certificados se aceptan»
ValorSignifica
FIRELEl firmante sube su propio certificado (.pfx o key+cer) emitido por el Consejo de la Judicatura Federal.
EFIRMAEl firmante sube su propio certificado e.firma (SAT).
TEPJFEl firmante sube su propio certificado del Tribunal Electoral.
VERIFICAMEXHabilita el flujo guiado de Digitafirma: el firmante no necesita tener un certificado propio; el sistema le emite uno automáticamente después de validar su identidad.

identity_providers: cómo se valida la identidad dentro del flujo guiado

Sección titulada «identity_providers: cómo se valida la identidad dentro del flujo guiado»

Solo tiene efecto si allow_type_signatures incluye "VERIFICAMEX". Determina qué método(s) de validación puede elegir el firmante antes de que el sistema le emita su certificado:

ValorMétodo de validaciónIdeal para
VERIFICAMEXValida INE vigente y CURP contra fuentes oficiales (RENAPO). Mayor nivel de certeza sobre la identidad.Firmantes mexicanos con INE vigente.
LOCALValidación simplificada: video de identificación + código OTP al teléfono. No requiere INE.Extranjeros o casos donde no aplica validar con INE.

Puedes habilitar ambos valores (["VERIFICAMEX", "LOCAL"]) para que el firmante elija, o solo uno para forzar un método específico.

Objetivoidentity_providersallow_type_signatures
Firma con identidad (máxima certeza, requiere INE)["VERIFICAMEX"]["VERIFICAMEX"]
Firma simple (sin INE, ideal para extranjeros)["LOCAL"]["VERIFICAMEX"]
Dejar que el firmante elija cómo validar su identidad["VERIFICAMEX", "LOCAL"]["VERIFICAMEX"]
Solo aceptar certificados propios (e.firma / FIEL), sin flujo guiado(se puede omitir)["EFIRMA", "FIREL"]
Aceptar certificados propios y también flujo guiado["VERIFICAMEX", "LOCAL"]["EFIRMA", "VERIFICAMEX"]

Por defecto, cuando un firmante termina de firmar, permanece dentro de la pantalla de DigitaFirma. Con redirect_url puedes decidir a dónde enviar al firmante al concluir el proceso: tu propia plataforma, tu pantalla de éxito, el siguiente paso de tu onboarding o el siguiente trámite — sin que el firmante “se quede” en DigitaFirma sin saber qué hacer a continuación.

El campo es 100% opt-in: si no lo envías, todo sigue funcionando como antes.

Opcional y retrocompatible

Si redirect_url se omite o se envía vacío, no aparece en el documento ni en la respuesta de la API. Las integraciones existentes no se ven impactadas y no están obligadas a migrar.

Aplica a todos los flujos de firma

Firma con identidad (VerificameX), firma simple por OTP (Local) y firma directa con certificado propio .cer / .key. La URL se entrega en cada respuesta del proceso, lista para que el frontend redirija al firmante al concluir.

Validación estricta de esquema

Solo se aceptan URLs con esquema http o https válidos (por ejemplo, https://tudominio.com/fin-firma). Cualquier otro esquema (mailto:, tel:, javascript:) o rutas relativas serán rechazados al crear el documento.

Control del customer journey

Tú decides el siguiente paso dentro de tu propia plataforma: página de éxito, continuación del onboarding, acuse, cierre del flujo, siguiente trámite, etc. DigitaFirma solo redirige al finalizar.

  1. Creas el documento incluyendo redirect_url en la petición al endpoint de creación.
  2. DigitaFirma notifica al firmante y gestiona todo el proceso de firma (validación de identidad, emisión de certificado y firma criptográfica).
  3. Al finalizar, el firmante es redirigido automáticamente a la URL indicada — sin intervención extra de tu backend ni cambios en la integración actual.
ContextoQué logras con redirect_url
Bancos / fintechFirmar el contrato y continuar el alta directamente dentro de tu propia app.
RRHHFirmar políticas y regresar al portal del empleado para el siguiente paso.
SegurosFirmar la póliza y avanzar a la siguiente pantalla del trámite.
Gobierno / notaríasFirmar y mostrar el acuse o el siguiente requisito directamente en tu sitio.
SaaS integradosOrquestar la firma dentro de tu flujo de usuario, regresando al firmante al punto correcto de tu producto.

{
"company_id": "ac110005-9d0c-1243-819d-0c3b71220000",
"config": {
"identity_providers": [
"VERIFICAMEX",
"LOCAL"
],
"allow_type_signatures": [
"VERIFICAMEX",
"EFIRMA",
"FIREL"
]
},
"signatures": [
{
"name": "Juan Perez",
"email": "jpe@gmail.com",
"phone": "+522291449388",
"rfc": "XXXX941024V93"
}
],
"spectators": [
{
"name": "Hector Lavoe",
"email": "hl@hotmail.com"
}
],
"webhook": "{URL-WEBHOOK}",
"redirect_url": "https://tudominio.com/fin-firma",
"sign_ordered": "ACTIVE",
"notification_mode": "ENABLED",
"tries": 3,
"remember_every": 1,
"remember_at": "16:54"
}