Compartir a través de

Dokobit Universal API

Dokobit Universal API es una herramienta versátil que permite firmar documentos internamente, dentro del sistema y recopilar firmas de terceros, fuera de su sistema, en Toda Europa. La firma de documentos se produce en una firma dokobit sin cuenta (donde los participantes invitados pueden firmar documentos sin registrarse en el portal de Dokobit) con la personalización de marca de su organización.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Dokobit
URL https://support.dokobit.com
Correo Electrónico developers@dokobit.com
Metadatos del conector
Publicador Dokobit
Website https://www.dokobit.com/solutions
Directiva de privacidad https://www.dokobit.com/compliance/privacy-policy
Categorías Productividad

Dokobit Universal API es una herramienta versátil que permite firmar documentos internamente, dentro del sistema y recopilar firmas de terceros, fuera de su sistema, en Toda Europa. La firma de documentos se produce en una firma dokobit sin cuenta (donde los participantes invitados pueden firmar documentos sin registrarse en el portal de Dokobit) con la personalización de marca de su organización.

Prerrequisitos

Para usar la API universal de Dokobit, póngase en contacto con nosotros para sales@dokobit.com obtener el token de acceso de la API.

Obtención de credenciales

Póngase en contacto con nuestras ventas para obtener el token de acceso de api

Introducción al conector

  • La firma de documentos se puede iniciar mediante acciones "DokobitUniversalAPICreateExternalSigning" o "DokobitUniversalAPICreateInternalSigning". El uso de "DokobitUniversalAPICreateExternalSigning" enviará una invitación de firma a los participantes. "DokobitUniversalAPICreateInternalSigning" generará una dirección URL de firma donde se puede redirigir a los usuarios.
  • Después, la firma se puede administrar con las acciones correspondientes, lo que le permite agregar o quitar participantes, enviar recordatorios o comprobar el estado de firma del documento.
  • Una vez que los participantes firmen el documento, se pueden descargar con acciones "DokobitUniversalAPIDownloadDocumentExternal" o "DokobitUniversalAPIDownloadDocumentInternal".

Problemas y limitaciones conocidos

La implementación actual admite la recopilación de firmas en archivos PDF y es compatible con contenedores de ASiCe, ADoc, BDoc o EDoc.

Errores y soluciones comunes

  • El archivo debe proporcionarse como contenido de archivo codificado en Base64.
  • Si la firma de documentos 'Type' está establecida en 'pdf', se aceptará un único documento PDF cuando se inicie la firma de documentos. Para varios archivos, establezca la firma "Type" en "asice" u otro formato de contenedor.

Creación de una conexión

El conector admite los siguientes tipos de autenticación:
Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
Clave de API securestring La clave de API de esta API Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Actualizar firma externa

Permite actualizar atributos de una firma de documento existente.
Actualizar firma interna

Permite actualizar atributos de una firma de documento existente.
Agregar firmante externo

Los participantes indicados obtendrán acceso al documento con el rol seleccionado.
Agregar firmante interno

Los participantes indicados obtendrán acceso al documento con el rol seleccionado.
Comprobación del estado de firma interno

Devuelve la información del documento con el estado de firma.
Comprobar el estado de firma externa

Devuelve la información del documento con el estado de firma.
Crear firma externa

La firma externa inicia una solicitud de firma asincrónica desde el sistema. En este caso, el usuario recibe un correo electrónico para firmar y recibirá una devolución de llamada una vez que firma el documento.
Crear firma interna

La firma interna inicia la solicitud de firma desde el sistema. En este caso, se genera la dirección URL de firma en la que se debe redirigir al participante.
Descargar documento externo

Descarga el documento firmado.
Descargar documento interno

Descarga el documento firmado.
Eliminar firma externa

El documento se quitará de la cuenta del propietario. Seguirá siendo accesible para otros participantes.
Eliminar firma interna

El documento se quitará de la cuenta del propietario. Seguirá siendo accesible para otros participantes.
Eliminar firmante externo

El acceso al documento se revocará para el participante indicado.
Eliminar firmante interno

