crear_documento_desde_plantilla

Genera un documento de firma electrónica a partir de una plantilla. Flujo: listar_plantillas → esta herramienta → enviar_documento. Devuelve el `documentId` y el `signingUrl` de cada firmante. IMPORTANTE: el documento queda en borrador (no consume crédito) hasta que lo envíes con enviar_documento.

Argument	Type	Description
asunto	string	Asunto del email de invitación.
titulo	string	Título del documento (si no, hereda el de la plantilla).
mensaje	string	Mensaje del email de invitación.
firmantes*	array	Los firmantes de esta instancia.
plantilla_id*	integer	El `id` de la plantilla.
requiere_biometria	boolean	true = cada firmante debe aprobar la verificación biométrica (DNI + prueba de vida) antes de firmar. Consume 1 crédito de verificación por aprobada.
avisar_por_whatsapp	boolean	true = a cada firmante que tenga `telefono` cargado se le manda el link de firma por WhatsApp, ADEMÁS del email cuando se habilitan los avisos iniciales al enviar. En Electrónica y contratos prepago consume 1 crédito por mensaje; en Digital pago por documento se consumen los 5 créditos incluidos del paquete al enviar con este canal. Consultá estado_cuenta. Sin saldo o sin teléfono no se manda el WhatsApp.
codigo_por_whatsapp	boolean	true = cada firmante debe ingresar un código de un solo uso recibido por WhatsApp antes de completar la firma (firma electrónica avanzada). OBLIGA a cargar `telefono` en TODOS los firmantes (sin teléfono, enviar_documento falla). Consume 1 crédito de WhatsApp por firmante, de la misma bolsa que los avisos (`whatsapp` en estado_cuenta); sin saldo el firmante firma normal.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "plantilla_id",
    "firmantes"
  ],
  "properties": {
    "asunto": {
      "type": "string",
      "description": "Asunto del email de invitación."
    },
    "titulo": {
      "type": "string",
      "description": "Título del documento (si no, hereda el de la plantilla)."
    },
    "mensaje": {
      "type": "string",
      "description": "Mensaje del email de invitación."
    },
    "firmantes": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "El `id` del firmante DE LA PLANTILLA (viene de listar_plantillas). Opcional: si la plantilla tiene un solo firmante se resuelve automáticamente, y si tiene varios se empareja por el orden de este array."
          },
          "email": {
            "type": "string",
            "format": "email",
            "description": "Email real del firmante para este documento."
          },
          "nombre": {
            "type": "string",
            "description": "Nombre completo del firmante."
          },
          "apellido": {
            "type": "string",
            "maxLength": 255,
            "description": "Apellido(s) por separado, para la validación biométrica."
          },
          "telefono": {
            "type": "string",
            "pattern": "^\\+[1-9]\\d{7,14}$",
            "description": "Teléfono en formato internacional (por ej. \"+5491123456789\") para mandarle el link de firma por WhatsApp además del email, cuando los avisos iniciales están habilitados. Requiere saldo de WhatsApp (ver estado_cuenta) y el canal activado en el documento. El consumo depende del plan; si falta teléfono o saldo no se manda el WhatsApp."
          },
          "dni_numero": {
            "type": "string",
            "maxLength": 32,
            "description": "Número de documento de identidad esperado. MUY recomendado si activás biometría: es lo único que garantiza que quien se verificó sea la persona a la que le mandás a firmar. Sin este dato, la verificación confirma que el documento presentado es auténtico y que la cara coincide con ese documento, pero no que sea el documento de tu firmante. Si no coincide, la verificación se rechaza y no se consume crédito."
          },
          "nombre_pila": {
            "type": "string",
            "maxLength": 255,
            "description": "Nombre(s) por separado, para la validación biométrica."
          }
        },
        "additionalProperties": false
      },
      "minItems": 1,
      "description": "Los firmantes de esta instancia."
    },
    "plantilla_id": {
      "type": "integer",
      "description": "El `id` de la plantilla.",
      "exclusiveMinimum": 0
    },
    "requiere_biometria": {
      "type": "boolean",
      "description": "true = cada firmante debe aprobar la verificación biométrica (DNI + prueba de vida) antes de firmar. Consume 1 crédito de verificación por aprobada."
    },
    "avisar_por_whatsapp": {
      "type": "boolean",
      "description": "true = a cada firmante que tenga `telefono` cargado se le manda el link de firma por WhatsApp, ADEMÁS del email cuando se habilitan los avisos iniciales al enviar. En Electrónica y contratos prepago consume 1 crédito por mensaje; en Digital pago por documento se consumen los 5 créditos incluidos del paquete al enviar con este canal. Consultá estado_cuenta. Sin saldo o sin teléfono no se manda el WhatsApp."
    },
    "codigo_por_whatsapp": {
      "type": "boolean",
      "description": "true = cada firmante debe ingresar un código de un solo uso recibido por WhatsApp antes de completar la firma (firma electrónica avanzada). OBLIGA a cargar `telefono` en TODOS los firmantes (sin teléfono, enviar_documento falla). Consume 1 crédito de WhatsApp por firmante, de la misma bolsa que los avisos (`whatsapp` en estado_cuenta); sin saldo el firmante firma normal."
    }
  },
  "additionalProperties": false
}

descargar_constancia

