Compartir a través de

Verificada

Conector de la API comprobada para habilitar la creación de procesos de firma de documentos personalizados.

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 Verificada
URL https://verified.eu/en/#about-us
Correo Electrónico support@verified.eu
Metadatos del conector
Publicador Crm - Konsulterna i Sverige AB
Sitio web https://verified.eu/
Directiva de privacidad https://verified.eu/trust-center
Categorías Contenido y archivos; Productividad

Comprobado es un proveedor de software como servicio de identificación electrónica y firma digital. Este conector permite integrarla en la API de Verified y crear procesos de firma sencillos e intuitivos dentro de la aplicación.

Prerrequisitos

Necesitará lo siguiente para continuar:

Obtención de credenciales

Este conector usa la autenticación básica. El usuario tiene que presentar el nombre de usuario, la contraseña y el identificador de empresa al crear una conexión. El nombre de usuario y la contraseña son los mismos que se usan para iniciar sesión en el portal verificado. Para obtener el identificador de empresa que tiene que iniciar sesión en el portal verificado, seleccione la empresa correcta si tiene varias y copia el identificador de la compañía desde la dirección URL.

Comienza

Un caso de uso común es iniciar y administrar un proceso de firma, es decir, configurar la automatización para enviar documentos para que se firmen en Verificado y obtener documentos firmados de forma periódica. Entre las acciones comunes que se usan para iniciar un proceso de firma comprobado se incluyen Crear sobre - descriptor o Crear sobre - valor predeterminado, Agregar documento a sobre, Agregar archivo al documento, Agregar destinatario a sobre y Actualizar el estado de publicación para sobre. Las acciones comunes que se usan para comprobar el estado Comprobado de los documentos incluyen Obtener sobre por identificador, Obtener todos los documentos por identificador de sobre, Obtener archivos por identificador de documento, Obtener dirección URL de archivo por identificador. Tenga en cuenta que la acción Generar token de seguridad siempre se usa como primer paso para obtener un token de seguridad que se va a usar en los pasos siguientes.

Problemas conocidos y limitaciones

Actualmente se conocen las siguientes limitaciones.

  • Al principio de cada flujo, hay que crear un token de autenticación que se va a reutilizar en cada paso siguiente.
  • Para agregar un documento, debe enviar una solicitud HTTP a una dirección URL determinada.
  • Para usar el nuevo punto de conexión de búsqueda, debe activarse para la cuenta a través del Suppoert comprobado.

Preguntas más frecuentes

¿Cómo se carga un documento en Verificado?

Para cargar un documento real, debe crear un archivo en la API verificada y cargar el hash del documento en la dirección URL del blob que respondió desde la API verificada.

¿Cómo obtengo el sobre después de usar la acción Obtener identificador de sobre?

Los pasos que crean un sobre responden con un uid, que es una ruta de acceso completa al sobre (ejemplo: "/envelopes/ABCDE"). Para otros pasos, solo necesita la última parte del uid (que es el identificador de sobre real, en nuestro ejemplo "ABCDE").

Este es un ejemplo sobre cómo hacerlo

substring(outputs('Create_new_default_envelope')?['body/uid'],11)

¿Cómo obtengo el identificador del documento después de usar la acción Agregar documento a sobre?

Los pasos que crean un documento responden con la ubicación del nuevo documento en el encabezado . La ubicación es la ruta de acceso completa al documento (ejemplo: "/api/envelopes/ABCDE/documents/FGHIJ"). Solo se necesita el identificador del documento (en nuestro caso: FGHIJ) para seguir los pasos.

Este es un ejemplo sobre cómo hacerlo

substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))

¿Cómo obtengo el identificador de flujo de un sobre?

Cuando se carga información sobre un sobre, el flujo relacionado formará parte de la respuesta (ejemplo: "/flow/default"). En la respuesta, se denomina identificador de un flujo, pero solo necesita la última parte cuando otro paso (como Obtener estado de flujo) solicita el identificador de flujo.

Este es un ejemplo sobre cómo hacerlo

substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)