El acceso al documento se revocará para el participante indicado.
Entrega electrónica

La entrega electrónica de documentos se usa para compartir documentos de forma segura con dokobit Universal API.
Enviar recordatorio

Permite enviar un correo electrónico de recordatorio para el participante, solo si la persona aún no ha firmado el documento. Solo funciona con el flujo de firma externa.
Firma de sello

El documento se sellará con el sello electrónico de su organización. Póngase en contacto con nuestro soporte técnico para developers@dokobit.com obtener un certificado calificado para el sellado electrónico.
Validación: datos de diagnóstico XML

Descargue los datos de diagnóstico en XML.
Validación: informe PDF

Descargue el informe de validación en PDF.
Validación: informe PDF detallado

Descargue el informe de validación detallado en PDF.
Validación: informe XML

Descargue el informe de validación en XML.
Validation

Dokobit es un proveedor de servicios certificado por eIDAS para validaciones certificadas por e-signature y e-seal. Use esta acción para cargar un archivo firmado para la validación. Tipos de archivo admitidos: asice, asics, sce, bdocedoc, pdf, , p7s, . xml

Actualizar firma externa

Id. de la operación:
DokobitUniversalAPIUpdateExternalSigning

Permite actualizar atributos de una firma de documento existente.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.
Fecha límite
 deadline date-time

Fecha límite de firma con el fragmento de zona horaria especificado. Ejemplo: 2018-11-05T13:15:30Z.
Fecha límite dura
 hard_deadline boolean

Si se establece true en participantes, no podrá firmar ni aprobar este documento después de establecer deadline. Predeterminado: false.
Requerir firmas calificadas
 require_qualified_signatures boolean

Permitir firmar solo con firmas calificadas. Predeterminado: false.
Permitir identificación de vídeo
 allow_video_identification boolean

Permitir firmar mediante la identificación basada en vídeo. Predeterminado: false.
Permitir guardar documentos
 allow_document_saving boolean

Permitir que el usuario guarde el documento en el Portal de Dokobit y realice más acciones. Predeterminado: true.
Métodos de firma permitidos
 allowed_signing_methods array of string

Permitir solo métodos de firma específicos. Valores disponibles: mobile, smartid, , eparaksts_mobilesmartcard, bankid_no, bankid_semitiditsmeelectronic_idaudkenni_appftn, idin, , . swisscomsms_otp

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.

Actualizar firma interna

Id. de la operación:
DokobitUniversalAPIUpdateInternalSigning

Permite actualizar atributos de una firma de documento existente.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.
Requerir firmas calificadas
 require_qualified_signatures boolean

Permitir firmar solo con firmas calificadas. Predeterminado: false.
Permitir identificación de vídeo
 allow_video_identification boolean

Permitir firmar mediante la identificación basada en vídeo. Predeterminado: false.
Métodos de firma permitidos
 allowed_signing_methods array of string

Permitir solo métodos de firma específicos. Valores disponibles: mobile, smartid, , eparaksts_mobilesmartcard, bankid_no, bankid_semitiditsmeelectronic_idaudkenni_appftn, idin, , . swisscomsms_otp

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.

Agregar firmante externo

Id. de la operación:
DokobitUniversalAPIAddExternalSigner

Los participantes indicados obtendrán acceso al documento con el rol seleccionado.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.
Id. externo
 external_id True string

Identificador aleatorio único del participante del sistema. Puede generar identificadores aleatorios únicos si no tiene uno.
Nombre
 name string

Nombre del participante.
Surname
 surname string

Apellido del participante.
Correo electrónico
 email string

Correo electrónico del participante.
Código
 code string

Código del participante.
Código de país
 country_code string

Código de país del participante. Obligatorio si se proporciona código personal. Valores disponibles: LT, LV, EE, IS, NOFI, , BE. SE
Rol
 role string

Rol del participante. Valores disponibles: signer, viewer. Predeterminado: signer.
Empresa
 company string

Compañía del participante.
Position
 position string

Posición del participante.
Teléfono
 phone string

Teléfono del participante.
Motivo personalizado
 custom_reason string

