Verificada
Conector para a API verificada para permitir a criação de processos de assinatura de documentos personalizados.
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 | Verificada |
| URL | https://verified.eu/en/#about-us |
| support@verified.eu |
| Metadados do conector | |
|---|---|
| Editora | Crm - Konsulterna i Sverige AB |
| Sítio Web | https://verified.eu/ |
| Política de privacidade | https://verified.eu/trust-center |
| Categorias | Conteúdos e Ficheiros; Produtividade |
Verified é um fornecedor de Software como Serviço de identificação eletrónica e assinatura digital. Este conector possibilita a integração com a API de Verificado e a criação de processos de assinatura simples e intuitivos dentro da sua aplicação.
Pré-requisitos
Você precisará do seguinte para prosseguir:
- Inscreva-se para uma conta verificada
Como obter credenciais
Este conector usa a Autenticação Básica. O usuário tem que apresentar nome de usuário, senha e ID da empresa ao criar uma conexão. O nome de utilizador e a palavra-passe são os mesmos que utiliza para iniciar sessão no portal Verificado. Para obter o ID da empresa, tem de iniciar sessão no portal Verificado, selecionar a empresa correta se tiver várias e copiar o ID da empresa do URL.
Introdução
Um caso de uso comum é iniciar e gerenciar um processo de assinatura, ou seja, configurar a automação para enviar documentos a serem assinados para Verificado e obter documentos assinados de volta regularmente. As ações comuns usadas para iniciar um processo de assinatura verificado incluem Criar envelope - descritor ou Criar envelope - padrão, Adicionar documento ao envelope, Adicionar arquivo ao documento, Adicionar destinatário ao envelope e Atualizar status de publicação do envelope. As ações comuns que são usadas para verificar o status Verificado para documentos incluem Obter envelope por id, Obter todos os documentos por ID de envelope, Obter arquivos por ID de documento, Obter URL de arquivo por id. Observe que a ação Gerar token de segurança é sempre usada como uma primeira etapa para obter um token de segurança a ser usado nas etapas a seguir.
Problemas conhecidos e limitações
As seguintes limitações são atualmente conhecidas.
- No início de cada fluxo, é preciso criar um token de autenticação para ser reutilizado em cada etapa seguinte.
- Para adicionar um documento é necessário enviar uma solicitação HTTP para uma determinada url.
- Para usar o novo endpoint de Pesquisa, este tem de ser ativado para a conta através do Verified Suppoert.
FAQ
Como carrego um documento para a Verificação?
Para carregar um documento real, você precisa criar um arquivo na API verificada e carregar o hash do documento para o URL de blob respondido da API verificada.
Como faço para obter o envelope depois de usar a ação Obter ID do envelope?
As etapas que criam um envelope respondem com um uid, que é um caminho completo para o envelope (exemplo: "/envelopes/ABCDE"). Para outras etapas, basta a última parte do uid (que é o id do envelope real, no nosso exemplo "ABCDE").
Aqui está um exemplo de como fazer isso
substring(outputs('Create_new_default_envelope')?['body/uid'],11)
Como faço para obter a ID do documento depois de usar a ação Adicionar documento ao envelope?
As etapas que criam um documento respondem com o Local do novo documento no cabeçalho. O Local é o caminho completo para o documento (exemplo: "/api/envelopes/ABCDE/documents/FGHIJ"). Apenas o ID do documento (no nosso caso: FGHIJ) é necessário para seguir os passos.
Aqui está um exemplo de como fazer isso
substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))
Como faço para obter o Flow Id de um envelope?
Quando se carrega informações sobre um envelope, o fluxo relacionado fará parte da resposta (exemplo: "/flow/default"). Na resposta, ele é chamado de id de um fluxo, no entanto, é necessária apenas a última parte quando outra etapa (como Get flow status) está pedindo o id do fluxo.
Aqui está um exemplo de como fazer isso
substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)
Como posso usar a nova ação de Pesquisa?
Para poder usar a nova ação de pesquisa, o endpoint de pesquisa tem de ser ativado para a sua Organização Verificada. Para isso, tem de enviar um email ao Suporte Verificado, incluindo o seu ID de Organização, para que possam ativar o endpoint por si.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| nome de utilizador | securestring | O nome de usuário para esta api | Verdade |
| palavra-passe | securestring | A senha para esta api | Verdade |
| ID da Empresa | cadeia (de caracteres) | O ID da empresa é fornecido pela Verified. Pode ser encontrado no URL iniciando sessão no app.verified.eu | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar destinatário ao envelope |
Adiciona um destinatário a um determinado envelope. |
| Adicionar documento ao envelope |
Adiciona um novo documento a um envelope existente. |
| Adicionar ficheiro ao documento |
Adiciona um arquivo a um documento existente. |
| Atualizar configurações de envelope |
Atualiza as configurações de um determinado envelope. |
| Atualizar destinatário por id |
Atualiza um destinatário. |
| Atualizar o status de publicação do envelope |
Atualiza o status de publicação de um determinado envelope. |
| Consultar todos os envelopes (Descontinuado) |
Consulta todos os envelopes correspondentes a um determinado filtro. (Preterido) |
| Criar envelope - descritor |
Cria um envelope com base num descritor específico. |
| Criar envelope - padrão |
Cria um novo envelope usando o descritor padrão. |
| Criar link de assinatura |
Cria um link de assinatura. A implementação é específica do fluxo e pode estar faltando para o seu fluxo específico. |
| Definir o status da lixeira do envelope |
Define o status de um determinado envelope como descartado. |
| Definir status de anulação de documento |
Define o status de um determinado documento como anulado. |
| Definir status de anulação de envelope |
Define o status de um determinado envelope como abortado. |
| Enviar notificação |
Envia uma notificação aos recetivos de um determinado envelope. |
| Excluir documento por id |
Exclui um determinado documento. |
| Excluir envelope por id |
Exclui um determinado envelope. |
| Gerar documento a partir do modelo |
Gera um documento a partir de um modelo pré-configurado. |
| Gerar token de segurança |
Obtém o token de autenticação da API verificada. |
| Obter arquivo por id |
Obtém informações sobre um determinado arquivo. |
| Obter configurações do usuário |
Obtém as configurações de um determinado usuário. |
| Obter descritor padrão |
Obtém o descritor padrão para envelopes. |
| Obter descritor por id |
Obtém informações de um determinado descritor. |
| Obter destinatário específico para um envelope |
Obtém um destinatário específico para um determinado envelope. |
| Obter documento por id |
Obtém informações de um determinado documento. |
| Obter empresa por id |
Obtém informações de uma determinada empresa. |
| Obter envelope por id |
Obtém detalhes de um determinado envelope. |
| Obter estado de fluxo por id de envelope |
Obtém o estado de fluxo atual de um determinado envelope. |
| Obter ficheiros por ID de documento |
Obtém todos os arquivos conectados a um determinado documento. |
| Obter informações do usuário |
Obtém informações do usuário conectado no momento. |
| Obter todos os descritores |
Obtém uma lista de todos os descritores presentes na empresa atual. A lista pode ser filtrada. |
| Obter todos os destinatários do envelope |
Obtém todos os destinatários de um determinado envelope. |
| Obter todos os documentos por envelope id |
Obtém todos os documentos relacionados a um determinado envelope. |
| Obter URL do arquivo por id |
Obtém a url para um determinado arquivo. |
| Procure em todos os envelopes |
Pesquise todos os envelopes que correspondam a um determinado filtro. |
Adicionar destinatário ao envelope
Adiciona um destinatário a um determinado envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
Nome Próprio
|
givenName | True | string | |
|
Apelido
|
familyName | True | string | |
|
Linguagem
|
language | True | string | |
|
Método de Assinatura
|
signingMethod | True | string | |
|
Método de notificação
|
notificationMethod | string | ||
|
Correio eletrónico
|
True | string | ||
|
Telefone
|
telephone | string |
O formato deve ser +<número de telefone com código de><país> |
|
|
Encomenda
|
order | integer | ||
|
Ação
|
action | True | string |
Nome verificado da ação que um destinatário deve executar. |
|
Etiqueta
|
label | True | string |
Rótulo para a função/ação de um destinatário |
|
Nome
|
name | True | string |
Nome verificado da função de um destinatário |
|
Secure
|
secure | boolean | ||
|
SMS
|
sms | boolean | ||
|
NSS
|
ssn | string | ||
|
Banco
|
bank | string |
Adicionar documento ao envelope
Adiciona um novo documento a um envelope existente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
Hash
|
hash | integer | ||
|
Nome
|
name | True | string | |
|
Fonte
|
source | string |
Adicionar ficheiro ao documento
Adiciona um arquivo a um documento existente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do documento
|
document-id | True | string |
A identificação do documento em questão |
|
Nome
|
name | True | string | |
|
FileType
|
fileType | True | string | |
|
Hash
|
hash | string |
Devoluções
- Ficheiro
- File
Atualizar configurações de envelope
Atualiza as configurações de um determinado envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
Assinatura sequencial
|
sequentialSigning | boolean | ||
|
Saudação
|
greeting | string | ||
|
Expiração
|
expiration | date |
Data no seguinte formato: 2017-02-26T21:59:59.999Z |
|
|
Lembretes automáticos
|
automaticReminders | number |
X Dias antes do vencimento |
Atualizar destinatário por id
Atualiza um destinatário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do destinatário
|
recipient-id | True | string |
O ID dos destinatários em questão |
|
Nome Próprio
|
givenName | True | string | |
|
Apelido
|
familyName | True | string | |
|
Linguagem
|
language | True | string | |
|
Método de Assinatura
|
signingMethod | True | string | |
|
Método de notificação
|
notificationMethod | string | ||
|
Correio eletrónico
|
True | string | ||
|
Telefone
|
telephone | string |
O formato deve ser +<número de telefone com código de><país> |
|
|
Encomenda
|
order | integer | ||
|
Ação
|
action | True | string |
Nome verificado da ação que um destinatário deve executar. |
|
Etiqueta
|
label | True | string |
Rótulo para a função/ação de um destinatário |
|
Nome
|
name | True | string |
Nome verificado da função de um destinatário |
|
Secure
|
secure | boolean | ||
|
SMS
|
sms | boolean | ||
|
NSS
|
ssn | string | ||
|
Banco
|
bank | string |
Atualizar o status de publicação do envelope
Atualiza o status de publicação de um determinado envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
Publicado
|
published | True | boolean |
Consultar todos os envelopes (Descontinuado)
Consulta todos os envelopes correspondentes a um determinado filtro. (Preterido)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Filtros
|
filters | string |
Consulta de filtro para selecionar subquantidade |
|
|
De
|
from | integer |
A partir da data |
|
|
Limite
|
limit | integer |
Montante limite |
|
|
Ordenar
|
sort | string |
Ordenar por |
Devoluções
- response
- array of EnvelopeDescriptorString
Criar envelope - descritor
Cria um envelope com base num descritor específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
ID do descritor de envelope
|
envelope-descriptor-id | True | string |
Id do descritor do envelope |
|
Email
|
string | |||
|
Nome Próprio
|
givenName | string | ||
|
Apelido
|
familyName | string | ||
|
Lembretes automáticos
|
automaticReminders | number | ||
|
Expiração
|
expiration | string | ||
|
Hash
|
hash | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
uid
|
uid | string |
Criar envelope - padrão
Cria um novo envelope usando o descritor padrão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Email
|
string | |||
|
Nome Próprio
|
givenName | string | ||
|
Apelido
|
familyName | string | ||
|
Lembretes automáticos
|
automaticReminders | number | ||
|
Expiração
|
expiration | string | ||
|
Hash
|
hash | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
uid
|
uid | string |
Criar link de assinatura
Cria um link de assinatura. A implementação é específica do fluxo e pode estar faltando para o seu fluxo específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
Id
|
id | string | ||
|
Redirecionar para
|
redirectTo | uri |
URL completo para redirecionar o usuário para depois do assinar. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL
|
getSignLink.recipient.{recipient-id}.url | string |
Definir o status da lixeira do envelope
Define o status de um determinado envelope como descartado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
Comment
|
comment | string |
Definir status de anulação de documento
Define o status de um determinado documento como anulado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do documento
|
document-id | True | string |
A identificação do documento em questão |
Definir status de anulação de envelope
Define o status de um determinado envelope como abortado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
comentário
|
comment | string |
Enviar notificação
Envia uma notificação aos recetivos de um determinado envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
Saudação
|
greeting | string | ||
|
ID do destinatário
|
id | True | string |
O ID do destinatário para o qual a notificação deve ser enviada. |
Excluir documento por id
Exclui um determinado documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do documento
|
document-id | True | string |
A identificação do documento em questão |
Excluir envelope por id
Exclui um determinado envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
Gerar documento a partir do modelo
Gera um documento a partir de um modelo pré-configurado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do documento
|
document-id | True | string |
A identificação do documento em questão |
|
ID do modelo
|
template-id | True | string |
O Id do modelo que deve ser usado |
|
|
object |
Gerar token de segurança
Obtém o token de autenticação da API verificada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Sem bloqueio de IP
|
withoutIpLock | True | integer |
Se Verificado ativa o Bloqueio de IP (0, padrão) ou não (1) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Símbolo
|
token | string |
Token de acesso |
Obter arquivo por id
Obtém informações sobre um determinado arquivo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do documento
|
document-id | True | string |
A identificação do documento em questão |
|
ID do arquivo
|
file-id | True | string |
O ID do ficheiro em questão |
Devoluções
- Ficheiro
- File
Obter configurações do usuário
Obtém as configurações de um determinado usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
company-id | True | string |
O ID da empresa em questão |
|
ID do Utilizador
|
user-id | True | string |
ID do utilizador em questão |
Devoluções
- Body
- Setting
Obter descritor padrão
Obtém o descritor padrão para envelopes.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Filtros
|
filters | string |
Consulta de filtro para selecionar subquantidade |
Devoluções
- Descritor
- Descriptor
Obter descritor por id
Obtém informações de um determinado descritor.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
ID do descritor de envelope
|
envelope-descriptor-id | True | string |
Id do descritor do envelope |
Devoluções
- Descritor
- Descriptor
Obter destinatário específico para um envelope
Obtém um destinatário específico para um determinado envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do destinatário
|
recipient-id | True | string |
O ID dos destinatários em questão |
Devoluções
- Recipient
- Recipient
Obter documento por id
Obtém informações de um determinado documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do documento
|
document-id | True | string |
A identificação do documento em questão |
Devoluções
- Documento
- Document
Obter empresa por id
Obtém informações de uma determinada empresa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
company-id | True | string |
O ID da empresa em questão |
Devoluções
- Empresa
- Company
Obter envelope por id
Obtém detalhes de um determinado envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
Devoluções
- Envelope
- Envelope
Obter estado de fluxo por id de envelope
Obtém o estado de fluxo atual de um determinado envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do fluxo
|
flow-id | True | string |
ID do fluxo em questão |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Símbolo
|
token | string |
Obter ficheiros por ID de documento
Obtém todos os arquivos conectados a um determinado documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do documento
|
document-id | True | string |
A identificação do documento em questão |
Devoluções
- response
- array of File
Obter informações do usuário
Obtém informações do usuário conectado no momento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
Devoluções
- Body
- UserInfo
Obter todos os descritores
Obtém uma lista de todos os descritores presentes na empresa atual. A lista pode ser filtrada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Filtros
|
filters | string |
Consulta de filtro para selecionar subquantidade |
Devoluções
- response
- array of Descriptor
Obter todos os destinatários do envelope
Obtém todos os destinatários de um determinado envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
Devoluções
- response
- array of Recipient
Obter todos os documentos por envelope id
Obtém todos os documentos relacionados a um determinado envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
Devoluções
- response
- array of Document
Obter URL do arquivo por id
Obtém a url para um determinado arquivo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Envelope Id
|
envelope-id | True | string |
Identificação do envelope em questão |
|
ID do documento
|
document-id | True | string |
A identificação do documento em questão |
|
ID do arquivo
|
file-id | True | string |
O ID do ficheiro em questão |
|
Como objeto
|
asObject | boolean |
Define se a resposta é um objeto |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL
|
url | string |
URL do ficheiro |
Procure em todos os envelopes
Pesquise todos os envelopes que correspondam a um determinado filtro.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Token recebido da ação 'Gerar token de segurança' |
|
ID da Empresa
|
x-namespace | string |
O ID da empresa que deve ser usado para a ação. Formato /empresas/<ID da> empresa. O padrão é o ID da empresa de conexões se não estiver definido. |
|
|
Filtros
|
filters | string |
Consulta de filtro para selecionar subquantidade |
|
|
De
|
from | integer |
A partir da data |
|
|
Limite
|
limit | integer |
Montante limite |
|
|
Ordenar
|
sort | string |
Ordenar por |
Devoluções
- response
- array of EnvelopeDescriptorString
Definições
Configuração
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Global
|
global | string | |
|
Língua signatária
|
preferences.signatoryLanguage | string | |
|
Saudação
|
preferences.greeting | string | |
|
Método de Assinatura
|
preferences.signingMethod | string | |
|
Deslocamento de lembrete
|
preferences.reminderOffset | string |
Informações do usuário
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome Próprio
|
givenName | string | |
|
Apelido
|
familyName | string | |
|
Email
|
string | ||
|
Linguagem
|
metadata.language | string | |
|
Palavra-passe em falta
|
missingPassword | boolean | |
|
Está ativado
|
isEnabled | boolean | |
|
Namespace
|
namespace | string | |
|
Ativado(a)
|
enabled | boolean | |
|
UID
|
uid | string | |
|
Id
|
id | string | |
|
Funções
|
roles | array of Role | |
|
Validated
|
validated | boolean |
Empresa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string | |
|
Número de registo
|
regNumber | string | |
|
Criado
|
created | string | |
|
Modificado
|
modified | string | |
|
Address
|
address | string | |
|
City
|
city | string | |
|
Código Postal
|
zipCode | string | |
|
Logótipo
|
logo | string | |
|
Country
|
country | string | |
|
UId
|
uid | string | |
|
Id
|
id | string |
Recipient
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
UID
|
uid | string |
UID do destinatário |
|
Namespace
|
namespace | string |
Namespace do destinatário |
|
Criado
|
created | string |
Destinatário criado |
|
Funções
|
role | RoleActionString | |
|
Apelido
|
familyName | string |
Sobrenome do destinatário |
|
Nome Próprio
|
givenName | string |
Nome do destinatário Frist |
|
Linguagem
|
language | string |
Idioma do destinatário |
|
Email
|
string |
E-mail do destinatário |
|
|
Método de Assinatura
|
signingMethod | string |
Destinatário Assinatura Methid |
|
Método de notificação
|
notificationMethod | string | |
|
Encomenda
|
order | integer |
Ordem do destinatário |
|
Id
|
id | string |
ID do destinatário |
|
Modificado
|
modified | string |
Destinatário modificado |
|
Notificado
|
notified | boolean | |
|
Concluído
|
completed | boolean | |
|
demandAttachment
|
demandAttachment | boolean | |
|
NSS
|
ssn | string | |
|
Banco
|
bank | string | |
|
Secure
|
secure | boolean | |
|
SMS
|
sms | boolean | |
|
Telefone
|
telephone | string | |
|
Assinaturas
|
signatures | object | |
|
Notifications
|
notifications | array of Notification |
Funções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
action.type | string | |
|
Metodologia
|
action.methods | array of string | |
|
Etiqueta
|
label | string |
Etiqueta |
|
Núm. Max
|
numMax | integer |
Núm. Max |
|
Núm. Minuto
|
numMin | integer |
Núm. Minuto |
|
Nome do Direito de Acesso
|
roleName | string |
RoleActionString
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Ação
|
action | ActionString |
Ação |
|
Etiqueta
|
label | string |
Etiqueta |
|
Núm. Max
|
numMax | integer |
Núm. Max |
|
Núm. Minuto
|
numMin | integer |
Núm. Minuto |
|
Nome do Direito de Acesso
|
roleName | string |
ActionString
Envelope
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
Envelope Id |
|
UID
|
uid | string |
Envelope UID |
|
Namespace
|
namespace | string |
Espaço de Nomes de Envelope |
|
Versão
|
version | integer |
Versão do envelope |
|
Publicado
|
published | boolean |
Envelope Publicado |
|
Complete
|
completed | boolean |
Envelope Concluído |
|
Abortada
|
aborted | boolean |
Envelope Avorted |
|
Destruído
|
trashed | boolean |
Envelope Destruído |
|
Assinatura sequencial
|
sequentialSigning | boolean | |
|
Lembretes Autmatic
|
automaticReminders | integer | |
|
Criado
|
created | string |
Envelope criado |
|
Modificado
|
modified | string |
Envelope modificado |
|
Fora do prazo
|
expired | boolean |
Envelope expirado |
|
Flow
|
flow | Flow | |
|
Descritor
|
descriptor | Descriptor | |
|
Pessoa
|
sender | Person | |
|
Documents
|
documents | array of Document | |
|
Destinatários
|
recipients | array of Recipient | |
|
Etiquetas
|
tags | array of object | |
|
Proprietários
|
owners | array of Person |
EnvelopeDescriptorString
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
Envelope Id |
|
UID
|
uid | string |
Envelope UID |
|
Namespace
|
namespace | string |
Espaço de Nomes de Envelope |
|
Versão
|
version | integer |
Versão do envelope |
|
Publicado
|
published | boolean |
Envelope Publicado |
|
Complete
|
completed | boolean |
Envelope Concluído |
|
Abortada
|
aborted | boolean |
Envelope Avorted |
|
Destruído
|
trashed | boolean |
Envelope Destruído |
|
Assinatura sequencial
|
sequentialSigning | boolean | |
|
Lembretes Autmatic
|
automaticReminders | integer | |
|
Criado
|
created | string |
Envelope criado |
|
Modificado
|
modified | string |
Envelope modificado |
|
Fora do prazo
|
expired | boolean |
Envelope expirado |
|
Flow
|
flow | Flow | |
|
Descritor
|
descriptor | string |
Descritor de envelope |
|
Pessoa
|
sender | Person | |
|
Documents
|
documents | array of Document | |
|
Destinatários
|
recipients | array of Recipient | |
|
Etiquetas
|
tags | array of object | |
|
Proprietários
|
owners | array of Person |
Ficheiro
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
ID do arquivo |
|
URL
|
url | string |
URL do ficheiro |
|
Nome
|
name | string |
Nome do arquivo |
|
MimeType
|
mimeType | string | |
|
Tipo de Arquivo:
|
fileType | string | |
|
Caminho de armazenamento
|
storagePath | string | |
|
Carregado em
|
uploadedAt | string | |
|
Criado
|
created | string |
Arquivo criado |
|
Proprietários
|
owners | array of object | |
|
UID
|
owners.uid | string |
Proprietário do arquivo UID |
|
Id
|
owners._id | string |
ID do proprietário do arquivo |
|
Namespace
|
namespace | string | |
|
UID
|
uid | string |
UID do arquivo |
Flow
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
ID do fluxo |
|
Nome
|
name | string |
Nome do fluxo |
Descritor
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
Nome do descritor |
|
Versão
|
version | integer |
Versão do descritor |
|
UID
|
uid | string |
Descritor UID |
|
Suprimido
|
deleted | boolean |
Descritor Deletd |
|
Public
|
public | boolean |
Descritor Público |
|
Fora do prazo
|
expired | boolean |
Descritor expirado |
|
Id
|
id | string |
ID do descritor |
|
Mandatory
|
mandatory | boolean |
Descritor Obrigatório |
|
Etiqueta
|
label | string |
Rótulo do descritor |
|
Tipo
|
type | string |
Tipo de descritor |
|
Funções
|
roles | array of Role | |
|
Proprietários
|
owners | array of Person | |
|
Flow
|
flow | Flow | |
|
defaultValues
|
defaultValues | DefaultValues |
defaultValues |
|
Instances
|
instances | array of object |
Pessoa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
UID
|
uid | string |
Pessoa UID |
|
Nome Próprio
|
givenName | string |
Nome da Pessoa |
|
Apelido
|
familyName | string |
Apelido da Pessoa |
|
Email
|
string |
E-mail da pessoa |
|
|
Linguagem
|
language | string |
Língua da pessoa |
|
Encomenda
|
order | integer |
Ordem Pessoal |
Documento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Etiqueta
|
label | string |
Rótulo do documento |
|
Tipo
|
type | string |
Tipo de documento |
|
Hash
|
hash | integer |
Hash do documento |
|
Núm. Max
|
numMax | integer |
Númplice do documento. Max |
|
Núm. Minuto
|
numMin | integer |
Númplice do documento. Minuto |
|
UID
|
uid | string |
UID do documento |
|
Namespace
|
namespace | string |
Namespace do documento |
|
Fonte
|
source | string |
Origem do documento |
|
Criado
|
created | string |
Documento criado |
|
Nome
|
name | string |
Nome do documento |
|
Id
|
id | string |
ID do documento |
|
Modificado
|
modified | string |
Documento modificado |
|
Rejeitado
|
rejected | boolean |
Documento rejeitado |
|
Assinatura
|
signed | boolean |
Documento assinado |
|
Destruído
|
trashed | boolean |
Documento descartado |
|
Abortada
|
aborted | boolean |
Documento anulado |
|
Versão
|
version | integer |
Versão do documento |
|
attachments
|
attachments | array of Attachment | |
|
Flow
|
flow | Flow | |
|
roles
|
roles | array of Role | |
|
Template
|
template | Template | |
|
Descritor
|
descriptor | Descriptor | |
|
Assinaturas
|
signatures | array of Signature |
Attachment
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Etiqueta
|
label | string |
Etiqueta de anexo |
|
Núm. Max
|
numMax | integer |
Númplice de anexo. Max |
|
Núm. Minuto
|
numMin | integer |
Anexo Num.Min |
|
Hash
|
hash | integer |
Hash de anexo |
Template
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
type | string |
Tipo de modelo |
|
HTML
|
html | string | |
|
PDFHTML
|
pdfHtml | string | |
|
Id
|
id | string | |
|
UID
|
uid | string | |
|
Namespace
|
namespace | string | |
|
Versão
|
version | integer | |
|
Criado
|
created | string | |
|
Modificado
|
modified | string | |
|
Modificado
|
published | boolean | |
|
Concluído
|
completed | boolean | |
|
Abortada
|
aborted | boolean |
Signature
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string | |
|
Origem
|
origin | string | |
|
Nome Próprio
|
givenName | string |
Nome Próprio |
|
Apelido
|
familyName | string |
Apelido |
|
Email
|
string |
|
|
|
IP
|
ip | string | |
|
Date
|
date | string | |
|
Situação
|
status | string | |
|
Comment
|
comment | string |
DefaultValues
defaultValues
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Pessoa
|
signer | Person | |
|
Pessoa
|
reviewer | Person |
Notification
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string | |
|
UID
|
uid | string | |
|
Namespace
|
namespace | string | |
|
Situação
|
status | string | |
|
Encomenda
|
order | integer | |
|
Detalhes
|
details | object | |
|
Date
|
date | string |