¿Cómo puedo usar la nueva acción Buscar?

Para poder usar la nueva acción de búsqueda, el punto de conexión de búsqueda debe activarse para la organización verificada. Para ello, debe escribir un correo electrónico en Soporte técnico comprobado, incluido el identificador de la organización para que puedan activar el punto de conexión automáticamente.

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
nombre de usuario securestring El nombre de usuario de esta API Cierto
contraseña securestring La contraseña de esta API Cierto
Id. de empresa cuerda / cadena El id. de empresa lo proporciona Verified. Puede encontrarse en la dirección URL iniciando sesión en app.verified.eu Cierto

Limitaciones

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

Acciones

Actualizar destinatario por identificador

Actualiza un destinatario.
Actualizar el estado de publicación del sobre

Actualiza el estado de publicación de un sobre determinado.
Actualizar la configuración del sobre

Actualiza la configuración de un sobre determinado.
Agregar archivo al documento

Agrega un archivo a un documento existente.
Agregar destinatario a sobre

Agrega un destinatario a un sobre determinado.
Agregar documento al sobre

Agrega un nuevo documento a un sobre existente.
Buscar todos los sobres

Busque todos los sobres que coincidan con un filtro determinado.
Consulta de todos los sobres (en desuso)

Consulta todos los sobres que coinciden con un filtro determinado. (Obsoleto)
Creación de sobre: descriptor

Crea un sobre basado en un descriptor específico.
Creación de sobre: valor predeterminado

Crea un nuevo sobre mediante el descriptor predeterminado.
Crear vínculo de firma

Crea un vínculo de firma. La implementación es específica del flujo y puede que falte para el flujo específico.
Eliminar documento por identificador

Elimina un documento determinado.
Eliminar sobre por identificador

Elimina un sobre determinado.
Enviar notificación

Envía una notificación a los recepientos de un sobre determinado.
Establecer el estado de anulación del sobre

Establece el estado de un sobre determinado en anulado.
Establecer el estado de la papelera del sobre

Establece el estado de un sobre determinado en papelera.
Establecimiento del estado de anulación del documento

Establece el estado de un documento determinado en anulado.
Generación de un token de seguridad

Obtiene el token de autenticación de la API verificada.
Generar documento a partir de una plantilla

Genera un documento a partir de una plantilla preconfigurada.
Obtención de información de usuario

Obtiene información del usuario que ha iniciado sesión actualmente.
Obtención de la configuración del usuario

Obtiene la configuración de un usuario determinado.
Obtención de la dirección URL del archivo por identificador

Obtiene la dirección URL de un archivo determinado.
Obtención de la empresa por identificador

Obtiene información de una empresa determinada.
Obtención de todos los documentos por identificador de sobre

Obtiene todos los documentos relacionados con un sobre determinado.
Obtención de un destinatario específico para un sobre

Obtiene un destinatario específico para un sobre determinado.
Obtención del descriptor predeterminado

Obtiene el descriptor predeterminado para los sobres.
Obtención del estado del flujo por identificador de sobre

Obtiene el estado de flujo actual de un sobre determinado.
Obtención del sobre por identificador

Obtiene detalles de un sobre determinado.
Obtener archivo por identificador

Obtiene información sobre un archivo determinado.
Obtener archivos por identificador de documento

Obtiene todos los archivos conectados a un documento determinado.
Obtener descriptor por identificador

Obtiene información de un descriptor determinado.
Obtener documento por identificador

Obtiene información de un documento determinado.
Obtener todos los descriptores

Obtiene una lista de todos los descriptores presentes en la empresa actual. Se puede filtrar la lista.
Obtener todos los destinatarios del sobre

Obtiene todos los destinatarios de un sobre determinado.

Actualizar destinatario por identificador

Id. de la operación:
PutEnvelopesEnvelopeIdRecipientsRecipientId

Actualiza un destinatario.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de destinatario
 recipient-id True string

Identificador de los destinatarios en cuestión
Nombre
 givenName True string
Apellido
 familyName True string
Language
 language True string
Método de firma
 signingMethod True string