Motivo de la firma personalizada.
Idioma de notificaciones
 notifications_language string

Establece el idioma de las notificaciones. Valores disponibles: en, lt, , etlv, is, nosedefr, fi, , , dk, . nl
Página
 page string

Índice de página para la anotación de firma de PDF visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Posición desde la parte superior
 top string

Posición (en puntos) de arriba para la anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Posición desde la izquierda
 left string

Posición (en puntos) de izquierda para la anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Language
 language string

Lenguaje de anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Valores disponibles: en, lt, lv, et, , is
Comentario
 comment string

Mensaje para los participantes.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.
Firmantes
 signers array of object

Información del participante.
Id. externo
 signers.external_id string

Identificador aleatorio único del participante del sistema.
Token
 signers.token string

Token del participante.
Nombre
 signers.name string

Nombre del participante.
Surname
 signers.surname string

Apellido del participante.
Correo electrónico
 signers.email string

Correo electrónico del participante.
Código
 signers.code string

Código personal del participante (número de identificación nacional).
Código de país
 signers.country_code string

País del participante.
Rol
 signers.role string

Rol del participante.
Empresa
 signers.company string

Compañía del participante.
Position
 signers.position string

Posición del participante.
Idioma de notificaciones
 signers.notifications_language string

Establece el idioma de las notificaciones. Valores disponibles: en, , lt, etlv, is, , no"fr", "se", "de".
Teléfono
 signers.phone string

Teléfono del participante.

Agregar firmante interno

Id. de la operación:
DokobitUniversalAPIAddInternalSigner

Los participantes indicados obtendrán acceso al documento con el rol seleccionado.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.
Id. externo
 external_id True string

Identificador aleatorio único del participante del sistema. Puede generar identificadores aleatorios únicos si no tiene uno.
Rol
 role string

Rol del participante. Valores disponibles: signer, viewer. Predeterminado: signer.
Código
 code string

Código del participante.
Código de país
 country_code string

Código de país del participante. Obligatorio si se proporciona código personal. Valores disponibles: LT, LV, EE, IS, NOPL, FI, , BESE.
Teléfono
 phone string

Teléfono del participante.
Idioma de notificaciones
 language string

Establece el idioma de la interfaz de usuario. Valores disponibles: en, lt, , etlv, is, nosedefr, fi, , , dk, . nl
Página
 page string

Índice de página para la anotación de firma de PDF visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Posición desde la parte superior
 top string

Posición (en puntos) de arriba para la anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Posición desde la izquierda
 left string

Posición (en puntos) de izquierda para la anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Language
 language string

Lenguaje de anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Valores disponibles: en, lt, lv, et, , is
Motivo personalizado
 custom_reason string

Motivo de la firma personalizada.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.
Firmantes
 signers array of object

Información del participante.
Id. externo
 signers.external_id string

Identificador aleatorio único del participante del sistema.
Token
 signers.token string

Token del participante.
Nombre
 signers.name string

Nombre del participante.
Surname
 signers.surname string

Apellido del participante.
Correo electrónico
 signers.email string

Correo electrónico del participante.
Código
 signers.code string

Código personal del participante (número de identificación nacional).
Código de país
 signers.country_code string

País del participante.
Rol
 signers.role string

Rol del participante.
Empresa
 signers.company string

Compañía del participante.
Position
 signers.position string

Posición del participante.
Teléfono
 signers.phone string

Teléfono del participante.

Comprobación del estado de firma interno

Id. de la operación:
DokobitUniversalAPICheckInternalSigningStatus

Devuelve la información del documento con el estado de firma.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado de firma
 status string

Estado de firma del documento.
Nombre
 name string

Nombre de firma que se muestra para el usuario.
Tipo
 type string

Tipo de documento.
Fecha de creación
 date_created string

Fecha en que se inició la firma de documentos.
Fecha límite
 deadline date-time

Fecha límite de firma con el fragmento de zona horaria especificado. Ejemplo: 2018-11-05T13:15:30Z.
Nombre de archivo
 filename string

