Assinaturas Eletrônicas Conectivas
A conectividade eSignatures é uma solução de assinatura digital renomada que oferece uma grande quantidade de métodos de assinatura e conformidade com as regulamentações nacionais (inter)mais rigorosas. O eSignatures permite transformar qualquer processo baseado em papel em um fluxo digital de ponta a ponta com uma experiência de usuário incomparável. Simplifique o processo de assinatura exatamente como você deseja e envie, assine e acompanhe todos os tipos de documentos diretamente de seus aplicativos de negócios favoritos. Junte-se a mais de 500 clientes satisfeitos.
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 | Suporte à conectividade |
| URL | https://connective.eu/contact-support/ |
| service@connective.eu |
| Metadados do conector | |
|---|---|
| Publicador | Conectivo |
| Site | https://www.connective.eu |
| Política de privacidade | https://connective.eu/privacy-policy/ |
| Categorias | Operações de TI; Produtividade |
A conectividade, especialista em assinaturas digitais, serviços de identidade e geração de documentos inteligentes, disponibilizou o Conector de eSignatures de Conectividade para Power Automate para uso. O Conector permite que as empresas encaminhem documentos que exigem uma assinatura digital diretamente de seus aplicativos favoritos do Microsoft 365 – do Microsoft Teams para Word, SharePoint, Dynamics, OneDrive e muitos outros.
Como começar a usar o conector
Para começar a usar o conector, entre em contato com seu gerenciador de relacionamentos no Connective ou acesse nossa página de contatos em nosso site para receber as credenciais.
Esta página detalhará ainda mais as diferentes ações disponíveis, bem como fornecerá insights sobre as diferentes maneiras pelas quais essas ações podem ser implementadas.
Não hesite em dar uma olhada em nosso site de documentação para obter mais informações ou entrar em contato com a equipe de suporte por meio do formulário de contato de suporte ou caixa de correio de suporte: service@connective.eu
Um glossário está disponível para explicar os diferentes termos que estão sendo usados nesta documentação
Ações
O conector de eSignatures de conectividade baseia-se na API v3 de eSignatures. A API de eSignatures é uma API REST que permite que aplicativos externos se integrem e usem os recursos listados neste documento para criar e gerenciar fluxos de assinatura.
As ações disponíveis podem ser agrupadas em grupos diferentes
| Grupo de Ações | Ações Disponíveis |
|---|---|
| Carregando documentos | Criar Pacote |
| Adicionar documento ao pacote | |
| Obter locais de assinatura | |
| Definir informações do processo | |
| Definir status do pacote | |
| Criar pacote instantâneo | |
| Recuperando o status de um documento | Obter status do pacote |
| Obter lista de pacotes | |
| Ações diversas | Ignorar Signatários |
| Baixar Pacote | |
| Extensão de expiração do pacote | |
| Enviar Lembrete do Pacote | |
| Excluir Pacote | |
| Recuperando a prova de auditoria | Recuperar provas de auditoria de pacote |
| Recuperar provas de auditoria de documentos | |
| Recuperar provas de auditoria de pacote com id de correlação | |
| Recuperar provas de auditoria de documento com id de correlação | |
| Adicionar prova de uma origem externa |
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 |
|---|---|---|---|
| URL do ambiente de eSignatures de conectividade | cadeia | URL para seu ambiente de eSignatures de conectividade, por exemplo. esignatures.connective.eu | Verdade |
| Nome de usuário da API | secureString | Nome de usuário da API para acessar a API | Verdade |
| Senha da API | secureString | Senha da API para acessar a API | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar documento ao pacote |
Essa chamada adicionará um documento a um pacote existente. |
| Adicionar prova de origem externa |
Essa chamada permite que os usuários de API adicionem provas extras de uma origem externa a um local em um documento. |
| Baixar documento do pacote |
Os documentos assinados em um pacote podem ser baixados um por um por um sistema externo usando essa chamada. Cada documento será baixado como um PDF ou como um fluxo de arquivos XML, dependendo do valor do parâmetro DocumentType. |
| Baixar Pacote |
O pacote que contém os documentos assinados pode ser baixado por um sistema externo usando essa chamada. |
| Carimbo de Data/Hora de Expiração |
Um pacote pode ter o status Expirado quando um pacote passou um valor para o parâmetro ExpiryTimestamp na chamada Criar Pacote. Esse pacote não pode mais ser assinado. |
| Criar Pacote |
Essa chamada cria um pacote vazio, permitindo que documentos sejam adicionados a ele |
| Criar pacote instantâneo |
Essa chamada cria um pacote com um único documento e o prepara instantaneamente para assinatura |
| Definir informações do processo |
Esse método de serviço Web atualiza as pessoas envolvidas no processo (stakeholders) e atribui a elas as etapas que precisam ser executadas. |
| Definir status do pacote |
Por meio da chamada Definir Status do Pacote, você pode alterar o status de um pacote. |
| Download da prova de auditoria de correlação de documento |
IDs de correlação são usadas para rastrear pacotes ou documentos em várias passagens pelo aplicativo eSignatures. |
| Download da prova de auditoria de correlação de pacote |
IDs de correlação são usadas para rastrear pacotes ou documentos em várias passagens pelo aplicativo eSignatures. |
| Enviar lembretes de pacote |
A política da empresa pode exigir que um documento seja tratado dentro de um determinado período de tempo. Disparar a chamada "enviar lembretes" procurará todos que não assinaram e enviarão uma notificação extra como um lembrete. |
| Excluir Pacote |
As eSignatures não excluem automaticamente os pacotes do banco de dados depois de atingirem um estado final. Eles são armazenados indefinidamente. Para excluir pacotes do banco de dados, os usuários podem usar a chamada Excluir Pacote. |
| Ignorar Signatários |
Essa chamada ignora todos os signatários que ainda não assinaram e define seu status como "Ignorado", o que faz com que o pacote completo seja marcado como "Concluído". |
| Lista de Pacotes |
Obter uma lista de pacotes com o status atual |
| Obter locais de assinatura |
Essa chamada fornece uma visão geral de todos os locais de assinatura dentro dos documentos dentro de um pacote. |
| Obter status do pacote |
Recupera o estado atual do pacote e seus documentos. |
| Prova de Auditoria de Pacote |
O xml de provas de auditoria de um pacote pode ser recuperado quando o pacote é totalmente assinado. O mesmo se aplica a um documento: ele só funciona quando o pacote de contenção é totalmente assinado. |
| Prova de Auditoria de Pacote com ID do documento |
O xml de provas de auditoria de um pacote pode ser recuperado quando o pacote é totalmente assinado. O mesmo se aplica a um documento: ele só funciona quando o pacote de contenção é totalmente assinado. |
Adicionar documento ao pacote
Essa chamada adicionará um documento a um pacote existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O identificador do pacote.
|
PackageId | True | string |
ID exclusiva do pacote |
|
Documento
|
Document | string |
Documento anexado no formato codificado em base64. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Idioma a ser usado em textos de assinatura. |
|
|
DocumentName
|
DocumentName | string |
Nome do documento a ser mostrado no Portal de eSignatures. |
|
|
PageNumber
|
PageNumber | integer |
Número da página na qual adicionar um local de assinatura |
|
|
Largura
|
Width | string |
Largura |
|
|
Altura
|
Height | string |
Altura |
|
|
Left
|
Left | string |
Posição à esquerda da página |
|
|
TOP
|
Top | string |
Posição da parte superior da página |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Referência exclusiva a um campo de assinatura, marcador de texto ou campo de texto. |
|
|
CorrelationId
|
CorrelationId | string |
ID que indica quais documentos dentro desse pacote estão correlacionados com documentos que foram conectados no passado em outros pacotes. |
|
|
DocumentType
|
DocumentType | string |
Tipo de documento que será assinado. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Referência fornecida pelo aplicativo de chamada. |
|
|
ErrorCode
|
ErrorCode | string |
Código de erro com informações de variável. |
|
|
Message
|
Message | string |
Texto de detalhes da mensagem de erro, não localizado |
|
|
Representação
|
Representation | string |
Documento de representação anexado no formato base64. Devem ser dados PDF. |
|
|
RepresentationType
|
RepresentationType | string |
Tipo do documento de representação. |
|
|
TipoDeAlvo
|
TargetType | string |
O TargetType define se uma conversão extra para PDF/A precisa ser feita antes da assinatura. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
ID exclusiva do documento |
|
CreationTimestamp
|
CreationTimestamp | string |
Data e hora em que o fluxo foi criado. Formato: YYYY-MM-DDThh:mm:ss+zz:zz |
|
Localizações
|
Locations | array of object |
Representa um local possível para uma assinatura |
|
ID
|
Locations.Id | string |
ID exclusiva para este local |
|
Etiqueta
|
Locations.Label | string |
Rótulo detectado ou especificado |
|
PageNumber
|
Locations.PageNumber | integer |
A página na qual o local foi encontrado. |
Adicionar prova de origem externa
Essa chamada permite que os usuários de API adicionem provas extras de uma origem externa a um local em um documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID exclusiva do pacote
|
packageId | True | string |
A ID exclusiva do pacote |
|
Content
|
Content | string |
O conteúdo real da prova. |
|
|
LocationId
|
LocationId | string |
Local da assinatura para a qual o conteúdo da prova foi gerado. |
|
|
Nome
|
Name | string |
Nome da prova. |
|
|
Tipo
|
Type | string |
Uma chave de "tipo" legível pelo computador. Pode ser escolhido livremente. |
|
|
Description
|
Description | string |
Breve descrição legível da prova. |
|
|
Endereço IP
|
IpAddress | string |
Endereço IP do usuário final da fonte externa para a qual a prova foi adicionada. |
Baixar documento do pacote
Os documentos assinados em um pacote podem ser baixados um por um por um sistema externo usando essa chamada. Cada documento será baixado como um PDF ou como um fluxo de arquivos XML, dependendo do valor do parâmetro DocumentType.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva para o pacote de assinatura
|
id | True | string |
ID exclusiva para o pacote de assinatura |
|
ID exclusiva do documento contido no pacote
|
documentId | True | string |
ID exclusiva do documento contido no pacote |
Retornos
- response
- binary
Baixar Pacote
O pacote que contém os documentos assinados pode ser baixado por um sistema externo usando essa chamada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do pacote
|
id | True | string |
ID exclusiva do pacote |
Retornos
- response
- binary
Carimbo de Data/Hora de Expiração
Um pacote pode ter o status Expirado quando um pacote passou um valor para o parâmetro ExpiryTimestamp na chamada Criar Pacote. Esse pacote não pode mais ser assinado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do pacote
|
id | True | string |
ID exclusiva do pacote |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
Criar Pacote
Essa chamada cria um pacote vazio, permitindo que documentos sejam adicionados a ele
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
Initiator (iniciador)
|
Initiator | string |
Endereço de email de um usuário registrado. |
|
|
PackageName
|
PackageName | string |
Nome do pacote, visto no Portal do eSignatures e ao baixar como arquivo zip. |
|
|
CallBackUrl
|
CallBackUrl | string |
URL da API REST que será chamada sempre que uma ação for concluída para esse pacote. |
|
|
CorrelationId
|
CorrelationId | string |
ID que indica quais pacotes estão correlacionados. |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
O "Código" que identifica um grupo de documentos no qual o pacote deve ser mostrado. |
|
|
ThemeCode
|
ThemeCode | string |
Tema que deve ser aplicado ao pacote |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Esse parâmetro determina se os pacotes podem ser baixados do WYSIWYS antes da assinatura. |
|
|
ReassignEnabled
|
ReassignEnabled | boolean |
Esse parâmetro determina se os pacotes podem ser reatribuídos do WYSIWYS para outro aprovador/signatário. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Esse parâmetro determina após quantos dias as URLs de ação devem expirar quando não forem usadas. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
A data e a hora em que esse pacote expira e não pode mais ser assinado. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Referência fornecida pelo aplicativo de chamada. Esse parâmetro não será usado pelo Portal de eSignatures. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
Esse campo é reservado para uso futuro. Ele pode ser usado para extensões específicas do cliente integrarem-se a serviços de terceiros, como assinatura de Cartão de Débito. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
URL para a qual o usuário final é redirecionado após todos os campos terem sido assinados com assinatura "cara a cara" ou quando todos os campos tiverem sido rejeitados. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
URL da API REST que será chamada quando um usuário final solicitar que seja notificado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Identificador exclusivo do pacote. |
|
CreationTimestamp
|
CreationTimestamp | string |
Data e hora em que o pacote foi criado de acordo com o servidor. |
Criar pacote instantâneo
Essa chamada cria um pacote com um único documento e o prepara instantaneamente para assinatura
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Documento
|
Document | byte |
Documento anexado no formato codificado em base64. Obrigatório, a menos que o formato Multipart seja usado. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Idioma a ser usado em textos de assinatura. Atualmente com suporte: en, nl, de, fr, es. |
|
|
DocumentName
|
DocumentName | string |
Nome do documento e do pacote a ser mostrado no Portal de eSignatures. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
|
Initiator (iniciador)
|
Initiator | string |
Endereço de email de um usuário registrado |
|
|
Tipo
|
Type | string |
Signatário/Receptor |
|
|
OrderIndex
|
OrderIndex | integer |
Esse número especifica em qual ordem os atores precisam executar sua ação. |
|
|
PageNumber
|
PageNumber | integer |
Número da página na qual adicionar um local de assinatura |
|
|
Largura
|
Width | string |
Largura |
|
|
Altura
|
Height | string |
Altura |
|
|
Left
|
Left | string |
Posição à esquerda da página |
|
|
TOP
|
Top | string |
Posição da parte superior da página |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Referência exclusiva a um campo de assinatura, marcador de texto ou campo de texto. |
|
|
SigningType
|
SigningType | string |
O tipo de assinatura usado na sessão deste ator. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Um ou mais OIDs de tipos de compromisso. Só pode ser passado quando a política de assinatura é usada. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Tipo de validação a ser executada durante outro cartão inteligente eID ou sessão de assinatura itsme. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Define qual eID ou outros cartões inteligentes têm permissão para assinar durante esta sessão. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Assinando detalhes da política para a assinatura. |
|
|
Número de telefone
|
Phonenumber | string |
Número de telefone para receber um SMS OTP. |
|
|
RedirectUrl
|
RedirectUrl | string |
URL para a qual o usuário final é redirecionado após a assinatura. |
|
|
SendNotifications
|
SendNotifications | boolean |
As eSignatures podem enviar emails para todas as pessoas que têm permissão para assinar. |
|
|
UserRoles
|
UserRoles | array of string |
Função ou função do signatário. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Aviso legal |
|
|
LegalNoticeText
|
LegalNoticeText | string |
Texto de aviso legal personalizado caso nenhum dos três avisos legais predefinidos se apliquem. |
|
|
Endereço de Email
|
EmailAddress | string |
Endereço de Email |
|
|
Primeiro Nome
|
FirstName | string |
Primeiro Nome |
|
|
LastName
|
LastName | string |
LastName |
|
|
BirthDate
|
BirthDate | string |
BirthDate |
|
|
Linguagem
|
Language | string |
Linguagem |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
|
CallBackUrl
|
CallBackUrl | string |
URL da API REST que será chamada sempre que uma ação for concluída para esse pacote |
|
|
CorrelationId
|
CorrelationId | string |
ID que indica quais pacotes ou documentos estão correlacionados |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
O 'Código' que identifica um grupo de documentos no qual o documento deve ser mostrado |
|
|
ThemeCode
|
ThemeCode | string |
Tema que deve ser aplicado ao pacote |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Esse parâmetro determina se os pacotes podem ser baixados do WYSIWYS antes de assinar |
|
|
ReassignEnabled
|
ReassignEnabled | boolean |
Esse parâmetro determina se os pacotes podem ser reatribuídos do WYSIWYS para outro aprovador/signatário. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Esse parâmetro determina após quantos dias as URLs de ação devem expirar quando não forem usadas. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Referência fornecida pelo aplicativo de chamada. Esse parâmetro não será usado pelo Portal de eSignatures |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Referência fornecida pelo aplicativo de chamada, esse parâmetro não será usado pelo Portal de eSignatures |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Referência fornecida pelo aplicativo de chamada, esse parâmetro não será usado pelo Portal de eSignatures |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
Url para a qual o usuário final é redirecionado após todos os campos terem sido assinados com assinatura "cara a cara" ou quando todos os campos tiverem sido rejeitados. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
URL da API REST que será chamada quando um usuário final solicitar que seja notificado. Se nenhuma URL for fornecida, nenhuma chamada será executada |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Como lidar com PDFs que contêm pequenas falhas |
|
|
Representação
|
Representation | string |
Documento de representação anexado no formato base64 |
|
|
RepresentationType
|
RepresentationType | string |
O tipo do documento de representação deve estar presente quando a Representação for preenchida. Há suporte apenas para "aplicativo/pdf". |
|
|
SigningTemplateCode
|
SigningTemplateCode | string |
O modelo configurado no portal fornecerá todas as informações necessárias |
|
|
TipoDeAlvo
|
TargetType | string |
O TargetType define se uma conversão extra para PDF/A precisa ser feita antes de assinar |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Identificador exclusivo do pacote. |
|
CreationTimestamp
|
CreationTimestamp | string |
Data e hora em que o pacote foi criado de acordo com o servidor. |
Definir informações do processo
Esse método de serviço Web atualiza as pessoas envolvidas no processo (stakeholders) e atribui a elas as etapas que precisam ser executadas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do pacote
|
id | True | string |
ID exclusiva do pacote |
|
Tipo
|
Type | string |
Tipo |
|
|
OrderIndex
|
OrderIndex | string |
Esse número especifica em qual ordem os atores precisam executar sua ação. |
|
|
LocationIds
|
LocationIds | array of string |
As IDs de local em que uma assinatura deve ser colocada por essa pessoa. |
|
|
SigningType
|
SigningType | string |
O tipo de assinatura usado na sessão deste ator. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Um ou mais OIDs de tipos de compromisso. Só pode ser passado quando a política de assinatura é usada. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Tipo de validação a ser executada durante outro cartão inteligente eID ou sessão de assinatura itsme. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Define qual eID ou outros cartões inteligentes têm permissão para assinar durante esta sessão. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Assinando detalhes da política para a assinatura. |
|
|
Número de telefone
|
Phonenumber | string |
Número de telefone para receber um SMS OTP. |
|
|
RedirecionarURL
|
RedirectURL | string |
URL para a qual o usuário final é redirecionado após a assinatura ou rejeição. O redirecionamento ocorre imediatamente após a assinatura ou rejeição. |
|
|
SendNotifications
|
SendNotifications | boolean |
As eSignatures podem enviar emails aos atores cuja ação é necessária, como assinatura |
|
|
UserRoles
|
UserRoles | array of string |
As IDs de local em que uma assinatura deve ser colocada por essa pessoa. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Os 3 valores apontarão para os 3 avisos legais incorporados ao aplicativo. Elas podem ser alteradas no Índice de Configuração. |
|
|
LegalNoticetext
|
LegalNoticetext | string |
Texto de aviso legal personalizado no caso de nenhum dos três avisos legais predefinidos se aplicarem |
|
|
Endereço de Email
|
EmailAddress | string |
Endereço de Email |
|
|
Primeiro Nome
|
FirstName | string |
Primeiro Nome |
|
|
Linguagem
|
Language | string |
Idioma da interface do usuário desse stakeholder. Atualmente com suporte: en, nl, de, fr, es. |
|
|
LastName
|
LastName | string |
Apelido |
|
|
BirthDate
|
BirthDate | string |
Data de nascimento em formato: YYYY-MM-DD |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
Referência fornecida pelo aplicativo de chamada. Esse parâmetro não será usado pelo Portal de eSignatures. |
Definir status do pacote
Por meio da chamada Definir Status do Pacote, você pode alterar o status de um pacote.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva para o pacote de assinatura
|
Id | True | string |
ID exclusiva para o pacote de assinatura |
|
Situação
|
Status | string |
Pendente/Revogada |
Retornos
Descrição do pacote mostrado para o usuário do Portal do eSignatures como nome de arquivo.
- Corpo
- PackageStatus
Download da prova de auditoria de correlação de documento
IDs de correlação são usadas para rastrear pacotes ou documentos em várias passagens pelo aplicativo eSignatures.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O identificador de correlação.
|
correlationId | True | string |
O identificador de correlação. |
Retornos
- Corpo
- Content
Download da prova de auditoria de correlação de pacote
IDs de correlação são usadas para rastrear pacotes ou documentos em várias passagens pelo aplicativo eSignatures.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O identificador de correlação.
|
correlationId | True | string |
O identificador de correlação. |
Retornos
- Corpo
- Content
Enviar lembretes de pacote
A política da empresa pode exigir que um documento seja tratado dentro de um determinado período de tempo. Disparar a chamada "enviar lembretes" procurará todos que não assinaram e enviarão uma notificação extra como um lembrete.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do pacote
|
PackageId | True | string |
ID exclusiva do pacote |
Excluir Pacote
As eSignatures não excluem automaticamente os pacotes do banco de dados depois de atingirem um estado final. Eles são armazenados indefinidamente. Para excluir pacotes do banco de dados, os usuários podem usar a chamada Excluir Pacote.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do pacote
|
id | True | string |
ID exclusiva do pacote |
Ignorar Signatários
Essa chamada ignora todos os signatários que ainda não assinaram e define seu status como "Ignorado", o que faz com que o pacote completo seja marcado como "Concluído".
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do pacote
|
PackageId | True | string |
ID exclusiva do pacote |
Lista de Pacotes
Obter uma lista de pacotes com o status atual
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O token de continuação/guid para saber qual página retornar.
|
ContinuationToken | string |
O token de continuação/guid para saber qual página retornar. DEVE ESTAR VAZIO ou o token retornado de uma chamada ANTERIOR. |
|
|
Obtém ou define a quantidade máxima.
|
MaxQuantity | integer |
Obtém ou define a quantidade máxima. |
|
|
Obtém ou define o campo de classificação.
|
SortField | string |
Obtém ou define o campo de classificação. |
|
|
Obtém ou define o campo de classificação.
|
SortOrder | string |
Obtém ou define o campo de classificação. |
|
|
Obtém ou define a data criada antes.
|
CreatedBeforeDate | string |
Obtém ou define a data criada antes. |
|
|
Obtém ou define o status.
|
Status | string |
Obtém ou define o status. |
|
|
Obtém ou define o criado após a data.
|
createdAfterDate | string |
Obtém ou define o criado após a data. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Token de Continuação
|
ContinuationToken | string |
Token de Continuação |
|
MaxQuantity
|
MaxQuantity | integer |
MaxQuantity |
|
Total
|
Total | integer |
Total |
|
Itens
|
Items | array of Package |
Obter locais de assinatura
Essa chamada fornece uma visão geral de todos os locais de assinatura dentro dos documentos dentro de um pacote.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do campo de assinatura
|
Id | True | string |
ID do campo de assinatura |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
Documents | array of object | |
|
DocumentId
|
Documents.DocumentId | string |
ID exclusiva do documento |
|
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
Referência externa para identificação. Use um valor exclusivo. |
|
Localizações
|
Documents.Locations | array of object |
Representa um local possível para uma assinatura |
|
ID
|
Documents.Locations.Id | string |
ID exclusiva para este local. |
|
Etiqueta
|
Documents.Locations.Label | string |
Valor que você inseriu como parâmetro de solicitação. |
|
PageNumber
|
Documents.Locations.PageNumber | integer |
Número da página na qual a assinatura pode ser encontrada. |
Obter status do pacote
Recupera o estado atual do pacote e seus documentos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva para o pacote de assinatura
|
Id | True | string |
ID exclusiva para o pacote de assinatura |
Retornos
Descrição do pacote mostrado para o usuário do Portal do eSignatures como nome de arquivo.
- Corpo
- PackageStatus
Prova de Auditoria de Pacote
O xml de provas de auditoria de um pacote pode ser recuperado quando o pacote é totalmente assinado. O mesmo se aplica a um documento: ele só funciona quando o pacote de contenção é totalmente assinado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do pacote
|
packageId | True | string |
ID exclusiva do pacote |
Retornos
- Corpo
- Content
Prova de Auditoria de Pacote com ID do documento
O xml de provas de auditoria de um pacote pode ser recuperado quando o pacote é totalmente assinado. O mesmo se aplica a um documento: ele só funciona quando o pacote de contenção é totalmente assinado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID exclusiva do pacote
|
packageId | True | string |
ID exclusiva do pacote |
|
ID exclusiva do documento
|
documentId | True | string |
ID exclusiva do documento |
Retornos
- Corpo
- Content
Definições
Package
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
Id | string | |
|
PackageStatus
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
Detalhes de cada um dos documentos no pacote
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
ID exclusiva do documento |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Retorna a referência externa deste documento conforme ele foi passado por meio da chamada Adicionar documento ao pacote. |
|
DocumentName
|
DocumentName | string |
Nome do documento |
|
DocumentType
|
DocumentType | string |
Tipo de documento dentro do pacote. |
PackageStatus
Descrição do pacote mostrado para o usuário do Portal do eSignatures como nome de arquivo.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
PackageName
|
PackageName | string |
Descrição do pacote mostrado para o usuário do Portal do eSignatures como nome de arquivo. |
|
CreationTimestamp
|
CreationTimestamp | string |
Data e hora em que o pacote foi criado de acordo com o servidor. |
|
Initiator (iniciador)
|
Initiator | string |
Campo iniciador do pacote como ele foi passado no momento da criação. |
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Hora formatada em UTC na qual o documento expira. Pode ser nulo. |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Retorna a ID de referência externa do pacote como ela foi passada no momento da criação. |
|
F2FSigningUrl
|
F2FSigningUrl | string |
Link para o pacote que permite escolher de todas as sessões de assinatura ao mesmo tempo. |
|
PackageStatus
|
PackageStatus | string |
Status do pacote como um todo: |
|
PackageDocuments
|
PackageDocuments | array of PackageDocument |
Detalhes de cada um dos documentos no pacote. |
|
Partes interessadas
|
Stakeholders | array of object |
Detalhes para cada uma das pessoas que interagirão com o pacote. |
|
Tipo
|
Stakeholders.Type | string |
Tipo de stakeholder: Person, PersonGroup ou ContactGroup. |
|
PersonGroupName
|
Stakeholders.PersonGroupName | string |
Nome do grupo de pessoas. Retornado somente se o Tipo foi definido como PersonGroup na solicitação. |
|
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
Código do grupo de contatos. Retornado somente se Type foi definido como ContactGroup na solicitação. |
|
Endereço de Email
|
Stakeholders.EmailAddress | string |
Endereço de email do signatário. |
|
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
Referência externa identificando essa pessoa no sistema externo. |
|
StakeholderId
|
Stakeholders.StakeholderId | string |
ID exclusiva. |
|
Actors
|
Stakeholders.Actors | array of object |
Detalhes de todas as etapas a serem tomadas. |
|
ActorId
|
Stakeholders.Actors.ActorId | string |
ID exclusiva para essa combinação de ação, stakeholder e documento. |
|
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
URL que essa pessoa pode abrir para interagir com o pacote. |
|
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
Matriz de URLs que as diferentes pessoas do PersonGroup ou ContactGroup podem abrir para interagir com o pacote. |
|
Endereço de Email
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
Endereço de email da pessoa. |
|
URL
|
Stakeholders.Actors.ActionUrls.Url | string |
URL que essa pessoa pode abrir para interagir com o pacote. |
|
ActorStatus
|
Stakeholders.Actors.ActorStatus | string |
Rascunho (o pacote tem o rascunho de status) |
|
Tipo
|
Stakeholders.Actors.Type | string |
Signatário/Receptor |
|
CompletedBy
|
Stakeholders.Actors.CompletedBy | string |
O nome do usuário final que concluiu a ação. |
|
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
Carimbo de data/hora do momento em que esta ação foi concluída. |
|
Reason
|
Stakeholders.Actors.Reason | string |
Retorna o texto inserido pela pessoa que alterou o status de um pacote para um estado final (por exemplo, uma rejeição). |
|
Localizações
|
Stakeholders.Actors.Locations | array of object |
Representa um local possível para uma assinatura. |
|
ID
|
Stakeholders.Actors.Locations.Id | string |
ID exclusiva para este local |
|
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
Retorna o tipo de assinatura usado para assinar o documento. |
Content
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Uploads
|
uploads | array of object | |
|
carregamento
|
uploads.upload | array of object | |
|
start
|
uploads.upload.start | date-time | |
|
término
|
uploads.upload.end | date-time | |
|
Assinaturas
|
uploads.upload.signatures | array of object | |
|
Provas
|
uploads.upload.signatures.proofs | array of object | |
|
nome
|
uploads.upload.signatures.proofs.proof.name | string | |
|
tipo
|
uploads.upload.signatures.proofs.proof.type | string | |
|
indexar
|
uploads.upload.signatures.proofs.proof.index | boolean | |
|
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
|
locationId
|
uploads.upload.signatures.locationId | string | |
|
índices
|
uploads.indexes | array of object | |
|
identificador
|
uploads.indexes.index.identifier | boolean | |
|
conteúdo
|
uploads.indexes.index.content | string | |
|
packageCorrelationId
|
uploads.packageCorrelationId | string | |
|
ID do pacote
|
uploads.packageId | string |
binário
Esse é o tipo de dados básico 'binary'.