Notification (método)
 notificationMethod string
Correo electrónico
 email True string
Teléfono
 telephone string

El formato debe ser +<countryCode><telephonenumber>
Pedido
 order integer
Acción
 action True string

Nombre de la acción que debe ejecutar un destinatario.
Etiqueta
 label True string

Etiqueta para el rol o la acción de un destinatario
Nombre
 name True string

Nombre comprobado del rol de un destinatario
Secure
 secure boolean
SMS
 sms boolean
SSN
 ssn string
Banco
 bank string

Actualizar el estado de publicación del sobre

Id. de la operación:
PutEnvelopesEnvelopeIdPublishStatus

Actualiza el estado de publicación de un sobre determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Publicado
 published True boolean

Actualizar la configuración del sobre

Id. de la operación:
PutEnvelopesEnvelopeId

Actualiza la configuración de un sobre determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Firma secuencial
 sequentialSigning boolean
Saludo
 greeting string
Expiration
 expiration date

Fecha con el siguiente formato 2017-02-26T21:59:59.999Z
Avisos automáticos
 automaticReminders number

X días antes de la expiración

Agregar archivo al documento

Id. de la operación:
PostEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Agrega un archivo a un documento existente.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de documento
 document-id True string

Identificador del documento en cuestión
Nombre
 name True string
FileType
 fileType True string
Hash
 hash string

Devoluciones

Archivo
File

Agregar destinatario a sobre

Id. de la operación:
PostEnvelopesEnvelopeIdRecipients

Agrega un destinatario a un sobre determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Nombre
 givenName True string
Apellido
 familyName True string
Language
 language True string
Método de firma
 signingMethod True string
Notification (método)
 notificationMethod string
Correo electrónico
 email True string
Teléfono
 telephone string

El formato debe ser +<countryCode><telephonenumber>
Pedido
 order integer
Acción
 action True string

Nombre de la acción que debe ejecutar un destinatario.
Etiqueta
 label True string

Etiqueta para el rol o la acción de un destinatario
Nombre
 name True string

Nombre comprobado del rol de un destinatario
Secure
 secure boolean
SMS
 sms boolean
SSN
 ssn string
Banco
 bank string

Agregar documento al sobre

Id. de la operación:
PostEnvelopesEnvelopeIdDocuments

Agrega un nuevo documento a un sobre existente.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Hash
 hash integer
Nombre
 name True string
Fuente
 source string

Buscar todos los sobres

Id. de la operación:
GetSearchEnvelopes

Busque todos los sobres que coincidan con un filtro determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Filtros
 filters string

Filtrar consulta para seleccionar subamount
De
 from integer

A partir de la fecha
Limit
 limit integer

Importe límite
Ordenar
 sort string

Ordenar por

Devoluciones

response
array of EnvelopeDescriptorString

Consulta de todos los sobres (en desuso)

Id. de la operación:
GetQueryEnvelopes

Consulta todos los sobres que coinciden con un filtro determinado. (Obsoleto)

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Filtros
 filters string

Filtrar consulta para seleccionar subamount
De
 from integer

A partir de la fecha
Limit
 limit integer

Importe límite
Ordenar
 sort string

Ordenar por

Devoluciones

response
array of EnvelopeDescriptorString

Creación de sobre: descriptor

Id. de la operación:
PostEnvelopeDescriptorsEnvelopeDescriptorIdEnvelopes

Crea un sobre basado en un descriptor específico.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador del descriptor de sobre
 envelope-descriptor-id True string

Identificador del descriptor de sobre
Correo Electrónico
 email string
Nombre
 givenName string
Apellido
 familyName string
Avisos automáticos
 automaticReminders number
Expiration
 expiration string
Hash
 hash string

Devoluciones

Nombre Ruta de acceso Tipo Description
uid
 uid string

Creación de sobre: valor predeterminado

Id. de la operación:
PostEnvelopeDescriptorsDefaultEnvelopes

Crea un nuevo sobre mediante el descriptor predeterminado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Correo Electrónico
 email string
Nombre
 givenName string