Nombre del archivo.
Archivos
 files array of object
Nombre
 files.name string

Nombre de archivo.
Dirección URL de descarga
 files.url string

Dirección URL de descarga de archivos.
Tipo MIME
 files.mime_type string

Tipo MIME de archivo.
Firmantes
 signers array of object

Información del participante.
Token
 signers.token string

Token del participante.
Nombre
 signers.first_name string

Nombre del participante.
Surname
 signers.last_name string

Apellido del participante.
Código
 signers.code string

Código del participante.
País
 signers.country string

País del participante.
Correo electrónico
 signers.email string

Correo electrónico del participante.
Tipo
 signers.type string

Tipo.
Estado
 signers.status string

Estado del participante.

Comprobar el estado de firma externa

Id. de la operación:
DokobitUniversalAPICheckExternalSigningStatus

Devuelve la información del documento con el estado de firma.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado de firma
 status string

Estado de firma del documento.
Nombre
 name string

Nombre de firma que se muestra para el usuario.
Tipo
 type string

Tipo de documento.
Fecha de creación
 date_created string

Fecha en que se inició la firma de documentos.
Fecha límite
 deadline date-time

Fecha límite de firma con el fragmento de zona horaria especificado. Ejemplo: 2018-11-05T13:15:30Z.
Nombre de archivo
 filename string

Nombre del archivo.
Archivos
 files array of object
Nombre
 files.name string

Nombre de archivo.
Dirección URL de descarga
 files.url string

Dirección URL de descarga de archivos.
Tipo MIME
 files.mime_type string

Tipo MIME de archivo.
Firmantes
 signers array of object

Información del participante.
Token
 signers.token string

Token del participante.
Nombre
 signers.first_name string

Nombre del participante.
Surname
 signers.last_name string

Apellido del participante.
Código
 signers.code string

Código del participante.
País
 signers.country string

País del participante.
Correo electrónico
 signers.email string

Correo electrónico del participante.
Tipo
 signers.type string

Tipo.
Estado
 signers.status string

Estado del participante.

Crear firma externa

Id. de la operación:
DokobitUniversalAPICreateExternalSigning

La firma externa inicia una solicitud de firma asincrónica desde el sistema. En este caso, el usuario recibe un correo electrónico para firmar y recibirá una devolución de llamada una vez que firma el documento.

Parámetros

Nombre Clave Requerido Tipo Description
Tipo
 type True string

Formato de documento. Valores disponibles: pdf, asice, bdoc, edoc, adoc, . adoc.cedoc
Nombre
 name True string

Nombre de firma que se muestra para el usuario.
Postback URL
 postback_url string

Dirección URL del sistema para controlar webhooks.
Fecha límite
 deadline date-time

Fecha límite de firma con el fragmento de zona horaria especificado. Ejemplo: 2018-11-05T13:15:30Z.
Fecha límite dura
 hard_deadline boolean

Si se establece en true participantes, no podrá firmar este documento después de establecer deadline. Predeterminado: false.
Requerir firmas calificadas
 require_qualified_signatures boolean

Permitir firmar solo con firmas calificadas. Predeterminado: false.
Posición de anotación
 annotation_position string

Puede elegir la posición de las anotaciones de firma en un documento PDF. Valores disponibles: first_top, first_bottom, last_top, last_bottom, none. Predeterminado: first_top.
Código personal de anotación
 annotation_personal_code boolean

Si se establece true en código personal, estará visible en la anotación. Solo se aplica a la firma de tipos PDF. Predeterminado: false.
Comentario
 comment string

Mensaje para los participantes.
Permitir identificación de vídeo
 allow_video_identification boolean

Permitir firmar mediante la identificación basada en vídeo. Predeterminado: false.
Permitir guardar documentos
 allow_document_saving boolean

Permitir que el usuario guarde el documento en el Portal de Dokobit y realice más acciones. Predeterminado: true.
Pdf plano
 flatten_pdf boolean

Si se establece en true, el documento se aplanará para que los campos del formulario formen parte del contenido del documento y no se puedan editar después de la firma. Solo se aplica a la firma de tipos PDF. Predeterminado: false.
Métodos de firma permitidos
 allowed_signing_methods array of string

