Certinal eSign (Pré-visualização)
A Certinal eSign permite às empresas enviar, assinar e gerir documentos de forma segura com assinaturas eletrónicas em conformidade global. Concebida para indústrias reguladas, a Certinal fornece rastreamento de fluxos de trabalho em tempo real, registos de auditoria à prova de adulteração e automação fluida. Use o Certinal eSign nos seus fluxos de trabalho para digitalizar aprovações, acelerar processos e garantir assinaturas legalmente válidas em 70+ países.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Ajuda e Apoio |
| URL | https://www.certinal.com/department/esignature-for-support |
| tech-support@certinal.com |
| Metadados do conector | |
|---|---|
| Editora | Certinal Inc. |
| Sítio Web | https://www.certinal.com/ |
| Política de privacidade | https://www.certinal.com/privacy-policy |
| Categorias | Produtividade; Gestão Empresarial |
Certinal eSign
Visão geral
A Certinal eSign oferece-lhe fluxos de trabalho seguros e compatíveis de eSignature e eConsent para empresas globais — enviar, assinar, acompanhar e gerir documentos diretamente a partir do Power Automate.
Pré-requisitos
Precisas de ter uma conta Certinal Admin para usares o gatilho do Connector. Para usar o gatilho Connector nesta integração, o Power Connector deve estar ativado nas definições do Certinal Admin.
Como obter credenciais
A Certinal utiliza a chave API para autenticar os serviços. Tens de gerar a chave API a partir da conta do Certinal Admin.
Operações suportadas
O conector suporta as seguintes operações:
Obtenha Detalhes da Transação
Obtenha os detalhes da transação por ID da transação
Descarregar Documentos para Transação
Descarregar Documentos para o Identificador de Transação Indicado
Criar transação
Criar transação
Criar Transação Usando Modelo
Criar Transação usando um ID de modelo dado
Lista de Utilizadores
Lista de Utilizadores
Obter Dados de Utilizador
Obtenha Dados de Utilizador para o ID de Utilizador Específico
Criar Utilizador
Criar Utilizador
Gatilhos suportados
O conector suporta os seguintes gatilhos:
Quando o Estado de uma Transação é Alterado
Registar um callback para um evento de transação específico
Documentos API:
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
Ajuda e Apoio
https://esign.certinal.com/esign/certinal-docs/help-support
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | securestring | A chave de API para esta api | Verdade |
| Base API Endpoint | cadeia (de caracteres) | A URL base do endpoint da API (por exemplo, api.certinal.com) | Verdade |
Limites de Limitação
| Nome | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Criar transação |
Criar transação |
| Criar Transação Usando Modelo |
Criar Transação usando um ID de modelo dado |
| Criar Utilizador |
Criar Utilizador |
| Descarregar Documentos para Transação |
Descarregar Documentos para o Identificador de Transação Indicado |
| Eliminar Subscrição |
Eliminar Subscrição |
| Lista de Utilizadores |
Lista de Utilizadores |
| Obtenha Detalhes da Transação |
Obtenha os detalhes da transação por ID da transação |
| Obter Dados de Utilizador |
Obtenha Dados de Utilizador para o ID de Utilizador Específico |
Criar transação
Criar transação
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Nome da Transação
|
name | True | string |
Nome da Transação |
|
Message
|
message | string |
Mensagem para todos os participantes por email. |
|
|
URL de retorno de chamada
|
url | string |
URL de retorno de chamada |
|
|
Eventos da Transação
|
transactionEvents | array of string |
Eventos da Transação |
|
|
Eventos Participantes
|
participantEvents | array of string |
Eventos Participantes |
|
|
Estado da Transação
|
status | string |
Estado da Transação |
|
|
Identificação externa
|
externalId | string |
Identificação externa |
|
|
Expira com carimbo temporal
|
expiresAtTimestamp | string |
Transação expira com carimbo temporal |
|
|
Relembrar a partir do carimbo temporal
|
remindFromTimestamp | string |
Relembrar a partir do carimbo temporal |
|
|
Frequência do lembrete
|
reminderFrequency | integer |
Frequência do Lembrete |
|
|
Campos predefinidos
|
default | boolean |
Campos de bloco de assinatura por defeito |
|
|
Sequência de participantes
|
sequence | integer |
Sequence |
|
|
Funções
|
role | string |
Funções |
|
|
Nome
|
name | string |
Nome do Candidato |
|
|
Endereço de E-mail
|
emailAddress | string |
Endereço de Email do Candidato |
|
|
Linguagem
|
language | string |
Linguagem |
|
|
Modo de Autenticação
|
authenticationMode | string |
Modo de Autenticação |
|
|
Valor do Modo de Autenticação
|
authenticationModeValue | string |
Valor do Modo de Autenticação |
|
|
Canais de Distribuição
|
deliveryChannels | array of string |
Canais de Distribuição |
|
|
ID do campo
|
fieldId | string |
ID do campo |
|
|
Páginas
|
pages | array of string |
Páginas |
|
|
ID do documento
|
documentId | string |
ID do documento |
|
|
Largura do campo
|
width | float |
Largura do campo |
|
|
Altura do campo
|
height | float |
Altura do campo |
|
|
Dica de ferramenta
|
tooltip | string |
Dica de ferramenta |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Contagem de Linhas da Área de Texto
|
textareaLineCount | string |
Contagem de Linhas da Área de Texto |
|
|
Nome do campo
|
fieldName | string |
Nome do campo |
|
|
Posição X
|
xposition | float |
X Posição do campo |
|
|
Posição Y
|
yposition | float |
Posição Y do campo |
|
|
É obrigatório?
|
required | boolean |
Isto é uma área obrigatória? |
|
|
É só leitura?
|
readOnly | boolean |
Isto é uma área de Leitura Só? |
|
|
Área de Texto
|
textarea | boolean |
Área de Texto |
|
|
Topo Inferior
|
topBottom | boolean |
Topo Inferior |
|
|
Verticais
|
vertical | boolean |
Verticais |
|
|
Radio Group Id
|
radioGroupId | string |
Radio Group Id |
|
|
Valor padrão
|
defaultValue | string |
Valor padrão |
|
|
Valor
|
value | string |
Valor |
|
|
Etiqueta de Exibição
|
displayLabel | string |
Etiqueta de Exibição |
|
|
Nome
|
name | string |
Nome |
|
|
Endereço de E-mail
|
emailAddress | string |
Endereço de E-mail |
|
|
Linguagem
|
language | string |
Linguagem |
|
|
ID do documento
|
id | string |
ID do documento |
|
|
Sequence
|
sequence | integer |
Sequence |
|
|
É eliminável?
|
deletable | boolean |
É eliminável? |
|
|
É privado
|
private | boolean |
É privado |
|
|
Valor de Campo
|
value | string |
Valor de Campo |
|
|
Nome do campo
|
fieldName | string |
Nome do campo |
|
|
Código
|
code | string |
Código |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Data e Hora
|
timestamp | integer |
Data e Hora |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
ID da Transação
|
data.transactionId | string |
ID da Transação |
Criar Transação Usando Modelo
Criar Transação usando um ID de modelo dado
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Nome da Transação
|
name | string |
Nome da Transação |
|
|
Estado da Transação
|
status | string |
Estado da Transação |
|
|
Identificação externa
|
externalId | string |
Identificação externa |
|
|
ID do modelo
|
templateId | string |
ID do modelo |
|
|
IDs de Modelos Secundários
|
secondaryTemplateIds | array of string |
IDs de Modelos Secundários |
|
|
Message
|
message | string |
Mensagem para todos os participantes por email. |
|
|
URL de retorno de chamada
|
url | string |
URL de retorno de chamada |
|
|
Eventos da Transação
|
transactionEvents | array of string |
Eventos da Transação |
|
|
Eventos Participantes
|
participantEvents | array of string |
Eventos Participantes |
|
|
Sequência de participantes
|
sequence | integer |
Sequence |
|
|
Funções
|
role | string |
Funções |
|
|
O Auto Process é?
|
autoProcess | boolean |
O Auto Process é? |
|
|
Nome do campo
|
fieldName | string |
Nome do campo |
|
|
Valor de Campo
|
value | string |
Valor de Campo |
|
|
Nome
|
name | string |
Nome do Candidato |
|
|
Endereço de E-mail
|
emailAddress | string |
Endereço de Email do Candidato |
|
|
Message
|
message | string |
Message |
|
|
Linguagem
|
language | string |
Linguagem |
|
|
Canais de Distribuição
|
deliveryChannels | array of string |
Canais de Distribuição |
|
|
Corpo SMS Personalizado
|
customSMSBody | string |
Corpo SMS Personalizado |
|
|
Nome
|
name | string |
Nome |
|
|
Message
|
message | string |
Message |
|
|
É obrigatório?
|
required | boolean |
É obrigatório? |
|
|
Nome
|
name | string |
Nome |
|
|
Endereço de E-mail
|
emailAddress | string |
Endereço de E-mail |
|
|
Linguagem
|
language | string |
Linguagem |
|
|
Valor de Campo
|
value | string |
Valor de Campo |
|
|
Nome do campo
|
fieldName | string |
Nome do campo |
|
|
Código
|
code | string |
Código |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Data e Hora
|
timestamp | integer |
Data e Hora |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
ID da Transação
|
data.transactionId | string |
ID da Transação |
Criar Utilizador
Criar Utilizador
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Endereço de E-mail
|
emailAddress | string |
Endereço de E-mail |
|
|
Nome Próprio
|
firstName | string |
Nome Próprio |
|
|
Apelido
|
lastName | string |
Apelido |
|
|
Empresa
|
company | string |
Empresa |
|
|
Fuso horário
|
timezone | string |
Fuso horário |
|
|
Linguagem
|
language | string |
Linguagem |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Saudação
|
salutation | string |
Saudação |
|
|
Cargo
|
jobTitle | string |
Cargo |
|
|
Número de Telefone
|
phoneNumber | string |
Número de Telefone |
|
|
Código do país
|
phoneCountryCode | string |
Código do país |
|
|
Funções
|
roles | array of string |
Funções |
|
|
O Final Mail está desativado?
|
finalMailDisabled | boolean |
O Final Mail está desativado? |
|
|
O Lembrete de Correio está desativado?
|
reminderMailDisabled | boolean |
O Lembrete de Correio está desativado? |
|
|
O correio do remetente está desativado?
|
senderMailDisabled | boolean |
O correio do remetente está desativado? |
|
|
A integração é utilizadora?
|
integrationUser | boolean |
A integração é utilizadora? |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Data e Hora
|
timestamp | integer |
Data e Hora |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
ID de Utilizador
|
data.user_id | string |
ID de Utilizador |
Descarregar Documentos para Transação
Descarregar Documentos para o Identificador de Transação Indicado
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da Transação
|
transactionId | True | string |
O ID Único da Transação |
|
Tipo de documento
|
documentType | True | string |
Tipo de Documento a Descarregar |
Regressos
- response
- file
Eliminar Subscrição
Eliminar Subscrição
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Webhook Id
|
webhookId | True | string |
O identificador único da subscrição do webhook para eliminar |
Lista de Utilizadores
Lista de Utilizadores
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Número da página
|
pageNo | True | integer | |
|
Registos por Página
|
perPageRecords | True | integer |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Data e Hora
|
timestamp | integer |
Data e Hora |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Total de Registos
|
data.totalRecords | integer |
Total de registos |
|
Total de Páginas
|
data.totalPages | integer |
Total de Páginas |
|
Registos por Página
|
data.perPageRecords | integer |
Registos por Página |
|
Número da página
|
data.pageNo | integer |
Número da página |
|
Registos
|
data.records | array of object |
Registos de Utilizadores |
|
Nome Próprio
|
data.records.firstName | string |
Nome Próprio |
|
Apelido
|
data.records.lastName | string |
Apelido |
|
Empresa
|
data.records.company | string |
Empresa |
|
Fuso horário
|
data.records.timezone | string |
Fuso horário |
|
Linguagem
|
data.records.language | string |
Linguagem |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
Cargo
|
data.records.jobTitle | string |
Cargo |
|
Número de Telefone
|
data.records.phoneNumber | string |
Número de Telefone |
|
Código do país
|
data.records.phoneCountryCode | string |
Código do país |
|
Funções
|
data.records.roles | array of string |
Funções |
|
O Final Mail está desativado?
|
data.records.finalMailDisabled | boolean |
O Final Mail está desativado? |
|
O Lembrete de Correio está desativado?
|
data.records.reminderMailDisabled | boolean |
O Lembrete de Correio está desativado? |
|
O correio do remetente está desativado?
|
data.records.senderMailDisabled | boolean |
O correio do remetente está desativado? |
|
A integração é utilizadora?
|
data.records.integrationUser | boolean |
A integração é utilizadora? |
|
Saudação
|
data.records.salutation | string |
Saudação |
|
Está ativo
|
data.records.active | boolean |
Está ativo |
|
Id
|
data.records.id | string |
Id |
|
Endereço de E-mail
|
data.records.emailAddress | string |
Endereço de E-mail |
Obtenha Detalhes da Transação
Obtenha os detalhes da transação por ID da transação
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID da Transação
|
transactionId | True | string |
O ID Único da Transação |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Data e Hora
|
timestamp | integer |
Data e Hora |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Nome da Transação
|
data.name | string |
Nome da Transação |
|
Estado da Transação
|
data.status | string |
Estado da Transação |
|
ID da Transação
|
data.transactionId | string |
ID da Transação |
|
Message
|
data.mail.message | string |
Mensagem para todos os participantes por email. |
|
Data da última atualização
|
data.lastUpdatedDate | string |
Data da última atualização |
|
Data de criação
|
data.createdDate | string |
Data de criação |
|
ID de Utilizador
|
data.createdBy.id | string |
Criado por ID de Utilizador |
|
Nome de utilizador
|
data.createdBy.username | string |
Criado por nome de utilizador |
|
Endereço de E-mail
|
data.createdBy.emailAddress | string |
Criado por Endereço de Email |
|
Data de envio
|
data.sentDate | string |
Data de envio |
|
ID de Utilizador
|
data.lastActionPerformedBy.userId | string |
ID de Utilizador |
|
Nome de Utilizador
|
data.lastActionPerformedBy.userName | string |
Nome de Utilizador |
|
Endereço de E-mail
|
data.lastActionPerformedBy.emailAddress | string |
Endereço de E-mail |
|
Identificação do Candidato
|
data.lastActionPerformedBy.candidateId | string |
Identificação do Candidato |
|
ID do participante
|
data.lastActionPerformedBy.participantId | string |
ID do participante |
|
Expira com carimbo temporal
|
data.expiryAndReminders.expiresAtTimestamp | string |
Transação expira com carimbo temporal |
|
Dias de Validade
|
data.expiryAndReminders.expiryDays | integer |
Dias de Validade |
|
Dias de Recordação
|
data.expiryAndReminders.remindFromReminderDays | integer |
Dias de Recordação |
|
Relembrar da Hora do Lembrete
|
data.expiryAndReminders.remindFromReminderTime | string |
Relembrar da Hora do Lembrete |
|
Frequência do lembrete
|
data.expiryAndReminders.reminderFrequency | integer |
Frequência do Lembrete |
|
Participantes
|
data.participants | array of object |
Participantes |
|
ID do participante
|
data.participants.id | string |
ID do participante |
|
Estatuto de Participante
|
data.participants.status | string |
Estatuto de Participante |
|
Data da última atualização
|
data.participants.lastUpdatedDate | string |
Data da última atualização |
|
Data de criação
|
data.participants.createdDate | string |
Data de criação |
|
Sequência de participantes
|
data.participants.sequence | integer |
Sequence |
|
Funções
|
data.participants.role | string |
Funções |
|
Método de Assinatura
|
data.participants.signingMethodDTO | array of string |
Detalhes do Método de Assinatura |
|
Submetido pelo Utilizador
|
data.participants.submittedBys | array of object |
Submetido pelos Dados do Utilizador |
|
ID de Utilizador
|
data.participants.submittedBys.userId | string |
Submetido pelo ID do Utilizador |
|
Nome de Utilizador
|
data.participants.submittedBys.userName | string |
Submetido pelo Nome do Utilizador |
|
Endereço de E-mail
|
data.participants.submittedBys.emailAddress | string |
Submetido pelo endereço de email do utilizador |
|
Identificação do Candidato
|
data.participants.submittedBys.candidateId | string |
Identificação do Candidato |
|
Candidatos
|
data.participants.candidates | array of object |
Candidatos |
|
Identificação do Candidato
|
data.participants.candidates.id | string |
Identificação do Candidato |
|
Nome
|
data.participants.candidates.name | string |
Nome do Candidato |
|
Endereço de E-mail
|
data.participants.candidates.emailAddress | string |
Endereço de Email do Candidato |
|
Linguagem
|
data.participants.candidates.language | string |
Linguagem |
|
Tipo
|
data.participants.candidates.type | string |
Tipo |
|
Ação
|
data.participants.candidates.action | string |
Ação |
|
Data de Ação
|
data.participants.candidates.actionDate | string |
Data de Ação |
|
Data de criação
|
data.participants.candidates.createdDate | string |
Data de criação |
|
Valor do Modo de Autenticação
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Valor do Modo de Autenticação |
|
Detalhes do método de assinatura
|
data.participants.candidates.signingMethodDTO | array of string |
Detalhes do método de assinatura |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Canais de Distribuição
|
data.participants.candidates.deliveryChannels | array of string |
Canais de Distribuição |
|
Campos
|
data.participants.fields | array of object |
Campos |
|
Id
|
data.participants.fields.id | string |
Id |
|
Data da última atualização
|
data.participants.fields.lastUpdatedDate | string |
Data da última atualização |
|
Data de criação
|
data.participants.fields.createdDate | string |
Data de criação |
|
ID do campo
|
data.participants.fields.fieldId | string |
ID do campo |
|
N.º da página
|
data.participants.fields.pageNo | integer |
N.º da página |
|
ID do documento
|
data.participants.fields.documentId | string |
ID do documento |
|
Largura do campo
|
data.participants.fields.width | float |
Largura do campo |
|
Altura do campo
|
data.participants.fields.height | float |
Altura do campo |
|
Dica de ferramenta
|
data.participants.fields.tooltip | string |
Dica de ferramenta |
|
Valor
|
data.participants.fields.value | string |
Valor |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NomeEstilo
|
data.participants.fields.nameStyle | string |
NomeEstilo |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Etiqueta de Exibição
|
data.participants.fields.displayLabel | string |
Etiqueta de Exibição |
|
Tipo de link
|
data.participants.fields.linkType | string |
Tipo de link |
|
Radio Id
|
data.participants.fields.radioId | integer |
Radio Id |
|
Radio Group Id
|
data.participants.fields.radioGroupId | string |
Radio Group Id |
|
ID de Caixa de Seleção
|
data.participants.fields.checkboxId | integer |
ID de Caixa de Seleção |
|
Nome do campo
|
data.participants.fields.fieldName | string |
Nome do campo |
|
Posição X
|
data.participants.fields.xposition | float |
X Posição do campo |
|
Posição Y
|
data.participants.fields.yposition | float |
Posição Y do campo |
|
É obrigatório?
|
data.participants.fields.required | boolean |
Isto é uma área obrigatória? |
|
É só leitura?
|
data.participants.fields.readOnly | boolean |
Isto é uma área de Leitura Só? |
|
Área de Texto
|
data.participants.fields.textarea | boolean |
Área de Texto |
|
Verticais
|
data.participants.fields.vertical | boolean |
Verticais |
|
Topo Inferior
|
data.participants.fields.topBottom | boolean |
Topo Inferior |
|
Valor padrão
|
data.participants.fields.defaultValue | string |
Valor padrão |
|
Formato
|
data.participants.signatureBlock.format | array of object |
Formato |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
É obrigatório?
|
data.participants.signatureBlock.format.required | boolean |
É obrigatório? |
|
Predefinido
|
data.participants.signatureBlock.default | boolean |
Predefinido |
|
Permitir Delegar
|
data.participants.enableDelegate | boolean |
Permitir Delegar |
|
Processo Automóvel
|
data.participants.autoProcess | boolean |
Processo Automóvel |
|
Utilizadores do CC
|
data.ccUsers | array of object |
Utilizadores do CC |
|
Nome
|
data.ccUsers.name | string |
Nome |
|
Endereço de E-mail
|
data.ccUsers.emailAddress | string |
Endereço de E-mail |
|
Linguagem
|
data.ccUsers.language | string |
Linguagem |
|
Documents
|
data.documents | array of object |
Documents |
|
ID do documento
|
data.documents.id | string |
ID do documento |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
Nome do arquivo
|
data.documents.fileName | string |
Nome do arquivo |
|
Contagem de páginas
|
data.documents.pageCount | integer |
Contagem de páginas |
|
É eliminável?
|
data.documents.deletable | boolean |
É eliminável? |
|
É privado
|
data.documents.private | boolean |
É privado |
|
Campos personalizados
|
data.customFields | array of object |
Campos personalizados |
|
ID de campo personalizado
|
data.customFields.customFieldId | string |
ID de campo personalizado |
|
Valor de Campo
|
data.customFields.value | string |
Valor de Campo |
|
Nome do campo
|
data.customFields.fieldName | string |
Nome do campo |
|
Tipo de campo
|
data.customFields.fieldType | string |
Tipo de campo |
|
Subscrições de notificação
|
data.notificationSubscriptions | array of |
Subscrições de notificação |
|
tags
|
data.tags | array of |
tags |
|
Documentos Adicionais
|
data.additionalDocuments | array of object |
Documentos Adicionais |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
Nome do arquivo
|
data.additionalDocuments.fileName | string |
Nome do arquivo |
|
Tipo
|
data.additionalDocuments.type | string |
Tipo |
|
Identificação do Candidato
|
data.additionalDocuments.candidateId | string |
Identificação do Candidato |
|
Acordos Separados
|
data.separateAgreements | boolean |
Acordos Separados |
Obter Dados de Utilizador
Obtenha Dados de Utilizador para o ID de Utilizador Específico
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
ID de Utilizador
|
userId | True | string |
O ID de Utilizador Único |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Data e Hora
|
timestamp | integer |
Data e Hora |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Nome Próprio
|
data.firstName | string |
Nome Próprio |
|
Apelido
|
data.lastName | string |
Apelido |
|
Empresa
|
data.company | string |
Empresa |
|
Fuso horário
|
data.timezone | string |
Fuso horário |
|
Linguagem
|
data.language | string |
Linguagem |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
Cargo
|
data.jobTitle | string |
Cargo |
|
Número de Telefone
|
data.phoneNumber | string |
Número de Telefone |
|
Código do país
|
data.phoneCountryCode | string |
Código do país |
|
Funções
|
data.roles | array of string |
Funções |
|
O Final Mail está desativado?
|
data.finalMailDisabled | boolean |
O Final Mail está desativado? |
|
O Lembrete de Correio está desativado?
|
data.reminderMailDisabled | boolean |
O Lembrete de Correio está desativado? |
|
O correio do remetente está desativado?
|
data.senderMailDisabled | boolean |
O correio do remetente está desativado? |
|
A integração é utilizadora?
|
data.integrationUser | boolean |
A integração é utilizadora? |
|
Saudação
|
data.salutation | string |
Saudação |
|
Está ativo
|
data.active | boolean |
Está ativo |
|
Id
|
data.id | string |
Id |
|
Endereço de E-mail
|
data.emailAddress | string |
Endereço de E-mail |
Gatilhos
| Quando o Estado de uma Transação é Alterado |
Registar um callback para um evento de transação específico |
Quando o Estado de uma Transação é Alterado
Registar um callback para um evento de transação específico
Parâmetros
| Nome | Chave | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
Tipo de Evento
|
eventType | True | array |
O tipo de evento de transação a registar |
Regressos
| Nome | Percurso | Tipo | Descrição |
|---|---|---|---|
|
Data e Hora
|
timestamp | integer |
Data e Hora |
|
Código de estado
|
statusCode | integer |
Código de estado |
|
Message
|
message | string |
Message |
|
Nome da Transação
|
data.name | string |
Nome da Transação |
|
Estado da Transação
|
data.status | string |
Estado da Transação |
|
ID da Transação
|
data.transactionId | string |
ID da Transação |
|
Message
|
data.mail.message | string |
Mensagem para todos os participantes por email. |
|
Data da última atualização
|
data.lastUpdatedDate | string |
Data da última atualização |
|
Data de criação
|
data.createdDate | string |
Data de criação |
|
ID de Utilizador
|
data.createdBy.id | string |
Criado por ID de Utilizador |
|
Nome de utilizador
|
data.createdBy.username | string |
Criado por nome de utilizador |
|
Endereço de E-mail
|
data.createdBy.emailAddress | string |
Criado por Endereço de Email |
|
Data de envio
|
data.sentDate | string |
Data de envio |
|
ID de Utilizador
|
data.lastActionPerformedBy.userId | string |
ID de Utilizador |
|
Nome de Utilizador
|
data.lastActionPerformedBy.userName | string |
Nome de Utilizador |
|
Endereço de E-mail
|
data.lastActionPerformedBy.emailAddress | string |
Endereço de E-mail |
|
Identificação do Candidato
|
data.lastActionPerformedBy.candidateId | string |
Identificação do Candidato |
|
ID do participante
|
data.lastActionPerformedBy.participantId | string |
ID do participante |
|
Expira com carimbo temporal
|
data.expiryAndReminders.expiresAtTimestamp | string |
Transação expira com carimbo temporal |
|
Dias de Validade
|
data.expiryAndReminders.expiryDays | integer |
Dias de Validade |
|
Dias de Recordação
|
data.expiryAndReminders.remindFromReminderDays | integer |
Dias de Recordação |
|
Relembrar da Hora do Lembrete
|
data.expiryAndReminders.remindFromReminderTime | string |
Relembrar da Hora do Lembrete |
|
Frequência do lembrete
|
data.expiryAndReminders.reminderFrequency | integer |
Frequência do Lembrete |
|
Participantes
|
data.participants | array of object |
Participantes |
|
ID do participante
|
data.participants.id | string |
ID do participante |
|
Estatuto de Participante
|
data.participants.status | string |
Estatuto de Participante |
|
Data da última atualização
|
data.participants.lastUpdatedDate | string |
Data da última atualização |
|
Data de criação
|
data.participants.createdDate | string |
Data de criação |
|
Sequência de participantes
|
data.participants.sequence | integer |
Sequence |
|
Funções
|
data.participants.role | string |
Funções |
|
Método de Assinatura
|
data.participants.signingMethodDTO | array of string |
Detalhes do Método de Assinatura |
|
Submetido pelo Utilizador
|
data.participants.submittedBys | array of object |
Submetido pelos Dados do Utilizador |
|
ID de Utilizador
|
data.participants.submittedBys.userId | string |
Submetido pelo ID do Utilizador |
|
Nome de Utilizador
|
data.participants.submittedBys.userName | string |
Submetido pelo Nome do Utilizador |
|
Endereço de E-mail
|
data.participants.submittedBys.emailAddress | string |
Submetido pelo endereço de email do utilizador |
|
Identificação do Candidato
|
data.participants.submittedBys.candidateId | string |
Identificação do Candidato |
|
Candidatos
|
data.participants.candidates | array of object |
Candidatos |
|
Identificação do Candidato
|
data.participants.candidates.id | string |
Identificação do Candidato |
|
Nome
|
data.participants.candidates.name | string |
Nome do Candidato |
|
Endereço de E-mail
|
data.participants.candidates.emailAddress | string |
Endereço de Email do Candidato |
|
Linguagem
|
data.participants.candidates.language | string |
Linguagem |
|
Tipo
|
data.participants.candidates.type | string |
Tipo |
|
Ação
|
data.participants.candidates.action | string |
Ação |
|
Data de Ação
|
data.participants.candidates.actionDate | string |
Data de Ação |
|
Data de criação
|
data.participants.candidates.createdDate | string |
Data de criação |
|
Valor do Modo de Autenticação
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Valor do Modo de Autenticação |
|
Detalhes do método de assinatura
|
data.participants.candidates.signingMethodDTO | array of string |
Detalhes do método de assinatura |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Canais de Distribuição
|
data.participants.candidates.deliveryChannels | array of string |
Canais de Distribuição |
|
Campos
|
data.participants.fields | array of object |
Campos |
|
Id
|
data.participants.fields.id | string |
Id |
|
Data da última atualização
|
data.participants.fields.lastUpdatedDate | string |
Data da última atualização |
|
Data de criação
|
data.participants.fields.createdDate | string |
Data de criação |
|
ID do campo
|
data.participants.fields.fieldId | string |
ID do campo |
|
N.º da página
|
data.participants.fields.pageNo | integer |
N.º da página |
|
ID do documento
|
data.participants.fields.documentId | string |
ID do documento |
|
Largura do campo
|
data.participants.fields.width | float |
Largura do campo |
|
Altura do campo
|
data.participants.fields.height | float |
Altura do campo |
|
Dica de ferramenta
|
data.participants.fields.tooltip | string |
Dica de ferramenta |
|
Valor
|
data.participants.fields.value | string |
Valor |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NomeEstilo
|
data.participants.fields.nameStyle | string |
NomeEstilo |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Etiqueta de Exibição
|
data.participants.fields.displayLabel | string |
Etiqueta de Exibição |
|
Tipo de link
|
data.participants.fields.linkType | string |
Tipo de link |
|
Radio Id
|
data.participants.fields.radioId | integer |
Radio Id |
|
Radio Group Id
|
data.participants.fields.radioGroupId | string |
Radio Group Id |
|
ID de Caixa de Seleção
|
data.participants.fields.checkboxId | integer |
ID de Caixa de Seleção |
|
Nome do campo
|
data.participants.fields.fieldName | string |
Nome do campo |
|
Posição X
|
data.participants.fields.xposition | float |
X Posição do campo |
|
Posição Y
|
data.participants.fields.yposition | float |
Posição Y do campo |
|
É obrigatório?
|
data.participants.fields.required | boolean |
Isto é uma área obrigatória? |
|
É só leitura?
|
data.participants.fields.readOnly | boolean |
Isto é uma área de Leitura Só? |
|
Área de Texto
|
data.participants.fields.textarea | boolean |
Área de Texto |
|
Verticais
|
data.participants.fields.vertical | boolean |
Verticais |
|
Topo Inferior
|
data.participants.fields.topBottom | boolean |
Topo Inferior |
|
Valor padrão
|
data.participants.fields.defaultValue | string |
Valor padrão |
|
Formato
|
data.participants.signatureBlock.format | array of object |
Formato |
|
Id
|
data.participants.signatureBlock.format.id | string |
Id |
|
Sequence
|
data.participants.signatureBlock.format.sequence | integer |
Sequence |
|
É obrigatório?
|
data.participants.signatureBlock.format.required | boolean |
É obrigatório? |
|
Predefinido
|
data.participants.signatureBlock.default | boolean |
Predefinido |
|
Permitir Delegar
|
data.participants.enableDelegate | boolean |
Permitir Delegar |
|
Processo Automóvel
|
data.participants.autoProcess | boolean |
Processo Automóvel |
|
Utilizadores do CC
|
data.ccUsers | array of object |
Utilizadores do CC |
|
Nome
|
data.ccUsers.name | string |
Nome |
|
Endereço de E-mail
|
data.ccUsers.emailAddress | string |
Endereço de E-mail |
|
Linguagem
|
data.ccUsers.language | string |
Linguagem |
|
Documents
|
data.documents | array of object |
Documents |
|
ID do documento
|
data.documents.id | string |
ID do documento |
|
Sequence
|
data.documents.sequence | integer |
Sequence |
|
Nome do arquivo
|
data.documents.fileName | string |
Nome do arquivo |
|
Contagem de páginas
|
data.documents.pageCount | integer |
Contagem de páginas |
|
É eliminável?
|
data.documents.deletable | boolean |
É eliminável? |
|
É privado
|
data.documents.private | boolean |
É privado |
|
Campos personalizados
|
data.customFields | array of object |
Campos personalizados |
|
ID de campo personalizado
|
data.customFields.customFieldId | string |
ID de campo personalizado |
|
Valor de Campo
|
data.customFields.value | string |
Valor de Campo |
|
Nome do campo
|
data.customFields.fieldName | string |
Nome do campo |
|
Tipo de campo
|
data.customFields.fieldType | string |
Tipo de campo |
|
Subscrições de notificação
|
data.notificationSubscriptions | array of |
Subscrições de notificação |
|
tags
|
data.tags | array of |
tags |
|
Documentos Adicionais
|
data.additionalDocuments | array of object |
Documentos Adicionais |
|
Id
|
data.additionalDocuments.id | string |
Id |
|
Nome do arquivo
|
data.additionalDocuments.fileName | string |
Nome do arquivo |
|
Tipo
|
data.additionalDocuments.type | string |
Tipo |
|
Identificação do Candidato
|
data.additionalDocuments.candidateId | string |
Identificação do Candidato |
|
Acordos Separados
|
data.separateAgreements | boolean |
Acordos Separados |
Definições
ficheiro
Este é o tipo de dados básicos 'arquivo'.