Apellido
 familyName string
Avisos automáticos
 automaticReminders number
Expiration
 expiration string
Hash
 hash string

Devoluciones

Nombre Ruta de acceso Tipo Description
uid
 uid string

Crear vínculo de firma

Id. de la operación:
PostEnvelopesEnvelopeIdJobsGetSignLink

Crea un vínculo de firma. La implementación es específica del flujo y puede que falte para el flujo específico.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id
 id string
Redireccionamiento a
 redirectTo uri

Dirección URL completa para redirigir al usuario a después del inicio de sesión.

Devoluciones

Nombre Ruta de acceso Tipo Description
URL
 getSignLink.recipient.{recipient-id}.url string

Eliminar documento por identificador

Id. de la operación:
DeleteEnvelopesEnvelopeIdDocumentsDocumentId

Elimina un documento determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de documento
 document-id True string

Identificador del documento en cuestión

Eliminar sobre por identificador

Id. de la operación:
DeleteEnvelopesEnvelopeId

Elimina un sobre determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión

Enviar notificación

Id. de la operación:
PostEnvelopesEnvelopIdJobsSendNotification

Envía una notificación a los recepientos de un sobre determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Saludo
 greeting string
Id. de destinatario
 id True string

Identificador del destinatario al que se debe enviar la notificación.

Establecer el estado de anulación del sobre

Id. de la operación:
PutEnvelopesEnvelopeIdAbortStatus

Establece el estado de un sobre determinado en anulado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
comentario
 comment string

Establecer el estado de la papelera del sobre

Id. de la operación:
PutEnvelopesEnvelopeIdTrashStatus

Establece el estado de un sobre determinado en papelera.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Comentario
 comment string

Establecimiento del estado de anulación del documento

Id. de la operación:
PostEnvelopesEnvelopeIdDocumentsDocumentIdStatusAborted

Establece el estado de un documento determinado en anulado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de documento
 document-id True string

Identificador del documento en cuestión

Generación de un token de seguridad

Id. de la operación:
PostAuthenticate

Obtiene el token de autenticación de la API verificada.

Parámetros

Nombre Clave Requerido Tipo Description
Sin bloqueo IP
 withoutIpLock True integer

Si Comprobado activa el bloqueo IP (0, valor predeterminado) o no (1)

Devoluciones

Nombre Ruta de acceso Tipo Description
Token
 token string

Token de acceso

Generar documento a partir de una plantilla

Id. de la operación:
PostEnvelopesEnvelopeIdDocumentsDocumentIdTemplatesTemplateIdUserData

Genera un documento a partir de una plantilla preconfigurada.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de documento
 document-id True string

Identificador del documento en cuestión
ID de plantilla
 template-id True string

Identificador de la plantilla que se debe usar.
object

Obtención de información de usuario

Id. de la operación:
GetAuthUserinfo

Obtiene información del usuario que ha iniciado sesión actualmente.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"

Devoluciones

Body
UserInfo

Obtención de la configuración del usuario

Id. de la operación:
GetCompaniesCompanyIdUsersUserIdSettings

Obtiene la configuración de un usuario determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 company-id True string

El identificador de la empresa en cuestión
ID de usuario
 user-id True string

Identificador del usuario en cuestión

Devoluciones

Body
Setting

Obtención de la dirección URL del archivo por identificador

Id. de la operación:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileIdUrl

Obtiene la dirección URL de un archivo determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de documento
 document-id True string

Identificador del documento en cuestión
Id. de archivo
 file-id True string

Identificador del archivo en cuestión
As (objeto)
 asObject boolean

Define si la respuesta es un objeto

Devoluciones

Nombre Ruta de acceso Tipo Description
URL
 url string

Dirección URL del archivo

Obtención de la empresa por identificador

Id. de la operación:
GetCompaniesCompanyId

Obtiene información de una empresa determinada.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 company-id True string

El identificador de la empresa en cuestión

Devoluciones

Empresa
Company

Obtención de todos los documentos por identificador de sobre

Id. de la operación:
GetEnvelopesEnvelopeIdDocuments