Permitir solo métodos de firma específicos. Valores disponibles: mobile, smartid, , eparaksts_mobilesmartcard, bankid_no, bankid_semitiditsmeelectronic_idaudkenni_appftn, idin, , . swisscomsms_otp
Nombre
 name True string

Nombre de archivo.
Content
 content True string

Contenido del archivo codificado en Base64.
Id. externo
 external_id True string

Identificador aleatorio único del participante del sistema. Puede generar identificadores aleatorios únicos si no tiene uno.
Nombre
 name string

Nombre del participante.
Surname
 surname string

Apellido del participante.
Correo electrónico
 email string

Correo electrónico del participante.
Código
 code string

Código personal del participante (número de identificación nacional).
Código de país
 country_code string

Código de país del participante. Obligatorio si se proporciona código personal. Valores disponibles: LT, LV, EE, IS, NOFI, , BE. SE
Rol
 role string

Rol del participante. Valores disponibles: signer, viewer. Predeterminado: signer.
Empresa
 company string

Nombre de la compañía del participante.
Position
 position string

Posición del participante.
Teléfono
 phone string

Número de teléfono del participante.
Sequence
 sequence integer

Permite configurar el orden de secuencia de las acciones de aprobación y firma de documentos.
Idioma de notificaciones
 notifications_language string

Establece el idioma de las notificaciones. Valores disponibles: en, lt, , etlv, is, nosedefr, fi, , , dk, . nl
Motivo personalizado
 custom_reason string

Motivo de la firma personalizada.
Página
 page string

Índice de página para la anotación de firma de PDF visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Posición desde la parte superior
 top string

Posición (en puntos) de arriba para la anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Posición desde la izquierda
 left string

Posición (en puntos) de izquierda para la anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Language
 language string

Lenguaje de anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Valores disponibles: en, lt, lv, et, , is

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.
Token de firma
 token string

Token de firma.
Firmantes
 signers array of object

Información del participante.
Id. externo
 signers.external_id string

Identificador aleatorio único del participante del sistema.
Token
 signers.token string

Token del participante.
Nombre
 signers.first_name string

Nombre del participante.
Surname
 signers.last_name string

Apellido del participante.
Código
 signers.code string

Código personal del participante (número de identificación nacional).
País
 signers.country string

País del participante.
Correo electrónico
 signers.email string

Correo electrónico del participante.

Crear firma interna

Id. de la operación:
DokobitUniversalAPICreateInternalSigning

La firma interna inicia la solicitud de firma desde el sistema. En este caso, se genera la dirección URL de firma en la que se debe redirigir al participante.

Parámetros

Nombre Clave Requerido Tipo Description
Tipo
 type True string

Formato de documento. Valores disponibles: pdf, asice, bdoc, edoc, adoc, . adoc.cedoc
Nombre
 name True string

Nombre de firma que se muestra para el usuario.
URI de redirección
 redirect_uri True string

URI de redirección que se usará para redirigir al firmante una vez completada la firma.
Postback URL
 postback_url string

Dirección URL del sistema para controlar webhooks.
Requerir firmas calificadas
 require_qualified_signatures boolean

Permitir firmar solo con firmas calificadas. Predeterminado: false.
Posición de anotación
 annotation_position string

Puede elegir la posición de las anotaciones de firma en un documento PDF. Valores disponibles: first_top, first_bottom, last_top, last_bottom, none. Predeterminado: first_top.
Código personal de anotación
 annotation_personal_code boolean

Si se establece true en código personal, estará visible en la anotación. Solo se aplica a la firma de tipos PDF. Predeterminado: false.
Permitir identificación de vídeo
 allow_video_identification boolean

Permitir firmar mediante la identificación basada en vídeo. Predeterminado: false.
Pdf plano
 flatten_pdf boolean

Si se establece en true, el documento se aplanará para que los campos del formulario formen parte del contenido del documento y no se puedan editar después de la firma. Solo se aplica a la firma de tipos PDF. Predeterminado: false.
Métodos de firma permitidos
 allowed_signing_methods array of string