Devuelve una URL temporal (1 hora, sin token) para bajar la constancia de firma como PDF aparte: firmantes, fechas, IP, dispositivo y hash SHA-256 del PDF firmado. En esta plataforma la constancia ya va dentro del PDF firmado; esto es para tenerla como archivo separado. Sólo documentos COMPLETED.

Argument	Type	Description
documento_id*	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "documento_id"
  ],
  "properties": {
    "documento_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

descargar_documento_firmado

Devuelve una URL firmada de descarga del PDF firmado (con la constancia integrada al final). Pasado el plazo de resguardo responde 410.

Argument	Type	Description
documento_id*	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "documento_id"
  ],
  "properties": {
    "documento_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

enviar_documento

Pone el documento en firma. ACÁ se consume el crédito del documento; sin este paso queda en borrador. Por defecto manda el email de invitación a cada firmante. Con `enviar_email: false` no manda las invitaciones iniciales por email ni los avisos iniciales por WhatsApp/SMS. El documento igual queda en firma y vos distribuís los signingUrl obtenidos con obtener_documento. Los emails de finalización conservan su configuración salvo que indiques enviar_email_finalizacion. Esa opción controla el envío del PDF y la constancia al completar, según la plataforma; no cambia otros emails de avance o recordatorios.

Argument	Type	Description
documento_id*	integer	El id numérico del documento.
enviar_email	boolean	false = no enviar la invitación inicial por email ni los avisos iniciales por WhatsApp/SMS. Por defecto true. No cambia los emails de finalización.
enviar_email_finalizacion	boolean	Controla los emails de documento completado al remitente y los destinatarios, con el PDF y la constancia según la plataforma. Omitido conserva la configuración guardada; true los habilita y false los deshabilita. No cambia otros emails de avance o recordatorios.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "documento_id"
  ],
  "properties": {
    "documento_id": {
      "type": "integer",
      "description": "El id numérico del documento.",
      "exclusiveMinimum": 0
    },
    "enviar_email": {
      "type": "boolean",
      "description": "false = no enviar la invitación inicial por email ni los avisos iniciales por WhatsApp/SMS. Por defecto true. No cambia los emails de finalización."
    },
    "enviar_email_finalizacion": {
      "type": "boolean",
      "description": "Controla los emails de documento completado al remitente y los destinatarios, con el PDF y la constancia según la plataforma. Omitido conserva la configuración guardada; true los habilita y false los deshabilita. No cambia otros emails de avance o recordatorios."
    }
  },
  "additionalProperties": false
}

estado_cuenta

Saldos de la cuenta: créditos de documentos y, si la plataforma los usa, verificación de identidad biométrica, WhatsApp y SMS.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

listar_documentos

Lista los documentos del equipo con su estado (DRAFT, PENDING, COMPLETED, REJECTED).

Argument	Type	Description
pagina	integer	Página (por defecto 1).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "pagina": {
      "type": "integer",
      "description": "Página (por defecto 1).",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

listar_plantillas

Lista las plantillas del equipo con sus `id` y firmantes. Las plantillas se arman en la interfaz web; desde acá se usan para generar documentos.

Argument	Type	Description
pagina	integer	Página (por defecto 1).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "pagina": {
      "type": "integer",
      "description": "Página (por defecto 1).",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

obtener_documento

Devuelve un documento por su `id` numérico: estado, `meta` (`requireBiometricId`, `requireWhatsappOtp`, idioma), firmantes (con `signingStatus`, `signingUrl` y la identidad esperada para la biometría: `idDocumentNumber`, `firstName`, `lastName`), campos y `envelopeId`.

Argument	Type	Description
documento_id*	integer	El `id` numérico del documento.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "documento_id"
  ],
  "properties": {
    "documento_id": {
      "type": "integer",
      "description": "El `id` numérico del documento.",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

reenviar_invitacion

Reenvía el email a firmantes pendientes respetando el orden de firma. Si alguno de los elegidos todavía espera su turno, se rechaza todo el pedido sin enviar correos. Explicá el motivo y no reintentes automáticamente.

Argument	Type	Description
firmantes*	array	Los `recipientId` a los que reenviar (de obtener_documento).
documento_id*	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "documento_id",
    "firmantes"
  ],
  "properties": {
    "firmantes": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "minItems": 1,
      "description": "Los `recipientId` a los que reenviar (de obtener_documento)."
    },
    "documento_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

traza_auditoria

Devuelve la traza de auditoría completa del documento en JSON (creación, envío, apertura, firmas, con fecha/IP/dispositivo). Resuelve el envelopeId automáticamente a partir del id numérico.

Argument	Type	Description
pagina	integer
documento_id*	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "documento_id"
  ],
  "properties": {
    "pagina": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "documento_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

validar_pdf

Verifica criptográficamente las firmas de un PDF (de Identik o firma digital argentina): integridad, cadena, sello de tiempo RFC-3161, y si es un documento de PRUEBA. Equivalente autenticado del validador público /validar.

Argument	Type	Description
pdf_base64*	string	El PDF completo, en base64 (máx. 15 MB).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pdf_base64"
  ],
  "properties": {
    "pdf_base64": {
      "type": "string",
      "maxLength": 21495808,
      "description": "El PDF completo, en base64 (máx. 15 MB)."
    }
  },
  "additionalProperties": false
}

Identik Firma Electrónica

Try it

crear_documento_desde_plantilla

Identik Firma Electrónica

Try it

crear_documento_desde_plantilla

Tools (11)