Obtiene todos los documentos relacionados con un sobre determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión

Devoluciones

response
array of Document

Obtención de un destinatario específico para un sobre

Id. de la operación:
GetEnvelopesEnvelopeIdRecipientsRecipientId

Obtiene un destinatario específico para un sobre determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de destinatario
 recipient-id True string

Identificador de los destinatarios en cuestión

Devoluciones

Destinatario
Recipient

Obtención del descriptor predeterminado

Id. de la operación:
GetEnvelopeDescriptorsDefault

Obtiene el descriptor predeterminado para los sobres.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Filtros
 filters string

Filtrar consulta para seleccionar subamount

Devoluciones

Descriptor
Descriptor

Obtención del estado del flujo por identificador de sobre

Id. de la operación:
GetFlowsFlowIdJobsEnvelopeId

Obtiene el estado de flujo actual de un sobre determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de flujo
 flow-id True string

Identificador del flujo en cuestión

Devoluciones

Nombre Ruta de acceso Tipo Description
Token
 token string

Obtención del sobre por identificador

Id. de la operación:
GetEnvelopesEnvelopeId

Obtiene detalles de un sobre determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión

Devoluciones

Sobre
Envelope

Obtener archivo por identificador

Id. de la operación:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileId

Obtiene información sobre un archivo determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de documento
 document-id True string

Identificador del documento en cuestión
Id. de archivo
 file-id True string

Identificador del archivo en cuestión

Devoluciones

Archivo
File

Obtener archivos por identificador de documento

Id. de la operación:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Obtiene todos los archivos conectados a un documento determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de documento
 document-id True string

Identificador del documento en cuestión

Devoluciones

response
array of File

Obtener descriptor por identificador

Id. de la operación:
GetEnvelopeDescriptorsEnvelopeDescriptorId

Obtiene información de un descriptor determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador del descriptor de sobre
 envelope-descriptor-id True string

Identificador del descriptor de sobre

Devoluciones

Descriptor
Descriptor

Obtener documento por identificador

Id. de la operación:
GetEnvelopesEnvelopeIdDocumentsDocumentId

Obtiene información de un documento determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión
Id. de documento
 document-id True string

Identificador del documento en cuestión

Devoluciones

Documento
Document

Obtener todos los descriptores

Id. de la operación:
GetEnvelopeDescriptors

Obtiene una lista de todos los descriptores presentes en la empresa actual. Se puede filtrar la lista.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Filtros
 filters string

Filtrar consulta para seleccionar subamount

Devoluciones

response
array of Descriptor

Obtener todos los destinatarios del sobre

Id. de la operación:
GetEnvelopesEnvelopeIdRecipients

Obtiene todos los destinatarios de un sobre determinado.

Parámetros

Nombre Clave Requerido Tipo Description
Token
 token True string

Token recibido de la acción "Generar token de seguridad"
Id. de empresa
 x-namespace string

Identificador de empresa que se debe usar para la acción. Dar formato a /companies/<id. de> empresa. El valor predeterminado es el identificador de empresa de conexiones si no se establece.
Identificador de sobre
 envelope-id True string

Identificador del sobre en cuestión

Devoluciones

response
array of Recipient

Definiciones

Configuración

Nombre Ruta de acceso Tipo Description
Global
 global string
Idioma firmante
 preferences.signatoryLanguage string
Saludo
 preferences.greeting string
Método de firma
 preferences.signingMethod string
Desplazamiento de recordatorio
 preferences.reminderOffset string

Información de usuario

Nombre Ruta de acceso Tipo Description
Nombre
 givenName string
Apellido
 familyName string
Correo Electrónico
 email string
Language
 metadata.language string
Falta contraseña
 missingPassword boolean
Está habilitado
 isEnabled boolean
Namespace
 namespace string
Enabled
 enabled boolean
UID
 uid string
Id
 id string
Funciones
 roles array of Role
Validated
 validated boolean

Empresa

Nombre Ruta de acceso Tipo Description
Nombre
 name string
