Certinal eSign (versão prévia)
O Certinal eSign permite que as empresas enviem, assinem e gerenciem documentos com eSignatures globalmente compatíveis. Projetada para setores regulamentados, a Certinal fornece acompanhamento de fluxo de trabalho em tempo real, trilhas de auditoria à prova de adulteração e automação perfeita. Use o Certinal eSign em seus fluxos de trabalho para digitalizar aprovações, acelerar processos e garantir assinaturas legalmente válidas em mais de 70 países.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – 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 Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Ajuda & Suporte |
| URL | https://www.certinal.com/department/esignature-for-support |
| tech-support@certinal.com |
| Metadados do conector | |
|---|---|
| Publicador | Certinal Inc. |
| Local na rede Internet | https://www.certinal.com/ |
| Política de privacidade | https://www.certinal.com/privacy-policy |
| Categorias | Produtividade; Gestão de empresas |
ESign certinal
Visão geral
O Certinal eSign fornece fluxos de trabalho de eSignature e eConsent seguros e compatíveis para empresas globais: enviar, assinar, acompanhar e gerenciar documentos diretamente do Power Automate.
Pré-requisitos
Você precisa ter uma conta do Administrador do Certinal para usar o gatilho do Conector. Para usar o gatilho conector nessa integração, o Power Connector deve estar habilitado nas configurações do Administrador do Certinal.
Como obter credenciais
O Certinal usa a chave de API para autenticar os serviços. Você precisa gerar a chave de API da conta do Administrador do Certinal.
Operações com suporte
O conector dá suporte às seguintes operações:
Obter detalhes da transação
Obter detalhes da transação por ID da transação
Baixar documentos para transação
Baixar documentos para a ID de transação fornecida
Criar transação
Criar transação
Criar transação usando o modelo
Criar transação usando uma determinada ID de modelo
Listar usuários
Listar usuários
Obter detalhes do usuário
Obter detalhes do usuário para a ID de usuário fornecida
Criar Usuário
Criar Usuário
Gatilhos com suporte
O conector dá suporte aos seguintes gatilhos:
Quando um status de transação é alterado
Registrar um retorno de chamada para um evento de transação específico
Documentos de API:
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
Ajuda & Suporte
https://esign.certinal.com/esign/certinal-docs/help-support
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia 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 |
| Ponto de extremidade da API base | cadeia | A URL base do ponto de extremidade da API (por exemplo, api.certinal.com) | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Baixar documentos para transação |
Baixar documentos para a ID de transação fornecida |
| Criar transação |
Criar transação |
| Criar transação usando o modelo |
Criar transação usando uma determinada ID de modelo |
| Criar Usuário |
Criar Usuário |
| Excluir assinatura |
Excluir assinatura |
| Listar usuários |
Listar usuários |
| Obter detalhes da transação |
Obter detalhes da transação por ID da transação |
| Obter detalhes do usuário |
Obter detalhes do usuário para a ID de usuário fornecida |
Baixar documentos para transação
Baixar documentos para a ID de transação fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da transação
|
transactionId | True | string |
A ID de transação exclusiva |
|
Tipo de documento
|
documentType | True | string |
Tipo de documento a ser baixado |
Retornos
- response
- file
Criar transação
Criar transação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da transação
|
name | True | string |
Nome da transação |
|
Message
|
message | string |
Mensagem para todos os participantes email. |
|
|
URL de retorno de chamada
|
url | string |
URL de retorno de chamada |
|
|
Eventos de transação
|
transactionEvents | array of string |
Eventos de transação |
|
|
Eventos de participantes
|
participantEvents | array of string |
Eventos de participantes |
|
|
Status da transação
|
status | string |
Status da transação |
|
|
ID externa
|
externalId | string |
ID externa |
|
|
Expira no Carimbo de Data/Hora
|
expiresAtTimestamp | string |
Transação expira no carimbo de data/hora |
|
|
Lembrar do carimbo de data/hora
|
remindFromTimestamp | string |
Lembrar do carimbo de data/hora |
|
|
Frequência de lembrete
|
reminderFrequency | integer |
Frequência do lembrete |
|
|
Campos padrão
|
default | boolean |
Campos de bloco de assinatura padrão |
|
|
Sequência de participantes
|
sequence | integer |
Sequence |
|
|
Função
|
role | string |
Função |
|
|
Nome
|
name | string |
Nome do candidato |
|
|
Endereço de Email
|
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 entrega
|
deliveryChannels | array of string |
Canais de entrega |
|
|
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 de área de texto
|
textareaLineCount | string |
Contagem de linhas de área de texto |
|
|
Nome do campo
|
fieldName | string |
Nome do campo |
|
|
Posição X
|
xposition | float |
Posição X do campo |
|
|
Posição Y
|
yposition | float |
Posição Y do campo |
|
|
É necessário?
|
required | boolean |
Esse é um campo necessário? |
|
|
Somente leitura?
|
readOnly | boolean |
Este é um campo Somente Leitura? |
|
|
Área de texto
|
textarea | boolean |
Área de texto |
|
|
Parte inferior superior
|
topBottom | boolean |
Parte inferior superior |
|
|
Vertical
|
vertical | boolean |
Vertical |
|
|
ID do grupo de rádio
|
radioGroupId | string |
ID do grupo de rádio |
|
|
Valor Padrão
|
defaultValue | string |
Valor Padrão |
|
|
Value
|
value | string |
Value |
|
|
Rótulo de exibição
|
displayLabel | string |
Rótulo de exibição |
|
|
Nome
|
name | string |
Nome |
|
|
Endereço de Email
|
emailAddress | string |
Endereço de Email |
|
|
Linguagem
|
language | string |
Linguagem |
|
|
ID do documento
|
id | string |
ID do documento |
|
|
Sequence
|
sequence | integer |
Sequence |
|
|
É deletável?
|
deletable | boolean |
É deletável? |
|
|
É privado
|
private | boolean |
É privado |
|
|
Valor do campo
|
value | string |
Valor do campo |
|
|
Nome do campo
|
fieldName | string |
Nome do campo |
|
|
Code
|
code | string |
Code |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Código de status
|
statusCode | integer |
Código de status |
|
Message
|
message | string |
Message |
|
ID da transação
|
data.transactionId | string |
ID da transação |
Criar transação usando o modelo
Criar transação usando uma determinada ID de modelo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da transação
|
name | string |
Nome da transação |
|
|
Status da transação
|
status | string |
Status da transação |
|
|
ID externa
|
externalId | string |
ID externa |
|
|
ID do modelo
|
templateId | string |
ID do modelo |
|
|
IDs de modelo secundário
|
secondaryTemplateIds | array of string |
IDs de modelo secundário |
|
|
Message
|
message | string |
Mensagem para todos os participantes email. |
|
|
URL de retorno de chamada
|
url | string |
URL de retorno de chamada |
|
|
Eventos de transação
|
transactionEvents | array of string |
Eventos de transação |
|
|
Eventos de participantes
|
participantEvents | array of string |
Eventos de participantes |
|
|
Sequência de participantes
|
sequence | integer |
Sequence |
|
|
Função
|
role | string |
Função |
|
|
O processo automático é?
|
autoProcess | boolean |
O processo automático é? |
|
|
Nome do campo
|
fieldName | string |
Nome do campo |
|
|
Valor do campo
|
value | string |
Valor do campo |
|
|
Nome
|
name | string |
Nome do candidato |
|
|
Endereço de Email
|
emailAddress | string |
Endereço de email do candidato |
|
|
Message
|
message | string |
Message |
|
|
Linguagem
|
language | string |
Linguagem |
|
|
Canais de entrega
|
deliveryChannels | array of string |
Canais de entrega |
|
|
Corpo de SMS personalizado
|
customSMSBody | string |
Corpo de SMS personalizado |
|
|
Nome
|
name | string |
Nome |
|
|
Message
|
message | string |
Message |
|
|
É necessário?
|
required | boolean |
É necessário? |
|
|
Nome
|
name | string |
Nome |
|
|
Endereço de Email
|
emailAddress | string |
Endereço de Email |
|
|
Linguagem
|
language | string |
Linguagem |
|
|
Valor do campo
|
value | string |
Valor do campo |
|
|
Nome do campo
|
fieldName | string |
Nome do campo |
|
|
Code
|
code | string |
Code |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Código de status
|
statusCode | integer |
Código de status |
|
Message
|
message | string |
Message |
|
ID da transação
|
data.transactionId | string |
ID da transação |
Criar Usuário
Criar Usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Endereço de Email
|
emailAddress | string |
Endereço de Email |
|
|
Primeiro Nome
|
firstName | string |
Primeiro Nome |
|
|
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 Email Final está desabilitado?
|
finalMailDisabled | boolean |
O Email Final está desabilitado? |
|
|
O Email de Lembrete está desabilitado?
|
reminderMailDisabled | boolean |
O Email de Lembrete está desabilitado? |
|
|
O Email do Remetente está desabilitado?
|
senderMailDisabled | boolean |
O Email do Remetente está desabilitado? |
|
|
O usuário de integração é?
|
integrationUser | boolean |
O usuário de integração é? |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Código de status
|
statusCode | integer |
Código de status |
|
Message
|
message | string |
Message |
|
Identificação de usuário
|
data.user_id | string |
Identificação de usuário |
Excluir assinatura
Excluir assinatura
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Webhook Id
|
webhookId | True | string |
O identificador exclusivo da assinatura do webhook a ser excluída |
Listar usuários
Listar usuários
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número da Página
|
pageNo | True | integer | |
|
Registros por Página
|
perPageRecords | True | integer |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Código de status
|
statusCode | integer |
Código de status |
|
Message
|
message | string |
Message |
|
Total de registros
|
data.totalRecords | integer |
total de registros |
|
Total de Páginas
|
data.totalPages | integer |
Total de Páginas |
|
Registros por página
|
data.perPageRecords | integer |
Registros por página |
|
Número da Página
|
data.pageNo | integer |
Número da Página |
|
Registros
|
data.records | array of object |
Registros de usuário |
|
Primeiro Nome
|
data.records.firstName | string |
Primeiro Nome |
|
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 Email Final está desabilitado?
|
data.records.finalMailDisabled | boolean |
O Email Final está desabilitado? |
|
O Email de Lembrete está desabilitado?
|
data.records.reminderMailDisabled | boolean |
O Email de Lembrete está desabilitado? |
|
O Email do Remetente está desabilitado?
|
data.records.senderMailDisabled | boolean |
O Email do Remetente está desabilitado? |
|
O usuário de integração é?
|
data.records.integrationUser | boolean |
O usuário de integração é? |
|
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 Email
|
data.records.emailAddress | string |
Endereço de Email |
Obter detalhes da transação
Obter detalhes da transação por ID da transação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da transação
|
transactionId | True | string |
A ID de transação exclusiva |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Código de status
|
statusCode | integer |
Código de status |
|
Message
|
message | string |
Message |
|
Nome da transação
|
data.name | string |
Nome da transação |
|
Status da transação
|
data.status | string |
Status da transação |
|
ID da transação
|
data.transactionId | string |
ID da transação |
|
Message
|
data.mail.message | string |
Mensagem para todos os participantes 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 |
|
Identificação de usuário
|
data.createdBy.id | string |
Criado por ID de Usuário |
|
Nome de usuário
|
data.createdBy.username | string |
Criado por Nome de Usuário |
|
Endereço de Email
|
data.createdBy.emailAddress | string |
Criado por endereço de email |
|
Data de envio
|
data.sentDate | string |
Data de envio |
|
Identificação de usuário
|
data.lastActionPerformedBy.userId | string |
Identificação de usuário |
|
Nome do usuário
|
data.lastActionPerformedBy.userName | string |
Nome do usuário |
|
Endereço de Email
|
data.lastActionPerformedBy.emailAddress | string |
Endereço de Email |
|
ID do candidato
|
data.lastActionPerformedBy.candidateId | string |
ID do candidato |
|
ID do participante
|
data.lastActionPerformedBy.participantId | string |
ID do participante |
|
Expira no Carimbo de Data/Hora
|
data.expiryAndReminders.expiresAtTimestamp | string |
Transação expira no carimbo de data/hora |
|
Dias de expiração
|
data.expiryAndReminders.expiryDays | integer |
Dias de expiração |
|
Lembrar de dias de lembrete
|
data.expiryAndReminders.remindFromReminderDays | integer |
Lembrar de dias de lembrete |
|
Lembrar do tempo de lembrete
|
data.expiryAndReminders.remindFromReminderTime | string |
Lembrar do tempo de lembrete |
|
Frequência de 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 |
|
Status do participante
|
data.participants.status | string |
Status do 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ção
|
data.participants.role | string |
Função |
|
Método de Assinatura
|
data.participants.signingMethodDTO | array of string |
Detalhes do método de assinatura |
|
Enviado por usuário
|
data.participants.submittedBys | array of object |
Enviado pelos detalhes do usuário |
|
Identificação de usuário
|
data.participants.submittedBys.userId | string |
Enviado pela ID do Usuário |
|
Nome do usuário
|
data.participants.submittedBys.userName | string |
Enviado pelo nome do usuário |
|
Endereço de Email
|
data.participants.submittedBys.emailAddress | string |
Enviado pelo endereço de email do usuário |
|
ID do candidato
|
data.participants.submittedBys.candidateId | string |
ID do candidato |
|
Candidatos
|
data.participants.candidates | array of object |
Candidatos |
|
ID do candidato
|
data.participants.candidates.id | string |
ID do candidato |
|
Nome
|
data.participants.candidates.name | string |
Nome do candidato |
|
Endereço de Email
|
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 da ação
|
data.participants.candidates.actionDate | string |
Data da 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 entrega
|
data.participants.candidates.deliveryChannels | array of string |
Canais de entrega |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
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 |
|
Página Não
|
data.participants.fields.pageNo | integer |
Página Não |
|
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 |
|
Value
|
data.participants.fields.value | string |
Value |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Rótulo de exibição
|
data.participants.fields.displayLabel | string |
Rótulo de exibição |
|
Tipo de link
|
data.participants.fields.linkType | string |
Tipo de link |
|
ID de rádio
|
data.participants.fields.radioId | integer |
ID de rádio |
|
ID do grupo de rádio
|
data.participants.fields.radioGroupId | string |
ID do grupo de rádio |
|
ID da caixa de seleção
|
data.participants.fields.checkboxId | integer |
ID da caixa de seleção |
|
Nome do campo
|
data.participants.fields.fieldName | string |
Nome do campo |
|
Posição X
|
data.participants.fields.xposition | float |
Posição X do campo |
|
Posição Y
|
data.participants.fields.yposition | float |
Posição Y do campo |
|
É necessário?
|
data.participants.fields.required | boolean |
Esse é um campo necessário? |
|
Somente leitura?
|
data.participants.fields.readOnly | boolean |
Este é um campo Somente Leitura? |
|
Área de texto
|
data.participants.fields.textarea | boolean |
Área de texto |
|
Vertical
|
data.participants.fields.vertical | boolean |
Vertical |
|
Parte inferior superior
|
data.participants.fields.topBottom | boolean |
Parte inferior superior |
|
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 |
|
É necessário?
|
data.participants.signatureBlock.format.required | boolean |
É necessário? |
|
Padrão
|
data.participants.signatureBlock.default | boolean |
Padrão |
|
Habilitar Delegado
|
data.participants.enableDelegate | boolean |
Habilitar Delegado |
|
Processo Automático
|
data.participants.autoProcess | boolean |
Processo Automático |
|
Usuários cc
|
data.ccUsers | array of object |
Usuários cc |
|
Nome
|
data.ccUsers.name | string |
Nome |
|
Endereço de Email
|
data.ccUsers.emailAddress | string |
Endereço de Email |
|
Linguagem
|
data.ccUsers.language | string |
Linguagem |
|
Documentos
|
data.documents | array of object |
Documentos |
|
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 |
|
É deletável?
|
data.documents.deletable | boolean |
É deletável? |
|
É privado
|
data.documents.private | boolean |
É privado |
|
Campos personalizados
|
data.customFields | array of object |
Campos personalizados |
|
ID do campo personalizado
|
data.customFields.customFieldId | string |
ID do campo personalizado |
|
Valor do campo
|
data.customFields.value | string |
Valor do campo |
|
Nome do campo
|
data.customFields.fieldName | string |
Nome do campo |
|
Tipo de campo
|
data.customFields.fieldType | string |
Tipo de campo |
|
Assinaturas de notificação
|
data.notificationSubscriptions | array of |
Assinaturas 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 |
|
ID do candidato
|
data.additionalDocuments.candidateId | string |
ID do candidato |
|
Acordos separados
|
data.separateAgreements | boolean |
Acordos separados |
Obter detalhes do usuário
Obter detalhes do usuário para a ID de usuário fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
userId | True | string |
A ID de Usuário Exclusiva |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Código de status
|
statusCode | integer |
Código de status |
|
Message
|
message | string |
Message |
|
Primeiro Nome
|
data.firstName | string |
Primeiro Nome |
|
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 Email Final está desabilitado?
|
data.finalMailDisabled | boolean |
O Email Final está desabilitado? |
|
O Email de Lembrete está desabilitado?
|
data.reminderMailDisabled | boolean |
O Email de Lembrete está desabilitado? |
|
O Email do Remetente está desabilitado?
|
data.senderMailDisabled | boolean |
O Email do Remetente está desabilitado? |
|
O usuário de integração é?
|
data.integrationUser | boolean |
O usuário de integração é? |
|
Saudação
|
data.salutation | string |
Saudação |
|
Está Ativo
|
data.active | boolean |
Está Ativo |
|
ID
|
data.id | string |
ID |
|
Endereço de Email
|
data.emailAddress | string |
Endereço de Email |
Gatilhos
| Quando um status de transação é alterado |
Registrar um retorno de chamada para um evento de transação específico |
Quando um status de transação é alterado
Registrar um retorno de chamada para um evento de transação específico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de evento
|
eventType | True | array |
O tipo de evento de transação para o qual registrar |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Timestamp
|
timestamp | integer |
Timestamp |
|
Código de status
|
statusCode | integer |
Código de status |
|
Message
|
message | string |
Message |
|
Nome da transação
|
data.name | string |
Nome da transação |
|
Status da transação
|
data.status | string |
Status da transação |
|
ID da transação
|
data.transactionId | string |
ID da transação |
|
Message
|
data.mail.message | string |
Mensagem para todos os participantes 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 |
|
Identificação de usuário
|
data.createdBy.id | string |
Criado por ID de Usuário |
|
Nome de usuário
|
data.createdBy.username | string |
Criado por Nome de Usuário |
|
Endereço de Email
|
data.createdBy.emailAddress | string |
Criado por endereço de email |
|
Data de envio
|
data.sentDate | string |
Data de envio |
|
Identificação de usuário
|
data.lastActionPerformedBy.userId | string |
Identificação de usuário |
|
Nome do usuário
|
data.lastActionPerformedBy.userName | string |
Nome do usuário |
|
Endereço de Email
|
data.lastActionPerformedBy.emailAddress | string |
Endereço de Email |
|
ID do candidato
|
data.lastActionPerformedBy.candidateId | string |
ID do candidato |
|
ID do participante
|
data.lastActionPerformedBy.participantId | string |
ID do participante |
|
Expira no Carimbo de Data/Hora
|
data.expiryAndReminders.expiresAtTimestamp | string |
Transação expira no carimbo de data/hora |
|
Dias de expiração
|
data.expiryAndReminders.expiryDays | integer |
Dias de expiração |
|
Lembrar de dias de lembrete
|
data.expiryAndReminders.remindFromReminderDays | integer |
Lembrar de dias de lembrete |
|
Lembrar do tempo de lembrete
|
data.expiryAndReminders.remindFromReminderTime | string |
Lembrar do tempo de lembrete |
|
Frequência de 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 |
|
Status do participante
|
data.participants.status | string |
Status do 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ção
|
data.participants.role | string |
Função |
|
Método de Assinatura
|
data.participants.signingMethodDTO | array of string |
Detalhes do método de assinatura |
|
Enviado por usuário
|
data.participants.submittedBys | array of object |
Enviado pelos detalhes do usuário |
|
Identificação de usuário
|
data.participants.submittedBys.userId | string |
Enviado pela ID do Usuário |
|
Nome do usuário
|
data.participants.submittedBys.userName | string |
Enviado pelo nome do usuário |
|
Endereço de Email
|
data.participants.submittedBys.emailAddress | string |
Enviado pelo endereço de email do usuário |
|
ID do candidato
|
data.participants.submittedBys.candidateId | string |
ID do candidato |
|
Candidatos
|
data.participants.candidates | array of object |
Candidatos |
|
ID do candidato
|
data.participants.candidates.id | string |
ID do candidato |
|
Nome
|
data.participants.candidates.name | string |
Nome do candidato |
|
Endereço de Email
|
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 da ação
|
data.participants.candidates.actionDate | string |
Data da 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 entrega
|
data.participants.candidates.deliveryChannels | array of string |
Canais de entrega |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
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 |
|
Página Não
|
data.participants.fields.pageNo | integer |
Página Não |
|
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 |
|
Value
|
data.participants.fields.value | string |
Value |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Rótulo de exibição
|
data.participants.fields.displayLabel | string |
Rótulo de exibição |
|
Tipo de link
|
data.participants.fields.linkType | string |
Tipo de link |
|
ID de rádio
|
data.participants.fields.radioId | integer |
ID de rádio |
|
ID do grupo de rádio
|
data.participants.fields.radioGroupId | string |
ID do grupo de rádio |
|
ID da caixa de seleção
|
data.participants.fields.checkboxId | integer |
ID da caixa de seleção |
|
Nome do campo
|
data.participants.fields.fieldName | string |
Nome do campo |
|
Posição X
|
data.participants.fields.xposition | float |
Posição X do campo |
|
Posição Y
|
data.participants.fields.yposition | float |
Posição Y do campo |
|
É necessário?
|
data.participants.fields.required | boolean |
Esse é um campo necessário? |
|
Somente leitura?
|
data.participants.fields.readOnly | boolean |
Este é um campo Somente Leitura? |
|
Área de texto
|
data.participants.fields.textarea | boolean |
Área de texto |
|
Vertical
|
data.participants.fields.vertical | boolean |
Vertical |
|
Parte inferior superior
|
data.participants.fields.topBottom | boolean |
Parte inferior superior |
|
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 |
|
É necessário?
|
data.participants.signatureBlock.format.required | boolean |
É necessário? |
|
Padrão
|
data.participants.signatureBlock.default | boolean |
Padrão |
|
Habilitar Delegado
|
data.participants.enableDelegate | boolean |
Habilitar Delegado |
|
Processo Automático
|
data.participants.autoProcess | boolean |
Processo Automático |
|
Usuários cc
|
data.ccUsers | array of object |
Usuários cc |
|
Nome
|
data.ccUsers.name | string |
Nome |
|
Endereço de Email
|
data.ccUsers.emailAddress | string |
Endereço de Email |
|
Linguagem
|
data.ccUsers.language | string |
Linguagem |
|
Documentos
|
data.documents | array of object |
Documentos |
|
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 |
|
É deletável?
|
data.documents.deletable | boolean |
É deletável? |
|
É privado
|
data.documents.private | boolean |
É privado |
|
Campos personalizados
|
data.customFields | array of object |
Campos personalizados |
|
ID do campo personalizado
|
data.customFields.customFieldId | string |
ID do campo personalizado |
|
Valor do campo
|
data.customFields.value | string |
Valor do campo |
|
Nome do campo
|
data.customFields.fieldName | string |
Nome do campo |
|
Tipo de campo
|
data.customFields.fieldType | string |
Tipo de campo |
|
Assinaturas de notificação
|
data.notificationSubscriptions | array of |
Assinaturas 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 |
|
ID do candidato
|
data.additionalDocuments.candidateId | string |
ID do candidato |
|
Acordos separados
|
data.separateAgreements | boolean |
Acordos separados |
Definições
arquivo
Esse é o tipo de dados básico 'file'.