Permitir solo métodos de firma específicos. Valores disponibles: mobile, smartid, , eparaksts_mobilesmartcard, bankid_no, bankid_semitiditsmeelectronic_idaudkenni_appftn, idin, , . swisscomsms_otp
Nombre
 name True string

Nombre de archivo.
Content
 content True string

Contenido del archivo codificado en Base64.
Id. externo
 external_id True string

Identificador aleatorio único del participante del sistema. Puede generar identificadores aleatorios únicos si no tiene uno.
Rol
 role string

Rol del participante. Valores disponibles: signer, viewer. Predeterminado: signer.
Código
 code string

Código del participante.
Código de país
 country_code string

Código de país del participante. Obligatorio si se proporciona código personal. Valores disponibles: LT, LV, EE, IS, NOPL, FI, , BESE.
Teléfono
 phone string

Teléfono del participante.
Idioma de notificaciones
 language string

Establece el idioma de la interfaz de usuario. Valores disponibles: en, lt, , etlv, is, nosedefr, fi, , , dk, . nl
Página
 page string

Índice de página para la anotación de firma de PDF visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Posición desde la parte superior
 top string

Posición (en puntos) de arriba para la anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Posición desde la izquierda
 left string

Posición (en puntos) de izquierda para la anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Language
 language string

Lenguaje de anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Valores disponibles: en, lt, lv, et, , is
Motivo personalizado
 custom_reason string

Motivo de la firma personalizada.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.
Token de firma
 token string

Token de firma.
Firmantes
 signers array of object

Información del participante.
Id. externo
 signers.external_id string

Identificador aleatorio único del participante del sistema.
Token
 signers.token string

Token del participante.
URI de redirección
 signers.redirect_uri string

Dirección URL a la firma.

Descargar documento externo

Id. de la operación:
DokobitUniversalAPIDownloadDocumentExternal

Descarga el documento firmado.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.

Devoluciones

response
object

Descargar documento interno

Id. de la operación:
DokobitUniversalAPIDownloadDocumentInternal

Descarga el documento firmado.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.

Devoluciones

response
object

Eliminar firma externa

Id. de la operación:
DokobitUniversalAPIDeleteExternalSigning

El documento se quitará de la cuenta del propietario. Seguirá siendo accesible para otros participantes.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.

Eliminar firma interna

Id. de la operación:
DokobitUniversalAPIDeleteInternalSigning

El documento se quitará de la cuenta del propietario. Seguirá siendo accesible para otros participantes.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.

Eliminar firmante externo

Id. de la operación:
DokobitUniversalAPIDeleteExternalSigner

El acceso al documento se revocará para el participante indicado.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.
Token
 token True string

Token del participante.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.

Eliminar firmante interno

Id. de la operación:
DokobitUniversalAPIDeleteInternalSigner

El acceso al documento se revocará para el participante indicado.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.
Token
 token True string

Token del participante.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.

Entrega electrónica

Id. de la operación:
DokobitUniversalAPIeDelivery

La entrega electrónica de documentos se usa para compartir documentos de forma segura con dokobit Universal API.

Parámetros

Nombre Clave Requerido Tipo Description
Tipo
 type True string

Formato de documento. Valores disponibles: pdf.
Nombre
 name True string

Nombre del documento que se muestra para el usuario.
Postback URL
 postback_url string

Dirección URL del sistema para controlar webhooks.
Comentario
 comment string

Mensaje para destinatarios.
Nombre
 name True string

Nombre de archivo.
Content
 content True string

Contenido del archivo codificado en Base64.
Id. externo
 external_id True string

Identificador aleatorio único del participante del sistema. Puede generar identificadores aleatorios únicos si no tiene uno.
Código
 code True string

Código personal del destinatario (número de identificación nacional).
Código de país
 country_code True string

Código de país del destinatario. Obligatorio si se proporciona código personal. Valores disponibles: lt, lv, ee, is.
Correo electrónico
 email string