Reg. Number
 regNumber string
Creado
 created string
Modificada
 modified string
Dirección
 address string
City
 city string
Código postal
 zipCode string
Logotipo
 logo string
País
 country string
Uid
 uid string
Id
 id string

Destinatario

Nombre Ruta de acceso Tipo Description
UID
 uid string

UID del destinatario
Namespace
 namespace string

Espacio de nombres del destinatario
Creado
 created string

Destinatario creado
Rol
 role RoleActionString
Apellido
 familyName string

Apellidos del destinatario
Nombre
 givenName string

Nombre frist del destinatario
Language
 language string

Idioma del destinatario
Correo Electrónico
 email string

Correo electrónico del destinatario
Método de firma
 signingMethod string

Methid de firma de destinatarios
Notification (método)
 notificationMethod string
Pedido
 order integer

Orden del destinatario
Id
 id string

Id. de destinatario
Modificada
 modified string

Destinatario modificado
Notificado
 notified boolean
Completado
 completed boolean
demandAttachment
 demandAttachment boolean
SSN
 ssn string
Banco
 bank string
Secure
 secure boolean
SMS
 sms boolean
Teléfono
 telephone string
Firmas
 signatures object
Notifications
 notifications array of Notification

Rol

Nombre Ruta de acceso Tipo Description
Tipo
 action.type string
métodos
 action.methods array of string
Etiqueta
 label string

Etiqueta
Num. Máx.
 numMax integer

Num. Máx.
Num. Minuto
 numMin integer

Num. Minuto
Nombre del rol
 roleName string

RoleActionString

Nombre Ruta de acceso Tipo Description
Acción
 action ActionString

Acción
Etiqueta
 label string

Etiqueta
Num. Máx.
 numMax integer

Num. Máx.
Num. Minuto
 numMin integer

Num. Minuto
Nombre del rol
 roleName string

ActionString

Acción

Acción

Acción
string

Sobre

Nombre Ruta de acceso Tipo Description
Id
 id string

Identificador de sobre
UID
 uid string

UID de sobre
Namespace
 namespace string

Espacio de nombres de sobre
Versión
 version integer

Versión del sobre
Publicado
 published boolean

Sobre publicado
Completo
 completed boolean

Sobre completado
Anulada
 aborted boolean

Sobre avorted
Destrozado
 trashed boolean

Sobre papelera
Firma secuencial
 sequentialSigning boolean
Recordatorios de autenticación
 automaticReminders integer
Creado
 created string

Sobre creado
Modificada
 modified string

Sobre modificado
Caducado
 expired boolean

Sobre expirado
Flujo
 flow Flow
Descriptor
 descriptor Descriptor
Persona
 sender Person
Documentos
 documents array of Document
Recipientes
 recipients array of Recipient
Etiquetas
 tags array of object
Propietarios
 owners array of Person

EnvelopeDescriptorString

Nombre Ruta de acceso Tipo Description
Id
 id string

Identificador de sobre
UID
 uid string

UID de sobre
Namespace
 namespace string

Espacio de nombres de sobre
Versión
 version integer

Versión del sobre
Publicado
 published boolean

Sobre publicado
Completo
 completed boolean

Sobre completado
Anulada
 aborted boolean

Sobre avorted
Destrozado
 trashed boolean

Sobre papelera
Firma secuencial
 sequentialSigning boolean
Recordatorios de autenticación
 automaticReminders integer
Creado
 created string

Sobre creado
Modificada
 modified string

Sobre modificado
Caducado
 expired boolean

Sobre expirado
Flujo
 flow Flow
Descriptor
 descriptor string

Descriptor de sobre
Persona
 sender Person
Documentos
 documents array of Document
Recipientes
 recipients array of Recipient
Etiquetas
 tags array of object
Propietarios
 owners array of Person

Archivo

Nombre Ruta de acceso Tipo Description
Id
 id string

Id. de archivo
URL
 url string

Dirección URL del archivo
Nombre
 name string

Nombre de archivo
Tipo de mimo
 mimeType string
Tipo de archivo
 fileType string
