Centro de ayudaIntegraciones

Para: Administradores

Envíe firmas electrónicas y lea firmas con una clave central.

Crea una firma electrónica para un caso a partir de una plantilla, elige quién firma cada campo, publícala para su firma y descarga la copia bloqueada una vez que todos hayan firmado.

En este artículo9 secciones

Antes de empezar

Esta página trata sobre cómo enviar signaturas electrónicasFirma electrónica Un documento enviado para firma electrónica, firmado en el navegador. y cómo seguir esas signaturas con una clave de enlace. Los caminos para acceder a estos datos se encuentran bajo https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Llamadas

LlamarLo que hace
GET /signs/templatesLista de sus plantillas de firma electrónica.
POST /signsSe crea un archivo electrónico sobre el caso, que aún no ha sido publicado.
PUT /signs/<sign_id>/schemaSe elige quién firmará cada campo.
PUT /signs/<sign_id>Cambia el nombre, la fecha de vencimiento o los recordatorios antes de su publicación.
PUT /signs/<sign_id>/publishLo publica, y luego lo envía a sus firmantes.
GET /signs?filter=allLista de los documentos electrónicos relacionados con el caso.
GET /signs/<sign_id>Lee un documento electrónico, junto con su estado.
DELETE /signs/<sign_id>Elimínelo, junto con sus firmas.
GET /signs/<sign_id>/responsesLista de sus firmas.
GET /signs/<sign_id>/responses/<response_id>Lee una firma.

Un documento electrónico se genera en varios pasos: primero se crea el documento, luego se verifica quién firma cada campo del mismo, y finalmente se publica. Hasta que el documento sea publicado, los signatarios no pueden verlo, y nadie se entera de ello. Una vez que el documento está publicado, no se puede cambiar nada al respecto.

Creación de una firma electrónica

GET /signs/templates Lista de los documentos electrónicos que han sido publicados. PlantillasPlantilla Un formulario, formulario, firma electrónica, nota o tarea reutilizable que se guarda en la biblioteca y se copia en los expedientes., Los más antiguos primero, y cada uno de ellos… asset_id, title, description, due_mins (¿Cuántos minutos después de que se envíe lo que se debe enviar?). notifications, y role_field_participants, Los roles que indican cada campo.

POST /signs acepta los siguientes valores:

CampoLo que haceRequeridoPor defecto
nameEl título del documento electrónico. Letras, números, espacios y & ' - _ ( ) . /; sin comas ni puntos y coma.Sí.—
duration{"due_date": "2026-10-09T17:00:00-04:00"}, con su desplazamiento en el huso horario. Los documentos electrónicos no se repiten: se rechaza la posibilidad de que se repitan.Sí.—
template{"owner": "host", "template_id": "<asset_id>"} Para utilizar el documento y los signatarios de un plantilla.No.Ninguno.
descriptionUna nota que se muestra junto con el archivo electrónico.No.El modelo utilizado…
notificationsRecordatorios: {"names": ["days"], "values": [-1440]}. Cada valor indica el número de minutos que faltan hasta la fecha de vencimiento.No.El modelo, o nada.
instant_notifyfalse No se envían ninguna solicitud durante el proceso de publicación; solo se envían los recordatorios.No.El modelo, o true
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/signs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Retainer Agreement", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "template": {"owner": "host", "template_id": "sign::20260915101500_7a6b5c4d3e2f10"}}'

Responde a 201 con sign_id. El documento del plantilla se copia en segundo plano: espere hasta que no haya más copying en el documento.

Para enviar su propio PDF, cree el archivo electrónico sin incluir la etiqueta template. Cargue el PDF como documento y espere a que esté listo. Luego, asigne los campos correspondientes al documento. Para más información, vea Carga y adjunta archivos con una clave de hub.

Elegir quién firma

A partir de un modelo predefinido, cada campo se asigna a las personas que ocupan los roles correspondientes en el caso cuando se crea la firma electrónica. Por lo tanto, primero hay que incluir al cliente en el caso. El field_participants de la firma electrónica muestra el resultado: el nombre de cada campo, junto con los IDs de los usuarios que la firman.

Para cambiarlo, envíe toda la mapa a PUT /signs/<sign_id>/schema:

{"field_participants": {"Client Signature": ["cu-4f1c2a9e8b7d60"], "Attorney Signature": ["cu-9d8c7b6a5f4e30"]}}
  • Cada identificación debe corresponder a alguien que esté involucrado en el caso. La asistente virtual no puede firmar nada.
  • Los nombres de los campos son aquellos que se encuentran en el documento.
  • El mapa reemplaza al antiguo: aquellos campos que se dejan sin marcar no tienen ningún indicador.

Publicación

