PKIsigning (versión preliminar)
Automatice las necesidades de firma de documentos con el conector de la plataforma PKIsigning. Enviar documentos a la plataforma PKIsigning; enviar invitaciones y recuperar los documentos firmados.
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 | Compatibilidad con PKIsigning |
| URL | https://pkisigning.nl/support |
| Correo Electrónico | support@pkisigning.nl |
| Metadatos del conector | |
|---|---|
| Publicador | SBRS B.V. |
| Sitio web | https://pkisigning.nl |
| Directiva de privacidad | https://pkisigning.nl/privacy |
| Categorías | Colaboración; Productividad |
PKIsigning permite a las organizaciones automatizar, simplificar y proteger el proceso de aprobación, firma y envío de documentos a clientes y terceros. La plataforma admite todos los certificados de firma personal de eIDAS de proveedores de servicios de confianza calificados de Neerlandés y está certificado ISO27001. Esto hace que PKIsigning sea un socio ideal para organizaciones legales, financieras y sanitarias y gobiernos. Conéctese con PKisigning para automatizar, simplificar y proteger el proceso de firma de documentos.
Prerrequisitos
Para usar el conector PKIsigning, se requiere una cuenta para la plataforma PKIsigning dentro de una suscripción "profesional". Póngase en contacto con PKIsigning para registrarse en una suscripción de pago.
Obtención de credenciales
Después de registrarse para una suscripción, los usuarios recibirán un correo electrónico con una invitación para configurar su cuenta. Después de registrarse, esa cuenta se puede usar directamente con este conector.
Introducción al conector
El flujo predeterminado para iniciar la firma de documentos es el siguiente:
- Crear expediente
- Agregar documentos
- Agregar actores
- Iniciar flujo de trabajo
- Uso de un desencadenador para recibir notificaciones de los cambios de estado
- Descargar expediente
Expedientes
PKIsigning espera que siempre cree un expediente primero. Un expediente actúa como contenedor para documentos y actores. Se puede crear un expediente con la acción Dossiers_Create. Una vez creado un expediente, use el PkisId devuelto como referencia para futuras acciones.
Documentos
Una vez creado un expediente, puede agregar documentos con la acción de Documents_Add mediante el dossierId correcto. La acción no necesita ningún otro parámetro, ya que están distraídos de los propios archivos de documento. No hay límite para el número de documentos en un expediente. Todos los documentos serán visibles y descargables para todos los actores agregados.
Importante: El documento necesita uno o varios marcadores de posición textuales únicos, según el número de firmas, para indicar dónde debe colocarse una firma y por qué actor. Puede ser cualquier texto en cualquier lugar del documento. Al agregar actores, puede definir el marcador de posición con el parámetro de marcador de posición. Por ejemplo: signature1, signature2, etc...
Actors
El tercer paso consiste en agregar actores a los documentos. Esto se hace con la acción de Actor_Create utilizando el dossierId y documentId correctos.
Iniciar flujo de trabajo
Para iniciar un flujo de trabajo y enviar de forma eficaz invitaciones a todos los actores para firmar o descargar documentos en el orden proporcionado, use la acción Dossiers_StartWorkflow con el dossierId correcto.
Uso de un desencadenador para recibir notificaciones de los cambios de estado
Para obtener el documento una vez firmado, suscríbase las notificaciones mediante un desencadenador. Para recibir la notificación de estado, especifique "status" en el campo Eventos.
Descargar expediente
Cuando se notifica al desencadenador una actualización de estado, compruebe si el estado del documento es "Completado". En ese momento, es posible descargar todos los documentos del expediente en un solo archivo ZIP. Si se especifica en la configuración dentro de la plataforma PKIsigning, también se incluirá un audittrail.
Problemas y limitaciones conocidos
No se conoce ningún problema en el momento de la publicación.
Errores y soluciones comunes
Sin actualizaciones de estado a través del desencadenador
Si el desencadenador no responde a las actualizaciones de estado, compruebe si el valor "status" se proporcionó en el campo Eventos.
Error HTTP 402 Requerido de pago
La plataforma PKIsigning requiere créditos para realizar acciones. Cuando se agregan actores, los créditos se reservan para asegurarse de que la acción puede realizarse y las invitaciones no se enfrentan a problemas relacionados con un número insuficiente de créditos disponibles. Si se envían muchas invitaciones a actores, puede ocurrir que el paquete de crédito no tenga más créditos reservados. En ese momento, se devolverá un error HTTP 402.
Para resolver el problema, ya sea PKIsigning support to top-up the credit balance, or clean up any unsent dossiers with actors in the recyclebin on the platform. Los créditos sin usar volverán a estar disponibles.
Preguntas más frecuentes
Consulte nuestra base de conocimiento o póngase en contacto con nosotros en support@pkisigning.nl
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de solicitud |
Cambia los datos de una solicitud específica. |
| Actualizar actor |
Cambia los datos de un actor específico. |
| Actualizar documento |
Cambia los datos de un documento específico. |
| Creación de actor |
Crea un nuevo actor y lo agrega a un documento. |
| Crear documento |
Crea un nuevo documento y lo agrega a una solicitud específica. |
| Crear solicitud |
Cree una nueva solicitud. |
| Descargar solicitud |
Descarga una solicitud y su contenido como un archivo .zip. |
| Eliminar actor |
Elimina permanentemente un actor específico. |
| Eliminar documento |
Elimina permanentemente un documento específico. |
| Eliminar una solicitud |
Elimina permanentemente una solicitud específica. |
| Enviar solicitud |
Inicia el flujo de trabajo y envía una invitación al primer actor en línea para una solicitud específica. |
| Obtención de datos de actor |
Devuelve todos los datos de un actor específico. |
| Obtención de datos de actor por documento |
Devuelve todos los datos de todos los actores de un documento específico. |
| Obtención de datos de actor por solicitud |
Devuelve todos los datos de todos los actores de una solicitud específica. |
| Obtención de datos de solicitud |
Devuelve todos los datos (meta)para una solicitud específica. |
| Obtención de datos del documento |
Devuelve todos los datos (meta)para un documento específico. |
| Obtención de grupos de trabajo para el usuario |
Devuelve una lista de todos los grupos de trabajo para un usuario específico de una organización específica. |
| Obtención de grupos de trabajo para la organización |
Devuelve una lista de todos los grupos de trabajo de una organización específica. |
| Retirar invitación |
Retira la invitación para el actor actual en línea para una solicitud específica. |
| Volver a enviar invitación |
Vuelve a enviar la invitación para el actor actual en línea para una solicitud específica. |
Actualización de solicitud
Cambia los datos de una solicitud específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
Nombre de solicitud
|
name | True | string |
Nombre de una solicitud específica. |
|
Id. de grupo de trabajo
|
workgroupId | guid |
Identificador único de un grupo de trabajo. |
|
|
Nivel de autorización de seguridad
|
clearancelevel | True | integer |
Nivel de autorización de seguridad para una solicitud específica. |
|
Propietario de la solicitud
|
owner |
Usuario que es el propietario de una solicitud específica. |
Devoluciones
- Body
- RequestModel
Actualizar actor
Cambia los datos de un actor específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
Id. de documento
|
documentId | True | guid |
Identificador único de un documento. |
|
Id. de actor
|
actorId | True | guid |
Identificador único de un actor. |
|
Acción
|
action | True | string |
Acción que debe realizar el actor. |
|
Nombre
|
firstname | True | string |
Nombre del actor. |
|
Prefijo
|
prefix | string |
Prefijo del actor. |
|
|
Apellido
|
lastname | True | string |
Apellidos del actor. |
|
Dirección de correo electrónico
|
True | string |
Dirección de correo electrónico del actor. |
|
|
Número de teléfono móvil
|
mobile | True | string |
Número de teléfono móvil del actor. |
|
Fecha límite
|
deadline | True | date-time |
Fecha y hora en que el actor debe haber realizado la acción. |
|
Language
|
language | True | string |
Idioma de la invitación. |
|
Uso de la comprobación segura
|
validateRealIdentity | True | boolean |
Use un método más seguro de identificación para este actor. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
Mensaje
|
message | string |
Devoluciones
- Body
- ExtendedSignerModel
Actualizar documento
Cambia los datos de un documento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
Id. de documento
|
documentId | True | guid |
Identificador único de un documento. |
|
Nombre del documento
|
name | string |
Nombre de un documento específico |
|
|
Nombre del archivo de documento
|
filename | string |
Nombre de archivo de un documento específico |
|
|
Tipo de documento
|
documentType | True | string |
Tipo de un documento específico. (Por ejemplo, PDF normal, declaración fiscal, informe de auditores, etc.). |
Devoluciones
Metadatos generales del documento
Creación de actor
Crea un nuevo actor y lo agrega a un documento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
Id. de documento
|
documentId | True | guid |
Identificador único de un documento. |
|
Acción
|
action | True | string |
Acción que debe realizar el actor. |
|
Nombre
|
firstname | True | string |
Nombre del actor. |
|
Prefijo
|
prefix | string |
Prefijo del actor. |
|
|
Apellido
|
lastname | True | string |
Apellidos del actor. |
|
Dirección de correo electrónico
|
True | string |
Dirección de correo electrónico del actor. |
|
|
Número de teléfono móvil
|
mobile | True | string |
Número de teléfono móvil del actor. |
|
Fecha límite
|
deadline | True | date-time |
Fecha y hora en que el actor debe haber realizado la acción. |
|
Language
|
language | True | string |
Idioma de la invitación. |
|
Uso de la comprobación segura
|
validateRealIdentity | True | boolean |
Use un método más seguro de identificación para este actor. |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
Mensaje
|
message | string | ||
|
Campo firma
|
fieldName | string |
Nombre de un campo de firma existente en el documento para que este actor firme. |
|
|
Placeholder
|
placeholder | string |
Texto de un marcador de posición específico en el documento donde el actor debe colocar una firma. |
Devoluciones
- Body
- ExtendedSignerModel
Crear documento
Crea un nuevo documento y lo agrega a una solicitud específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud a la que pertenecerá este documento. |
|
Archivo
|
file | True | file |
Archivo que se va a procesar (solo tipos de archivo específicos). |
Devoluciones
Metadatos generales del documento
Crear solicitud
Cree una nueva solicitud.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de solicitud
|
name | True | string |
Nombre de una solicitud específica. |
|
Id. de grupo de trabajo
|
workgroupId | guid |
Identificador único de un grupo de trabajo. |
|
|
Nivel de autorización de seguridad
|
clearancelevel | True | integer |
Nivel de autorización de seguridad para una solicitud específica. |
|
Propietario de la solicitud
|
owner |
Usuario que es el propietario de una solicitud específica. |
Devoluciones
- Body
- RequestModel
Descargar solicitud
Descarga una solicitud y su contenido como un archivo .zip.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
Devoluciones
- response
- file
Eliminar actor
Elimina permanentemente un actor específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
Id. de documento
|
documentId | True | guid |
Identificador único de un documento. |
|
Id. de actor
|
actorId | True | guid |
Identificador único de un actor. |
Eliminar documento
Elimina permanentemente un documento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
Id. de documento
|
documentId | True | guid |
Identificador único de un documento. |
Eliminar una solicitud
Elimina permanentemente una solicitud específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
Enviar solicitud
Inicia el flujo de trabajo y envía una invitación al primer actor en línea para una solicitud específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
Obtención de datos de actor
Devuelve todos los datos de un actor específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
Id. de documento
|
documentId | True | guid |
Identificador único de un documento. |
|
Id. de actor
|
actorId | True | guid |
Identificador único de un actor. |
Devoluciones
- Body
- ExtendedSignerModel
Obtención de datos de actor por documento
Devuelve todos los datos de todos los actores de un documento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
Id. de documento
|
documentId | True | guid |
Identificador único de un documento. |
|
Acción completada
|
hasActed | boolean |
Solo devuelve actores que tengan o no hayan completado su acción, deje en blanco para devolver todos los actores. |
Devoluciones
- response
- array of ExtendedSignerModel
Obtención de datos de actor por solicitud
Devuelve todos los datos de todos los actores de una solicitud específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
¿Ha actuado el actor en la solicitud?
|
hasActed | boolean |
Valor de solo lectura para comprobar si un actor ya ha actuado en el documento. |
Devoluciones
- response
- array of ExtendedSignerModel
Obtención de datos de solicitud
Devuelve todos los datos (meta)para una solicitud específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
Clave de autenticación
|
callbackAuthenticationKey | string |
Clave de autenticación proporcionada por el desencadenador. |
Devoluciones
- Body
- RequestModel
Obtención de datos del documento
Devuelve todos los datos (meta)para un documento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
|
Id. de documento
|
documentId | True | guid |
Identificador único de un documento. |
Devoluciones
Metadatos generales del documento
Obtención de grupos de trabajo para el usuario
Devuelve una lista de todos los grupos de trabajo para un usuario específico de una organización específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de organización
|
organisationId | True | guid |
Identificador único de una organización. |
|
Nombre de usuario
|
username | True |
Emailaddress del usuario |
Devoluciones
- response
- array of OrganisationWorkgroup
Obtención de grupos de trabajo para la organización
Devuelve una lista de todos los grupos de trabajo de una organización específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de organización
|
organisationId | True | guid |
Identificador único de una organización. |
Devoluciones
- response
- array of OrganisationWorkgroup
Retirar invitación
Retira la invitación para el actor actual en línea para una solicitud específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
Volver a enviar invitación
Vuelve a enviar la invitación para el actor actual en línea para una solicitud específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de solicitud
|
requestId | True | guid |
Identificador único de una solicitud. |
Desencadenadores
| Cuando se produce un evento en una solicitud |
Registre una dirección URL para la devolución de llamada tras un cambio de estado. La plataforma PKIsigning notificará las actualizaciones de estado de los expedientes de esta organización a esta dirección URL. |
Cuando se produce un evento en una solicitud
Registre una dirección URL para la devolución de llamada tras un cambio de estado. La plataforma PKIsigning notificará las actualizaciones de estado de los expedientes de esta organización a esta dirección URL.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipos de evento
|
Events | True | array of string |
Lista de tipos de eventos que se producen en una solicitud de la que se notificará a este desencadenador. |
|
Id. de organización
|
organisationId | True | guid |
Identificador único de una organización. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de solicitud
|
PkisId | guid |
Identificador único de una solicitud. |
|
Estado de la solicitud
|
DossierStatus | string |
Estado del expediente. |
|
Motivo
|
Reason | string |
Motivo del cambio. |
|
Clave de autenticación
|
AuthenticationKey | string |
Encabezado para obtener metadatos en la solicitud. |
Definiciones
ExtendedSignerModel
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Campo firma
|
fieldName | string |
Nombre de un campo de firma existente en el documento para que este actor firme. |
|
Placeholder
|
placeholder | string |
Texto de un marcador de posición específico en el documento donde el actor debe colocar una firma. |
|
Acción
|
action | string |
Acción que debe realizar el actor. |
|
Nombre
|
firstname | string |
Nombre del actor. |
|
Prefijo
|
prefix | string |
Prefijo del actor. |
|
Apellido
|
lastname | string |
Apellidos del actor. |
|
Dirección de correo electrónico
|
string |
Dirección de correo electrónico del actor. |
|
|
Número de teléfono móvil
|
mobile | string |
Número de teléfono móvil del actor. |
|
Fecha límite
|
deadline | date-time |
Fecha y hora en que el actor debe haber realizado la acción. |
|
Language
|
language | string |
Idioma de la invitación. |
|
Uso de la comprobación segura
|
validateRealIdentity | boolean |
Use un método más seguro de identificación para este actor. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
Mensaje
|
message | string | |
|
Id. de actor
|
id | guid |
Identificador único de un actor específico. |
|
Fecha de finalización
|
signingDate | date-time |
Fecha y hora en que el actor ha realizado su acción. |
|
Acción completada
|
hasSigned | boolean | |
|
Nombre completo
|
fullName | string |
Nombre combinado, prefijo y apellido del actor. |
|
Información de estado
|
emailActivity | array of EmailActivity |
Información de estado sobre el proceso de realización de la acción por parte del actor. |
|
documentId
|
documentId | guid |
EmailActivity
Metadatos del mensaje de correo electrónico que se envían a un actor
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Actividad de correo electrónico
|
event | string |
Actividad de correo electrónico para una solicitud y un actor específicos. |
|
Información de SMTP
|
reason | string |
Información SMTP de un correo electrónico enviado a un actor específico como parte de una solicitud. |
|
Fecha de correo electrónico
|
timestamp | date-time |
Fecha de un correo electrónico enviado a un actor específico como parte de una solicitud. |
|
Tipo de correo electrónico
|
pkisMessageType | string |
Escriba un correo electrónico enviado a un actor específico como parte de una solicitud (por ejemplo, Invitar, Recordatorio, etc.). |
|
Identificador de solicitud de correo electrónico
|
pkisInviteId | string |
Identificador único de un correo electrónico enviado a un actor específico como parte de una solicitud. |
|
Dirección de correo electrónico
|
string |
Dirección de correo electrónico de un correo electrónico enviado a un actor específico como parte de una solicitud. |
SignerModel
Tipo especial de actor
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Acción
|
action | string |
Acción que debe realizar el actor. |
|
Nombre
|
firstname | string |
Nombre del actor. |
|
Prefijo
|
prefix | string |
Prefijo del actor. |
|
Apellido
|
lastname | string |
Apellidos del actor. |
|
Dirección de correo electrónico
|
string |
Dirección de correo electrónico del actor. |
|
|
Número de teléfono móvil
|
mobile | string |
Número de teléfono móvil del actor. |
|
Fecha límite
|
deadline | date-time |
Fecha y hora en que el actor debe haber realizado la acción. |
|
Language
|
language | string |
Idioma de la invitación. |
|
Uso de la comprobación segura
|
validateRealIdentity | boolean |
Use un método más seguro de identificación para este actor. |
|
dossierPersonId
|
dossierPersonId | integer | |
|
Mensaje
|
message | string | |
|
Campo firma
|
fieldName | string |
Nombre de un campo de firma existente en el documento para que este actor firme. |
|
Placeholder
|
placeholder | string |
Texto de un marcador de posición específico en el documento donde el actor debe colocar una firma. |
DocumentMetaDataModel
Metadatos generales del documento
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre del documento
|
name | string |
Nombre de un documento específico. |
|
Última actualización del documento
|
lastUpdate | date-time |
Fecha de la última actualización de un documento específico. |
|
Número de páginas de documento
|
pages | integer |
Número de páginas de un documento específico. |
|
Fecha de creación del documento
|
created | date-time |
Fecha de creación de un documento específico. |
|
Id. de documento
|
id | guid |
Identificador único de un documento. |
|
Estado del documento
|
status | string |
Estado de un documento específico. (Por ejemplo, nuevo, completado, etc.). |
|
El documento contiene la firma
|
signed | boolean |
Indica si un documento específico ya contiene una o varias firmas. |
|
Firmas de documento
|
signatures | array of SignatureData |
Lista de todas las firmas de un documento específico. |
|
Campos de firma en blanco del documento
|
emptySignatureFields | array of SignatureField |
Lista de todos los campos de firma vacíos para un documento específico. |
|
Campos de firma en blanco
|
containsBlankSignatureFields | boolean |
Indica si un documento específico contiene campos de firma en blanco. |
|
Actores de documentos
|
actors | array of ExtendedSignerModel |
Lista de todos los actores de un documento específico. |
|
Id. de solicitud
|
requestId | guid |
Identificador único de una solicitud. |
|
Índice de solicitud
|
dossierIndex | integer |
Índice de todos los documentos que pertenecen a una solicitud específica. |
|
documentSize
|
documentSize | integer |
Tamaño de un documento que pertenece a una solicitud específica. |
|
documentType
|
documentType | string |
Tipo de documento que pertenece a una solicitud específica. |
SignatureData
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Campos de asunto del certificado
|
subject | array of KeyValuePairOfStringAndString |
Campos de la línea de asunto del certificado usado para una firma específica. |
|
Campos del emisor de certificados
|
issuer | array of KeyValuePairOfStringAndString |
Campos de la línea del emisor del certificado usado para una firma específica. |
|
Fecha de firma
|
date | date-time |
Fecha y hora en que se ha colocado una firma específica. |
|
Ubicación de firma
|
location | string |
Ubicación geográfica de un actor específico en el momento de la firma. |
|
Motivo de firma
|
reason | string |
Motivo de la firma según lo proporcionado por un actor específico en el momento de la firma. |
|
Firma electrónica calificada
|
euQualified | boolean |
Indica si una firma específica está calificada (QeS) conforme a las regulaciones de eIDAS. |
|
Firma electrónica avanzada
|
advanced | boolean |
Indica si una firma específica es avanzada (AeS) conforme a las regulaciones de eIDAS. |
|
ESeal completo
|
eSeal | boolean |
Indica si un certificado específico que se usa para firmar o sellar es un reglamento eIDAS calificado conforme a eIDAS. |
|
Dirección IP del actor
|
ipAddress | string |
Dirección IP de un actor específico |
|
Campo Firma
|
signatureField | string |
Campo que se ha firmado |
|
Imagen de firma
|
signatureImage | string |
Archivo de imagen que se usó para una firma específica elegida por un actor. |
KeyValuePairOfStringAndString
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
key
|
key | string | |
|
value
|
value | string |
SignatureField
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre del campo de firma
|
name | string |
Nombre de un campo de firma específico |
|
Página campo firma
|
page | integer |
Página donde se coloca un campo de firma específico para un documento específico. |
|
Coordenada de ancho de campo de firma
|
x | double |
Valor de ancho de la posición de un campo de firma específico en relación con la página que se coloca en un documento específico. |
|
Coordenada alta del campo de firma
|
y | double |
Valor alto de la posición de un campo de firma específico en relación con la página que se coloca en un documento específico. |
|
Hight de campo de firma
|
height | double |
Valor alto para un campo de firma específico. |
|
Ancho de campo de firma
|
width | double |
Valor de ancho de un campo de firma específico. |
OrganisationWorkgroup
Un grupo de trabajo que se utiliza dentro de un expediente
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de grupo de trabajo
|
id | guid |
Identificador único de un grupo de trabajo |
|
Nombre del grupo de trabajo
|
name | string |
Nombre de un grupo de trabajo específico |
RequestModel
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de solicitud
|
id | guid |
Identificador único de una solicitud |
|
Nombre de solicitud
|
dossierName | string |
Nombre de una solicitud específica. |
|
Solicitud de documentos
|
documents | array of DocumentModel |
Lista de documentos incluidos en esta solicitud. |
|
Estado de la solicitud
|
status | string |
Estado de una solicitud específica. (Por ejemplo, nuevo, completado, etc.). |
|
Solicitar actores
|
actors | array of ExtendedSignerModel |
Lista de todos los actores para una solicitud específica. |
|
Firmas de documento
|
signatures | array of SignatureData |
Lista de todas las firmas de una solicitud específica. |
|
Tipo de solicitud
|
dossierType | string |
Tipo de una solicitud específica. (E.g. PDF, SBR Assurance, etc.). |
|
Motivo de cancelación
|
reasons | string |
Motivo de cancelación de una solicitud específica por parte de un usuario o un actor. |
|
Nota del firmante
|
signerNote | string |
Tenga en cuenta que uno o varios actores que no tienen ninguna otra acción que firmar. |
|
Nota del destinatario
|
recipientNote | string |
Nota para uno o varios actores que no tienen ninguna otra acción que descargar. |
|
Nota del aprobador
|
accorderNote | string |
Tenga en cuenta que uno o varios actores que no tienen ninguna otra acción que aprobar la solicitud. |
|
Fecha de expiración de la solicitud
|
expires | date-time |
Fecha y hora de expiración de una solicitud específica. |
|
Información de estado
|
emailActivity | array of EmailActivity |
Información de estado sobre el proceso de realización de la acción por parte del actor. |
|
Mi solicitud
|
myDossier | boolean |
Indica si es el propietario de una solicitud específica. |
|
Id. de grupo de trabajo
|
workgroup | guid |
Identificador único de un grupo de trabajo. |
|
Nivel de autorización de seguridad
|
clearancelevel | integer |
Nivel de autorización de seguridad para una solicitud específica. |
DocumentModel
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de documento
|
id | guid |
Identificador único de un documento |
|
Nombre del documento
|
name | string |
Nombre de un documento específico |
|
Tipo de documento
|
documentType | string |
Escriba para un documento específico. |
|
Índice de solicitud
|
dossierIndex | integer |
Índice de todos los documentos que pertenecen a una solicitud específica. |
|
Estado del documento
|
documentstatus | string |
Estado de un documento específico. (Por ejemplo, nuevo, completado, etc.). |
|
Actores de documentos
|
actors | array of SignerModel |
Lista de todos los actores de un documento específico. |
archivo
Este es el tipo de datos básico "file".