Ruta de acceso de almacenamiento
 storagePath string
Cargado en
 uploadedAt string
Creado
 created string

Archivo creado
Propietarios
 owners array of object
UID
 owners.uid string

UID del propietario del archivo
Id
 owners._id string

Identificador del propietario del archivo
Namespace
 namespace string
UID
 uid string

UID de archivo

Flujo

Nombre Ruta de acceso Tipo Description
Id
 id string

Id. de flujo
Nombre
 name string

Nombre del flujo

Descriptor

Nombre Ruta de acceso Tipo Description
Nombre
 name string

Nombre del descriptor
Versión
 version integer

Versión del descriptor
UID
 uid string

Descriptor UID
Borrado
 deleted boolean

Descriptor Deletd
Público
 public boolean

Descriptor público
Caducado
 expired boolean

Descriptor expirado
Id
 id string

Identificador del descriptor
Mandatory
 mandatory boolean

Descriptor obligatorio
Etiqueta
 label string

Etiqueta de descriptor
Tipo
 type string

Tipo de descriptor
Funciones
 roles array of Role
Propietarios
 owners array of Person
Flujo
 flow Flow
valores predeterminados
 defaultValues DefaultValues

valores predeterminados
Instances
 instances array of object

Persona

Nombre Ruta de acceso Tipo Description
UID
 uid string

UID de persona
Nombre
 givenName string

Nombre de persona
Apellido
 familyName string

Apellidos de persona
Correo Electrónico
 email string

Correo electrónico de persona
Language
 language string

Idioma de la persona
Pedido
 order integer

Pedido de persona

Documento

Nombre Ruta de acceso Tipo Description
Etiqueta
 label string

Etiqueta de documento
Tipo
 type string

Tipo documento
Hash
 hash integer

Hash de documento
Num. Máx.
 numMax integer

Número de documento. Máx.
Num. Minuto
 numMin integer

Número de documento. Minuto
UID
 uid string

UID de documento
Namespace
 namespace string

Espacio de nombres de documento
Fuente
 source string

Origen del documento
Creado
 created string

Documento creado
Nombre
 name string

Nombre del documento
Id
 id string

Id. de documento
Modificada
 modified string

Documento modificado
Rejected
 rejected boolean

Documento rechazado
Signed
 signed boolean

Documento firmado
Destrozado
 trashed boolean

Documento papelera
Anulada
 aborted boolean

Documento anulado
Versión
 version integer

Versión del documento
attachments
 attachments array of Attachment
Flujo
 flow Flow
roles
 roles array of Role
Template
 template Template
Descriptor
 descriptor Descriptor
Firmas
 signatures array of Signature

Datos adjuntos

Nombre Ruta de acceso Tipo Description
Etiqueta
 label string

Etiqueta de datos adjuntos
Num. Máx.
 numMax integer

Número de datos adjuntos. Máx.
Num. Minuto
 numMin integer

Datos adjuntos Num.Min
Hash
 hash integer

Hash de datos adjuntos

Template

Nombre Ruta de acceso Tipo Description
Tipo
 type string

Tipo de plantilla
HTML
 html string
PDFHTML
 pdfHtml string
Id
 id string
UID
 uid string
Namespace
 namespace string
Versión
 version integer
Creado
 created string
Modificada
 modified string
Modificada
 published boolean
Completado
 completed boolean
Anulada
 aborted boolean

Signature

Nombre Ruta de acceso Tipo Description
identificación
 id string
Origen
 origin string
Nombre
 givenName string

Nombre
Apellido
 familyName string

Apellido
Correo Electrónico
 email string

Correo Electrónico
IP
 ip string
Fecha
 date string
Estado
 status string
Comentario
 comment string

DefaultValues

valores predeterminados

Nombre Ruta de acceso Tipo Description
Persona
 signer Person
Persona
 reviewer Person

Notification

Nombre Ruta de acceso Tipo Description
identificación
 id string
UID
 uid string
Namespace
 namespace string
Estado
 status string
Pedido
 order integer
Detalles
 details object
Fecha
 date string