Assinatura Eletrónica
Assine qualquer coisa. Em qualquer lugar. É fácil assinar e enviar os seus documentos em qualquer dispositivo com o nosso sistema de assinatura eletrónica seguro.
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) |
| Automatize o poder | 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 | Suporte E-Sign |
| URL | https://www.e-sign.co.uk |
| support@e-sign.co.uk |
| Metadados do conector | |
|---|---|
| Editora | Assinatura Eletrónica |
| Sítio Web | https://www.e-sign.co.uk |
| Política de privacidade | https://www.e-sign.co.uk/privacy/ |
| Categorias | Sítio Web |
Pré-requisitos
Para usar este conector, você deve ter uma conta E-Sign paga na plataforma E-Sign. Você pode configurar uma conta aqui https://app.e-sign.co.uk/#/register/11.
Como obter credenciais
A API E-Sign usa o OAuth 2 para autenticar, portanto, uma vez que a conta é configurada, nenhuma etapa adicional é necessária.
Introdução ao conector
- Carregar um ficheiro para o E-Sign: esta ação utiliza uma string base64 e carrega-a na plataforma E-Sign
- Criar um documento a partir do modelo: esta ação cria um novo documento, usando o modelo selecionado.
Envie um documento para assinatura quando um novo e-mail com um anexo for recebido do Microsoft Outlook ou do Gmail, conforme mostrado abaixo.
Problemas conhecidos e limitações
Para que a função de upload funcione atualmente, uma variável String deve ser inicializada e, em seguida, declarada. Isso é mostrado no exemplo acima, isso permitirá que um documento seja carregado para a plataforma E-Sign e, em seguida, seja usado para o novo documento.
Documentação da API
https://api.e-sign.co.uk/v3/index.html
FAQ
https://www.e-sign.co.uk/support/faqs/ https://www.e-sign.co.uk/contact-us/
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Carregar arquivo para a ação E-Sign |
Carrega um ficheiro para a plataforma E-Sign que pode ser utilizado para criar um documento para assinatura |
| Criar envelope |
Criar e enviar um novo envelope E-Sign |
| Criar envelope a partir do modelo |
Crie um novo envelope para assinatura usando um dos seus modelos de E-Sign. |
Carregar arquivo para a ação E-Sign
Carrega um ficheiro para a plataforma E-Sign que pode ser utilizado para criar um documento para assinatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
base64
|
base64 | True | string |
base64 |
|
title
|
title | True | string |
title |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
title
|
title | string |
title |
|
Assunto
|
subject | string |
Assunto |
|
descrição
|
description | string |
descrição |
|
envelope_status
|
envelope_status | string |
envelope_status |
|
HREF
|
href | string |
HREF |
|
linguagem
|
language | string |
linguagem |
|
miniatura
|
thumbnail | string |
miniatura |
|
Documentação
|
documents | array of object |
Documentação |
|
id
|
documents.id | string |
id |
|
title
|
documents.title | string |
title |
|
document_status
|
documents.document_status | string |
document_status |
|
id
|
documents.upload_file.id | string |
id |
|
URI
|
documents.upload_file.uri | string |
URI |
|
nome_do_ficheiro
|
documents.upload_file.file_name | string |
nome_do_ficheiro |
|
file_size
|
documents.upload_file.file_size | integer |
file_size |
|
processamento
|
documents.upload_file.processing | boolean |
processamento |
|
date_created
|
documents.upload_file.date_created | string |
date_created |
|
pages
|
documents.upload_file.pages | integer |
pages |
|
miniatura
|
documents.upload_file.thumbnail | string |
miniatura |
|
tipo
|
documents.upload_file.type | string |
tipo |
|
HREF
|
documents.upload_file.href | string |
HREF |
|
images
|
documents.upload_file.images | array of object |
images |
|
URL
|
documents.upload_file.images.url | string |
URL |
|
thumb_url
|
documents.upload_file.images.thumb_url | string |
thumb_url |
|
URI
|
documents.document_file.uri | string |
URI |
|
pages
|
documents.document_file.pages | integer |
pages |
|
signature_certificate_page
|
documents.document_file.signature_certificate_page | integer |
signature_certificate_page |
|
images
|
documents.document_file.images | array of object |
images |
|
URL
|
documents.document_file.images.url | string |
URL |
|
thumb_url
|
documents.document_file.images.thumb_url | string |
thumb_url |
|
attachment_files
|
documents.attachment_files | array of object |
attachment_files |
|
id
|
documents.attachment_files.id | string |
id |
|
URI
|
documents.attachment_files.uri | string |
URI |
|
nome_do_ficheiro
|
documents.attachment_files.file_name | string |
nome_do_ficheiro |
|
file_size
|
documents.attachment_files.file_size | integer |
file_size |
|
processamento
|
documents.attachment_files.processing | boolean |
processamento |
|
date_created
|
documents.attachment_files.date_created | string |
date_created |
|
pages
|
documents.attachment_files.pages | integer |
pages |
|
miniatura
|
documents.attachment_files.thumbnail | string |
miniatura |
|
tipo
|
documents.attachment_files.type | string |
tipo |
|
HREF
|
documents.attachment_files.href | string |
HREF |
|
images
|
documents.attachment_files.images | array of object |
images |
|
URL
|
documents.attachment_files.images.url | string |
URL |
|
thumb_url
|
documents.attachment_files.images.thumb_url | string |
thumb_url |
|
last_interaction
|
documents.last_interaction | string |
last_interaction |
|
document_fields
|
documents.document_fields | array of object |
document_fields |
|
id
|
documents.document_fields.id | string |
id |
|
signer_email
|
documents.document_fields.signer_email | string |
signer_email |
|
signer_id
|
documents.document_fields.signer_id | string |
signer_id |
|
field_type
|
documents.document_fields.field_type | string |
field_type |
|
field_required
|
documents.document_fields.field_required | boolean |
field_required |
|
field_placeholder
|
documents.document_fields.field_placeholder | string |
field_placeholder |
|
field_amount
|
documents.document_fields.field_amount | string |
field_amount |
|
field_value
|
documents.document_fields.field_value | string |
field_value |
|
field_dropdown_options
|
documents.document_fields.field_dropdown_options | array of string |
field_dropdown_options |
|
x
|
documents.document_fields.document_position.x | string |
x |
|
y
|
documents.document_fields.document_position.y | string |
y |
|
Largura
|
documents.document_fields.document_position.width | string |
Largura |
|
altura
|
documents.document_fields.document_position.height | string |
altura |
|
size
|
documents.document_fields.document_position.size | string |
size |
|
página
|
documents.document_fields.document_position.page | integer |
página |
|
signatários
|
signers | array of object |
signatários |
|
id
|
signers.id | string |
id |
|
nome
|
signers.name | string |
nome |
|
e-mail
|
signers.email | string |
|
|
último
|
signers.viewed.last | string |
último |
|
amount_of_times
|
signers.viewed.amount_of_times | integer |
amount_of_times |
|
estado
|
signers.envelope_status.status | string |
estado |
|
signed_at
|
signers.envelope_status.signed_at | string |
signed_at |
|
declined_at
|
signers.envelope_status.declined_at | string |
declined_at |
|
individual_document_status
|
signers.individual_document_status | array of object |
individual_document_status |
|
document_id
|
signers.individual_document_status.document_id | string |
document_id |
|
estado
|
signers.individual_document_status.status | string |
estado |
|
signed_at
|
signers.individual_document_status.signed_at | string |
signed_at |
|
declined_at
|
signers.individual_document_status.declined_at | string |
declined_at |
|
declined_reason
|
signers.individual_document_status.declined_reason | string |
declined_reason |
|
authenticated_user
|
signers.signer_details.authenticated_user | boolean |
authenticated_user |
|
current_sequential_signer
|
signers.signer_details.current_sequential_signer | boolean |
current_sequential_signer |
|
registered_user
|
signers.signer_details.registered_user | boolean |
registered_user |
|
id_checker_document
|
signers.signer_details.id_checker_document | string |
id_checker_document |
|
dont_send_signing_emails
|
envelope_options.dont_send_signing_emails | boolean |
dont_send_signing_emails |
|
sign_in_sequential_order
|
envelope_options.sign_in_sequential_order | boolean |
sign_in_sequential_order |
|
last_interaction
|
envelope_meta.last_interaction | string |
last_interaction |
|
criado_em
|
envelope_meta.created_at | string |
criado_em |
|
audit_trail
|
envelope_meta.audit_trail | array of object |
audit_trail |
|
tipo
|
envelope_meta.audit_trail.type | string |
tipo |
|
datetime
|
envelope_meta.audit_trail.datetime | string |
datetime |
|
ação
|
envelope_meta.audit_trail.action | string |
ação |
|
nome
|
envelope_meta.audit_trail.concern.name | string |
nome |
|
email_address
|
envelope_meta.audit_trail.concern.email_address | string |
email_address |
|
instância
|
envelope_meta.audit_trail.resource.instance | string |
instância |
|
nome
|
envelope_meta.audit_trail.resource.name | string |
nome |
|
id
|
envelope_meta.audit_trail.resource.id | string |
id |
|
nome
|
envelope_meta.author.name | string |
nome |
|
e-mail
|
envelope_meta.author.email | string |
|
|
tags
|
tags | array of object |
tags |
|
nome
|
tags.name | string |
nome |
Criar envelope
Criar e enviar um novo envelope E-Sign
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
title
|
title | True | string |
título individual do documento |
|
Assunto
|
subject | string |
Assunto do envelope |
|
|
descrição
|
description | string |
Descrição do envelope |
|
|
title
|
title | True | string |
Título do envelope |
|
id
|
id | True | string |
Arquivo uuid carregado anteriormente |
|
id
|
id | string |
id |
|
|
signer_email
|
signer_email | string |
signer_email |
|
|
field_type
|
field_type | string |
field_type |
|
|
field_required
|
field_required | boolean |
field_required |
|
|
field_placeholder
|
field_placeholder | string |
field_placeholder |
|
|
field_value
|
field_value | string |
field_value |
|
|
x
|
x | string |
x |
|
|
y
|
y | string |
y |
|
|
página
|
page | integer |
página |
|
|
nome
|
name | True | string |
Nome dos signatários |
|
e-mail
|
True | string |
E-mail dos signatários |
|
|
sign_in_sequential_order
|
sign_in_sequential_order | boolean |
sign_in_sequential_order |
|
|
nome
|
name | string |
nome |
|
|
e-mail
|
string |
|
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
title
|
title | string |
title |
|
Assunto
|
subject | string |
Assunto |
|
descrição
|
description | string |
descrição |
|
envelope_status
|
envelope_status | string |
envelope_status |
|
HREF
|
href | string |
HREF |
|
linguagem
|
language | string |
linguagem |
|
miniatura
|
thumbnail | string |
miniatura |
|
Documentação
|
documents | array of object |
Documentação |
|
id
|
documents.id | string |
id |
|
title
|
documents.title | string |
title |
|
document_status
|
documents.document_status | string |
document_status |
|
id
|
documents.upload_file.id | string |
id |
|
URI
|
documents.upload_file.uri | string |
URI |
|
nome_do_ficheiro
|
documents.upload_file.file_name | string |
nome_do_ficheiro |
|
file_size
|
documents.upload_file.file_size | integer |
file_size |
|
processamento
|
documents.upload_file.processing | boolean |
processamento |
|
date_created
|
documents.upload_file.date_created | string |
date_created |
|
pages
|
documents.upload_file.pages | integer |
pages |
|
miniatura
|
documents.upload_file.thumbnail | string |
miniatura |
|
tipo
|
documents.upload_file.type | string |
tipo |
|
HREF
|
documents.upload_file.href | string |
HREF |
|
images
|
documents.upload_file.images | array of object |
images |
|
URL
|
documents.upload_file.images.url | string |
URL |
|
thumb_url
|
documents.upload_file.images.thumb_url | string |
thumb_url |
|
URI
|
documents.document_file.uri | string |
URI |
|
pages
|
documents.document_file.pages | integer |
pages |
|
signature_certificate_page
|
documents.document_file.signature_certificate_page | integer |
signature_certificate_page |
|
images
|
documents.document_file.images | array of object |
images |
|
URL
|
documents.document_file.images.url | string |
URL |
|
thumb_url
|
documents.document_file.images.thumb_url | string |
thumb_url |
|
attachment_files
|
documents.attachment_files | array of object |
attachment_files |
|
id
|
documents.attachment_files.id | string |
id |
|
URI
|
documents.attachment_files.uri | string |
URI |
|
nome_do_ficheiro
|
documents.attachment_files.file_name | string |
nome_do_ficheiro |
|
file_size
|
documents.attachment_files.file_size | integer |
file_size |
|
processamento
|
documents.attachment_files.processing | boolean |
processamento |
|
date_created
|
documents.attachment_files.date_created | string |
date_created |
|
pages
|
documents.attachment_files.pages | integer |
pages |
|
miniatura
|
documents.attachment_files.thumbnail | string |
miniatura |
|
tipo
|
documents.attachment_files.type | string |
tipo |
|
HREF
|
documents.attachment_files.href | string |
HREF |
|
images
|
documents.attachment_files.images | array of object |
images |
|
URL
|
documents.attachment_files.images.url | string |
URL |
|
thumb_url
|
documents.attachment_files.images.thumb_url | string |
thumb_url |
|
last_interaction
|
documents.last_interaction | string |
last_interaction |
|
document_fields
|
documents.document_fields | array of object |
document_fields |
|
id
|
documents.document_fields.id | string |
id |
|
signer_email
|
documents.document_fields.signer_email | string |
signer_email |
|
signer_id
|
documents.document_fields.signer_id | string |
signer_id |
|
field_type
|
documents.document_fields.field_type | string |
field_type |
|
field_required
|
documents.document_fields.field_required | boolean |
field_required |
|
field_placeholder
|
documents.document_fields.field_placeholder | string |
field_placeholder |
|
field_amount
|
documents.document_fields.field_amount | string |
field_amount |
|
field_value
|
documents.document_fields.field_value | string |
field_value |
|
field_dropdown_options
|
documents.document_fields.field_dropdown_options | array of string |
field_dropdown_options |
|
x
|
documents.document_fields.document_position.x | string |
x |
|
y
|
documents.document_fields.document_position.y | string |
y |
|
Largura
|
documents.document_fields.document_position.width | string |
Largura |
|
altura
|
documents.document_fields.document_position.height | string |
altura |
|
size
|
documents.document_fields.document_position.size | string |
size |
|
página
|
documents.document_fields.document_position.page | integer |
página |
|
signatários
|
signers | array of object |
signatários |
|
id
|
signers.id | string |
id |
|
nome
|
signers.name | string |
nome |
|
e-mail
|
signers.email | string |
|
|
último
|
signers.viewed.last | string |
último |
|
amount_of_times
|
signers.viewed.amount_of_times | integer |
amount_of_times |
|
estado
|
signers.envelope_status.status | string |
estado |
|
signed_at
|
signers.envelope_status.signed_at | string |
signed_at |
|
declined_at
|
signers.envelope_status.declined_at | string |
declined_at |
|
individual_document_status
|
signers.individual_document_status | array of object |
individual_document_status |
|
document_id
|
signers.individual_document_status.document_id | string |
document_id |
|
estado
|
signers.individual_document_status.status | string |
estado |
|
signed_at
|
signers.individual_document_status.signed_at | string |
signed_at |
|
declined_at
|
signers.individual_document_status.declined_at | string |
declined_at |
|
declined_reason
|
signers.individual_document_status.declined_reason | string |
declined_reason |
|
authenticated_user
|
signers.signer_details.authenticated_user | boolean |
authenticated_user |
|
current_sequential_signer
|
signers.signer_details.current_sequential_signer | boolean |
current_sequential_signer |
|
registered_user
|
signers.signer_details.registered_user | boolean |
registered_user |
|
id_checker_document
|
signers.signer_details.id_checker_document | string |
id_checker_document |
|
dont_send_signing_emails
|
envelope_options.dont_send_signing_emails | boolean |
dont_send_signing_emails |
|
sign_in_sequential_order
|
envelope_options.sign_in_sequential_order | boolean |
sign_in_sequential_order |
|
last_interaction
|
envelope_meta.last_interaction | string |
last_interaction |
|
criado_em
|
envelope_meta.created_at | string |
criado_em |
|
audit_trail
|
envelope_meta.audit_trail | array of object |
audit_trail |
|
tipo
|
envelope_meta.audit_trail.type | string |
tipo |
|
datetime
|
envelope_meta.audit_trail.datetime | string |
datetime |
|
ação
|
envelope_meta.audit_trail.action | string |
ação |
|
nome
|
envelope_meta.audit_trail.concern.name | string |
nome |
|
email_address
|
envelope_meta.audit_trail.concern.email_address | string |
email_address |
|
instância
|
envelope_meta.audit_trail.resource.instance | string |
instância |
|
nome
|
envelope_meta.audit_trail.resource.name | string |
nome |
|
id
|
envelope_meta.audit_trail.resource.id | string |
id |
|
nome
|
envelope_meta.author.name | string |
nome |
|
e-mail
|
envelope_meta.author.email | string |
|
|
tags
|
tags | array of object |
tags |
|
id
|
tags.id | string |
id |
|
nome
|
tags.name | string |
nome |
Criar envelope a partir do modelo
Crie um novo envelope para assinatura usando um dos seus modelos de E-Sign.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo
|
id | string |
O UUID do modelo (obrigatório, a menos que o título do modelo) |
|
|
título do modelo
|
template_title | string |
O título do modelo (obrigatório, a menos que o ID do modelo) |
|
|
upload_file
|
upload_file | string |
ID do ficheiro carregado |
|
|
Assunto
|
subject | string |
O assunto do modelo substitui o título do modelo salvo |
|
|
nome
|
name | string |
Nome dos signatários |
|
|
e-mail
|
string |
E-mail dos signatários |
Acionadores
| Envelope criado |
Quando um novo envelope é criado no E-Sign |
| Envelope preenchido |
Quando um envelope é totalmente preenchido por todos os signatários |
| Signos do signatário |
Quando um signatário individual assina um documento do envelope |
Envelope criado
Quando um novo envelope é criado no E-Sign
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
evento
|
event | string |
evento |
|
id
|
envelope.id | string |
id |
|
title
|
envelope.title | string |
title |
|
Assunto
|
envelope.subject | string |
Assunto |
|
descrição
|
envelope.description | string |
descrição |
|
envelope_status
|
envelope.envelope_status | string |
envelope_status |
|
HREF
|
envelope.href | string |
HREF |
|
linguagem
|
envelope.language | string |
linguagem |
|
Documentação
|
envelope.documents | array of object |
Documentação |
|
id
|
envelope.documents.id | string |
id |
|
title
|
envelope.documents.title | string |
title |
|
document_status
|
envelope.documents.document_status | string |
document_status |
|
id
|
envelope.documents.upload_file.id | string |
id |
|
URI
|
envelope.documents.upload_file.uri | string |
URI |
|
nome_do_ficheiro
|
envelope.documents.upload_file.file_name | string |
nome_do_ficheiro |
|
file_size
|
envelope.documents.upload_file.file_size | integer |
file_size |
|
processamento
|
envelope.documents.upload_file.processing | boolean |
processamento |
|
date_created
|
envelope.documents.upload_file.date_created | string |
date_created |
|
pages
|
envelope.documents.upload_file.pages | integer |
pages |
|
miniatura
|
envelope.documents.upload_file.thumbnail | string |
miniatura |
|
tipo
|
envelope.documents.upload_file.type | string |
tipo |
|
HREF
|
envelope.documents.upload_file.href | string |
HREF |
|
URI
|
envelope.documents.document_file.uri | string |
URI |
|
pages
|
envelope.documents.document_file.pages | integer |
pages |
|
signature_certificate_page
|
envelope.documents.document_file.signature_certificate_page | integer |
signature_certificate_page |
|
attachment_files
|
envelope.documents.attachment_files | array of object |
attachment_files |
|
id
|
envelope.documents.attachment_files.id | string |
id |
|
URI
|
envelope.documents.attachment_files.uri | string |
URI |
|
nome_do_ficheiro
|
envelope.documents.attachment_files.file_name | string |
nome_do_ficheiro |
|
file_size
|
envelope.documents.attachment_files.file_size | integer |
file_size |
|
processamento
|
envelope.documents.attachment_files.processing | boolean |
processamento |
|
date_created
|
envelope.documents.attachment_files.date_created | string |
date_created |
|
pages
|
envelope.documents.attachment_files.pages | integer |
pages |
|
miniatura
|
envelope.documents.attachment_files.thumbnail | string |
miniatura |
|
tipo
|
envelope.documents.attachment_files.type | string |
tipo |
|
HREF
|
envelope.documents.attachment_files.href | string |
HREF |
|
last_interaction
|
envelope.documents.last_interaction | string |
last_interaction |
|
document_fields
|
envelope.documents.document_fields | array of object |
document_fields |
|
id
|
envelope.documents.document_fields.id | string |
id |
|
signer_email
|
envelope.documents.document_fields.signer_email | string |
signer_email |
|
signer_id
|
envelope.documents.document_fields.signer_id | string |
signer_id |
|
field_type
|
envelope.documents.document_fields.field_type | string |
field_type |
|
field_required
|
envelope.documents.document_fields.field_required | boolean |
field_required |
|
field_placeholder
|
envelope.documents.document_fields.field_placeholder | string |
field_placeholder |
|
field_amount
|
envelope.documents.document_fields.field_amount | string |
field_amount |
|
field_value
|
envelope.documents.document_fields.field_value | string |
field_value |
|
field_dropdown_options
|
envelope.documents.document_fields.field_dropdown_options | array of string |
field_dropdown_options |
|
x
|
envelope.documents.document_fields.document_position.x | string |
x |
|
y
|
envelope.documents.document_fields.document_position.y | string |
y |
|
Largura
|
envelope.documents.document_fields.document_position.width | string |
Largura |
|
altura
|
envelope.documents.document_fields.document_position.height | string |
altura |
|
size
|
envelope.documents.document_fields.document_position.size | string |
size |
|
página
|
envelope.documents.document_fields.document_position.page | integer |
página |
|
signatários
|
envelope.signers | array of object |
signatários |
|
id
|
envelope.signers.id | string |
id |
|
nome
|
envelope.signers.name | string |
nome |
|
e-mail
|
envelope.signers.email | string |
|
|
último
|
envelope.signers.viewed.last | string |
último |
|
amount_of_times
|
envelope.signers.viewed.amount_of_times | integer |
amount_of_times |
Envelope preenchido
Quando um envelope é totalmente preenchido por todos os signatários
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
evento
|
event | string |
evento |
|
id
|
envelope.id | string |
id |
|
title
|
envelope.title | string |
title |
|
Assunto
|
envelope.subject | string |
Assunto |
|
descrição
|
envelope.description | string |
descrição |
|
envelope_status
|
envelope.envelope_status | string |
envelope_status |
|
HREF
|
envelope.href | string |
HREF |
|
linguagem
|
envelope.language | string |
linguagem |
|
Documentação
|
envelope.documents | array of object |
Documentação |
|
id
|
envelope.documents.id | string |
id |
|
title
|
envelope.documents.title | string |
title |
|
document_status
|
envelope.documents.document_status | string |
document_status |
|
id
|
envelope.documents.upload_file.id | string |
id |
|
URI
|
envelope.documents.upload_file.uri | string |
URI |
|
nome_do_ficheiro
|
envelope.documents.upload_file.file_name | string |
nome_do_ficheiro |
|
file_size
|
envelope.documents.upload_file.file_size | integer |
file_size |
|
processamento
|
envelope.documents.upload_file.processing | boolean |
processamento |
|
date_created
|
envelope.documents.upload_file.date_created | string |
date_created |
|
pages
|
envelope.documents.upload_file.pages | integer |
pages |
|
miniatura
|
envelope.documents.upload_file.thumbnail | string |
miniatura |
|
tipo
|
envelope.documents.upload_file.type | string |
tipo |
|
HREF
|
envelope.documents.upload_file.href | string |
HREF |
|
URI
|
envelope.documents.document_file.uri | string |
URI |
|
pages
|
envelope.documents.document_file.pages | integer |
pages |
|
signature_certificate_page
|
envelope.documents.document_file.signature_certificate_page | integer |
signature_certificate_page |
|
attachment_files
|
envelope.documents.attachment_files | array of object |
attachment_files |
|
id
|
envelope.documents.attachment_files.id | string |
id |
|
URI
|
envelope.documents.attachment_files.uri | string |
URI |
|
nome_do_ficheiro
|
envelope.documents.attachment_files.file_name | string |
nome_do_ficheiro |
|
file_size
|
envelope.documents.attachment_files.file_size | integer |
file_size |
|
processamento
|
envelope.documents.attachment_files.processing | boolean |
processamento |
|
date_created
|
envelope.documents.attachment_files.date_created | string |
date_created |
|
pages
|
envelope.documents.attachment_files.pages | integer |
pages |
|
miniatura
|
envelope.documents.attachment_files.thumbnail | string |
miniatura |
|
tipo
|
envelope.documents.attachment_files.type | string |
tipo |
|
HREF
|
envelope.documents.attachment_files.href | string |
HREF |
|
last_interaction
|
envelope.documents.last_interaction | string |
last_interaction |
|
document_fields
|
envelope.documents.document_fields | array of object |
document_fields |
|
id
|
envelope.documents.document_fields.id | string |
id |
|
signer_email
|
envelope.documents.document_fields.signer_email | string |
signer_email |
|
signer_id
|
envelope.documents.document_fields.signer_id | string |
signer_id |
|
field_type
|
envelope.documents.document_fields.field_type | string |
field_type |
|
field_required
|
envelope.documents.document_fields.field_required | boolean |
field_required |
|
field_placeholder
|
envelope.documents.document_fields.field_placeholder | string |
field_placeholder |
|
field_amount
|
envelope.documents.document_fields.field_amount | string |
field_amount |
|
field_value
|
envelope.documents.document_fields.field_value | string |
field_value |
|
field_dropdown_options
|
envelope.documents.document_fields.field_dropdown_options | array of string |
field_dropdown_options |
|
x
|
envelope.documents.document_fields.document_position.x | string |
x |
|
y
|
envelope.documents.document_fields.document_position.y | string |
y |
|
Largura
|
envelope.documents.document_fields.document_position.width | string |
Largura |
|
altura
|
envelope.documents.document_fields.document_position.height | string |
altura |
|
size
|
envelope.documents.document_fields.document_position.size | string |
size |
|
página
|
envelope.documents.document_fields.document_position.page | integer |
página |
|
signatários
|
envelope.signers | array of object |
signatários |
|
id
|
envelope.signers.id | string |
id |
|
nome
|
envelope.signers.name | string |
nome |
|
e-mail
|
envelope.signers.email | string |
|
|
último
|
envelope.signers.viewed.last | string |
último |
|
amount_of_times
|
envelope.signers.viewed.amount_of_times | integer |
amount_of_times |
Signos do signatário
Quando um signatário individual assina um documento do envelope
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Identificador Único Universal (UUID)
|
signer.uuid | string |
Identificador Único Universal (UUID) |
|
nome
|
signer.name | string |
nome |
|
email_address
|
signer.email_address | string |
email_address |
|
signed_at
|
signer.signed_at | string |
signed_at |
|
declined_at
|
signer.declined_at | string |
declined_at |
|
declined_reason
|
signer.declined_reason | string |
declined_reason |
|
response_ip
|
signer.response_ip | string |
response_ip |
|
response_os
|
signer.response_os | string |
response_os |
|
response_browser
|
signer.response_browser | string |
response_browser |
|
response_browser_version
|
signer.response_browser_version | integer |
response_browser_version |
|
required_additional_fields
|
signer.required_additional_fields | array of |
required_additional_fields |
|
document_status
|
document_status | string |
document_status |
|
document_uuid
|
document_uuid | string |
document_uuid |
|
event_name
|
event_name | string |
event_name |