Correo electrónico del destinatario para enviar el documento. Obligatorio si no se establece el teléfono.
Teléfono
 phone string

Número de teléfono del destinatario para enviar SMS de documento. Obligatorio si no se establece el correo electrónico. Sms solo se enviará cuando no se proporcione el correo electrónico.
Idioma de notificaciones
 notifications_language string

Establece el idioma de las notificaciones. Valores disponibles: en, , lt, etlv, is, , no"fr", "se", "de".

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.
Token de documento
 token string

Token de documento.
Recipientes
 recipients array of object

Información del destinatario.
Id. externo
 recipients.external_id string

Identificador aleatorio único del participante del sistema.
Token
 recipients.token string

Token del destinatario.
Código
 recipients.code string

Código personal del destinatario (número de identificación nacional).
País
 recipients.country string

País del destinatario.
Correo electrónico
 recipients.email string

Correo electrónico del destinatario.

Enviar recordatorio

Id. de la operación:
DokobitUniversalAPIReminder

Permite enviar un correo electrónico de recordatorio para el participante, solo si la persona aún no ha firmado el documento. Solo funciona con el flujo de firma externa.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.
Token del firmante
 signer True string

Token del participante.
Message
 message string

Mensaje de recordatorio para el firmante.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.

Firma de sello

Id. de la operación:
DokobitUniversalAPISealSigning

El documento se sellará con el sello electrónico de su organización. Póngase en contacto con nuestro soporte técnico para developers@dokobit.com obtener un certificado calificado para el sellado electrónico.

Parámetros

Nombre Clave Requerido Tipo Description
Token de firma
 token True string

Token de firma.
Motivo personalizado
 custom_reason string

Motivo de la firma personalizada.
Página
 page string

Índice de página para la anotación de firma de PDF visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Posición desde la parte superior
 top string

Posición (en puntos) de arriba para la anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.
Posición desde la izquierda
 left string

Posición (en puntos) de izquierda para la anotación de firma pdf visible. Solo se aplica a la firma de tipos PDF. Predeterminado: 1.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.

Validación: datos de diagnóstico XML

Id. de la operación:
DokobitUniversalAPIValidationXMLDiagnosticData

Descargue los datos de diagnóstico en XML.

Parámetros

Nombre Clave Requerido Tipo Description
Token de validación
 token True string

Token de validación recibido de la acción DokobitUniversalAPIValidation.

Devoluciones

response
object

Validación: informe PDF

Id. de la operación:
DokobitUniversalAPIValidationPDFReport

Descargue el informe de validación en PDF.

Parámetros

Nombre Clave Requerido Tipo Description
Token de validación
 token True string

Token de validación recibido de la acción DokobitUniversalAPIValidation.

Devoluciones

response
object

Validación: informe PDF detallado

Id. de la operación:
DokobitUniversalAPIValidationDetailedPDFReport

Descargue el informe de validación detallado en PDF.

Parámetros

Nombre Clave Requerido Tipo Description
Token de validación
 token True string

Token de validación recibido de la acción DokobitUniversalAPIValidation.

Devoluciones

response
object

Validación: informe XML

Id. de la operación:
DokobitUniversalAPIValidationXMLReport

Descargue el informe de validación en XML.

Parámetros

Nombre Clave Requerido Tipo Description
Token de validación
 token True string

Token de validación recibido de la acción DokobitUniversalAPIValidation.

Devoluciones

response
object

Validation

Id. de la operación:
DokobitUniversalAPIValidation

Dokobit es un proveedor de servicios certificado por eIDAS para validaciones certificadas por e-signature y e-seal. Use esta acción para cargar un archivo firmado para la validación. Tipos de archivo admitidos: asice, asics, sce, bdocedoc, pdf, , p7s, . xml

Parámetros

Nombre Clave Requerido Tipo Description
Nombre
 name True string

Nombre de archivo.
Content
 content True string

Contenido del archivo codificado en Base64.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado de carga
 status string

Estado de carga.
Token de validación
 token string

Token de validación.

Definiciones

objeto

Este es el tipo 'object'.