PUT /signs/<sign_id>/publish no toma ningún cuerpo y devuelve 200. Al menos uno de los campos debe tener un firmante; un campo sin firmante permanecerá vacío.

  • A cada firmante se le envía un correo electrónico con la solicitud de firmar, o se le envía un mensaje de texto, si no tiene correo electrónico confirmado. Esto ocurre de inmediato, a menos que… instant_notify Es false. Aparece en ellos. Cosas que deben hacerseQue hacer La lista en el maletín de cosas que te esperan, como formularios para rellenar, documentos para firmar o eventos para confirmar. Y también en las notificaciones de su portal.
  • Los recordatorios se envían cada vez en el momento notifications, hasta que las personas a quienes se dirigen los firmen.
  • Alguien que está lejos del caso deja de sostenerlo en sus manos.

Tras las firmas

El signo electrónico status Lee/Leer completed Una vez que todos hayan firmado, y… completed_on Indica cuándo ocurre, en el tiempo universal coordinado. 2026-10-06T21:42:10.123456+00:00. Hasta ahora, no tiene ni uno solo. responses Se asigna a cada firmante que haya firmado su documento. response_id.

En GET /signs/<sign_id>/responses se enumeran las firmas de cada signatario, ordenadas por orden de antigüedad. En una sola página se muestran todas las informaciones relacionadas con cada signatario: la firma del signatario en user_id, los campos que rellenó bajo response.formFieldValues, su firma en response.annotations, cualquier imagen de firma que tenga el signatario en response.attachments, y la dirección IP desde la cual firmó el signatario en response.ip.

A todo el personal encargado del caso se le informa, cada vez que alguien firma algo. También se les informa cuando la copia firmada está lista, tal como si hubieran sido ellos mismos quienes la enviaron. A todos los que firman, también se les informa cuándo está lista la copia firmada.

La copia bloqueada

Una vez que todos han firmado, se crea una copia del documento, en la cual cada firma queda registrada. La entrada del documento bajo media.schemas.items obtiene el valor flat, mientras que la ruta de acceso a la copia es flat_status, SUCCEEDED o FAILED. Puede descargar este archivo como cualquier otro archivo; consulte Carga y adjunta archivos con una clave de hub.

Listado y eliminación

GET /signs necesita filter: all enumera todos los signos electrónicos presentes en el caso, incluyendo aquellos que aún no han sido publicados. Los más recientes aparecen primero. self enumera aquellos signos electrónicos enviados por el Asistente Virtual, ya sea mediante cualquiera de las claves utilizadas o mediante automatizaciones. completed y uncompleted enumaran los signos electrónicos enviados por el propio llamante. Por lo tanto, estos campos siempre estarán vacíos en el caso de una clave específica. En lugar de eso, deben verificar los campos status y completed_on de cada signo electrónico.

DELETE /signs/<sign_id> puede eliminar cualquier firma electrónica en cualquier momento, y así se elimina de la lista de tareas pendientes de todos. Nadie es informado de esto.

Si se rechaza una llamada

EstadomessagePor qué
400SchemaFieldsExceptionSe ha perdido o invalidado un campo. Por ejemplo, puede tratarse de una coma en name, una regla de repetición, o un firmante que no está en el caso. En errors se indica su nombre.
400SchemaFieldsException, con ItemCopyNotAllowedException en templateEl plantilla no está publicada, no está disponible para las herramientas automáticas, o sus archivos aún están siendo procesados.
403PublishAlreadyPublishedExceptionYa se ha publicado, así que no puede cambiarse.
403PublishAlreadyAnsweredExceptionAlguien ya ha firmado ese documento.
403PublishParticipantsMissingExceptionNingún campo tiene un signatario.
403PublishMediaMissingExceptionTodavía no tiene ningún documento relacionado con esto.
403PublishMediaNotReadyExceptionSu documento aún está siendo copiado o convertido.
403PublishMediaFailedExceptionSu documento no pudo ser convertido.
403PublishDocumentUnreadableExceptionSu documento no puede ser leído. Por favor, elimine la firma electrónica y cree el documento nuevamente.
403PublishDueTimePassedExceptionFecha de vencimiento ya pasada.
403BotNotAllowedExceptionAlguien intentó firmar el documento, o eliminar la firma de otra persona.
403CaseClosedExceptionEl caso está cerrado.
404ItemNotFoundExceptionLa firma electrónica o el signo de autenticación no existen.

Para información sobre el cuerpo de error y los demás códigos, vea Como manejar los errores de la API y los códigos de estado.

Artículos relacionados

Entienda lo que la API puede hacerDescubre qué funciones pueden alcanzar una clave de administración y una clave de concentrador, por qué cada clave actúa como asistente virtual y dónde encontrar la lista técnica completa.IntegracionesEnvía formularios y lee las respuestas con una clave central.Crea un formulario para un caso a partir de una plantilla, publícalo para que lo rellenen las personas que deben hacerlo y lee sus respuestas.IntegracionesCarga y adjunta archivos con una clave de hub.Obtén una dirección de carga, sube un archivo, adjúntalo a una publicación, nota, tarea, formulario o firma electrónica, y descarga los archivos de un caso.IntegracionesGestionar errores de API y códigos de estadoLea el cuerpo del error, qué significan los códigos 400, 401, 403, 404, 500 y 503, y por qué un elemento que su clave no puede ver responde con el código 404.Integraciones