Ir al contenido

Cambiar los métodos de firma

Ver como Markdown Lee esta página como texto plano Abrir en ChatGPT Haz preguntas sobre esta página Abrir en Claude Haz preguntas sobre esta página Abrir en Perplexity Haz preguntas sobre esta página

Los métodos de firma (con identidad, firma simple, e.firma o FIREL) se eligen al crear el documento, pero puedes cambiarlos después mientras el proceso de firma no haya terminado. Hay dos niveles:

  • Del documento: aplican a todos los firmantes que no tienen métodos propios.
  • De un firmante: solo para esa persona. Mandan sobre los del documento, y si se los quitas, el firmante vuelve a usar los del documento.

Los cambios aplican a las firmas que faltan. Lo que ya se firmó no se modifica.

Cuándo se puede

Mientras el documento no esté firmado ni rechazado (sign_status 1 o 2). Para un firmante, además, mientras ese firmante no haya firmado ni rechazado (sign_status PENDING).

Quién puede

Cualquier usuario de la carpeta de trabajo del documento, excepto los invitados. No aplica a documentos que viven dentro de un contenedor.


Así se expresa cada método en el documento y en el firmante. Los valores van en mayúsculas.

MétodoEn el documentoEn el firmante (allowed_signature_methods)
Firma con identidad (INE)allow_type_signatures incluye VERIFICAMEX e identity_providers incluye VERIFICAMEXIDENTITY
Firma simpleallow_type_signatures incluye VERIFICAMEX e identity_providers incluye LOCALSIMPLE
e.firma (SAT)allow_type_signatures incluye EFIRMAEFIRMA
FIREL (Poder Judicial)allow_type_signatures incluye FIREL (y TEPJF para el Tribunal Electoral)FIREL (incluye TEPJF)

Método: PATCH https://api.digitafirma.com/v1/documents/{uuid}/signature_methods

CampoTipoDescripción
uuidstringID del documento.
CampoTipoObligatorioDescripción
allow_type_signaturesArraySíReemplaza los tipos de firma permitidos: VERIFICAMEX, EFIRMA, FIREL, TEPJF. Al menos uno.
identity_providersArrayNoSolo tiene efecto con VERIFICAMEX: VERIFICAMEX (firma con identidad) y/o LOCAL (firma simple). Si lo omites, se conservan los actuales. Si lo mandas vacío junto con VERIFICAMEX, es un error.

El resto de la configuración del documento (colores, logo, notificaciones, etc.) no cambia.

Ventana de terminal
curl --location --request PATCH 'https://api.digitafirma.com/v1/documents/{uuid}/signature_methods' \
--header 'X-Api-Key: {X-API-KEY}' \
--header 'Content-Type: application/json' \
--data '{
"allow_type_signatures": ["VERIFICAMEX", "EFIRMA"],
"identity_providers": ["VERIFICAMEX", "LOCAL"]
}'

Método: PATCH https://api.digitafirma.com/v1/documents/{uuid}/signatures/{signatureId}/signature_methods

CampoTipoDescripción
uuidstringID del documento.
signatureIdstringID del firmante (el id de cada elemento de signatures en la respuesta del documento).
CampoTipoObligatorioDescripción
allowed_signature_methodsArray | nullNoReemplaza los métodos del firmante: IDENTITY, SIMPLE, EFIRMA, FIREL. Vacío ([]) o null quita la restricción y el firmante vuelve a usar los métodos del documento.
Ventana de terminal
curl --location --request PATCH 'https://api.digitafirma.com/v1/documents/{uuid}/signatures/{signatureId}/signature_methods' \
--header 'X-Api-Key: {X-API-KEY}' \
--header 'Content-Type: application/json' \
--data '{
"allowed_signature_methods": ["EFIRMA", "FIREL"]
}'

CódigoMensaje (detail)Causa
400document: El documento ya está firmado; sus métodos de firma ya no se pueden modificarTodos los firmantes ya firmaron.
400document: El documento fue rechazado; sus métodos de firma ya no se pueden modificarUn firmante rechazó el documento.
400document: Los métodos de firma de un documento dentro de un lote no se pueden modificarEl documento vive dentro de un contenedor.
400allow_type_signatures: Elige al menos un método de firma para el documentoallow_type_signatures vino vacío.
400identity_providers: Con VERIFICAMEX elige firma con identidad (VERIFICAMEX), firma simple (LOCAL) o ambasSe mandó VERIFICAMEX con identity_providers vacío.
400identity_providers: El proveedor de identidad … no es válidoUn valor distinto de VERIFICAMEX o LOCAL.
400signature: El firmante ya firmó; sus métodos de firma ya no se pueden modificarEse firmante ya firmó.
400signature: El firmante rechazó el documento; sus métodos de firma ya no se pueden modificarEse firmante rechazó el documento.
400El usuario no tiene permisoTu usuario es invitado en la carpeta de trabajo del documento.
400El documento no fue encontradoEl uuid no existe o tu usuario no pertenece a la carpeta de trabajo del documento.
400No se encontraron firmantes sin firmarEl signatureId no pertenece a ese documento.
400—Un método en minúsculas o que no existe (por ejemplo efirma).
401—Falta la X-Api-Key o no es válida.