Verificado(a)

Conector da API Verificada para habilitar a criação de processos personalizados de assinatura de documentos.

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	Verificado(a)
URL	https://verified.eu/en/#about-us
Email	support@verified.eu

Metadados do conector
Publicador	Crm - Konsulterna i Sverige AB
Site	https://verified.eu/
Política de privacidade	https://verified.eu/trust-center
Categorias	Conteúdo e arquivos; Produtividade

Verificado é um provedor de software como serviço de identificação eletrônica e assinatura digital. Esse conector possibilita a integração à API do Verified e a criação de processos de assinatura simples e intuitivos em seu aplicativo.

Pré-requisitos

Você precisará do seguinte para continuar:

Inscrever-se para uma conta verificada

Como obter credenciais

Esse conector usa a Autenticação Básica. O usuário precisa apresentar o nome de usuário, a senha e a ID da empresa ao criar uma conexão. O nome de usuário e a senha são os mesmos que você usa para fazer logon no portal verificado. Para obter a ID da empresa, você precisa fazer logon no portal verificado, selecione a empresa correta se você tiver várias e copie a ID da empresa da 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 no Verified 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 o status de publicação para envelope. As ações comuns usadas para verificar o status verificado dos documentos incluem Obter envelope por ID, Obter todos os documentos por ID do envelope, Obter arquivos por ID do documento, Obter URL do 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 e limitações conhecidos

As limitações a seguir são conhecidas no momento.

No início de cada fluxo, é preciso criar um token de autenticação para ser reutilizado em cada etapa a seguir.
Para adicionar um documento, é preciso enviar uma solicitação HTTP para uma determinada URL.
Para usar o novo ponto de extremidade de Pesquisa, ele precisa ser ativado para a conta por meio do Suppoert Verificado.

perguntas frequentes

Como fazer para carregar um documento no Verified?

Para carregar um documento real, você precisa criar um arquivo na API verificada e carregar o hash do documento na URL do blob respondida da API verificada.

Como fazer para obter o envelope depois de usar a ação Obter ID envelope?

As etapas que criam um envelope respondem com uma uid, que é um caminho completo para o envelope (exemplo: "/envelopes/ABCDE"). Para outras etapas, é necessário apenas a última parte da uid (que é a ID real do envelope, em nosso exemplo "ABCDE").

Aqui está um exemplo de como fazer isso

substring(outputs('Create_new_default_envelope')?['body/uid'],11)

Como fazer 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"). Somente a ID do documento (em nosso caso: FGHIJ) é necessária para as seguintes etapas.

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 fazer para obter a ID do Fluxo de um envelope?

Quando se carrega informações sobre um envelope, o fluxo relacionado fará parte da resposta (exemplo: "/flow/default"). Na resposta, ela é chamada de id de um fluxo, no entanto, uma precisa apenas da última parte quando outra etapa (como Obter status de fluxo) está solicitando a 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 Pesquisar?

Para poder usar a nova ação de pesquisa, o ponto de extremidade de pesquisa precisa ser ativado para sua Organização Verificada. Para fazer isso, você precisa escrever um email para o Suporte Verificado, incluindo sua ID da Organização para que eles possam ativar o ponto de extremidade para você.

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
nome de usuário	secureString	O nome de usuário para esta api	Verdade
senha	secureString	A senha dessa api	Verdade
ID da Empresa	cadeia	A ID da empresa é fornecida pelo Verified. Pode ser encontrado na URL fazendo logon no app.verified.eu	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Adicionar arquivo ao documento	Adiciona um arquivo a um documento existente.
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.
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 (preterido)	Consulta todos os envelopes que correspondem a um determinado filtro. (Preterido)
Criar envelope – descritor	Cria um envelope com base em um 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 ausente para seu fluxo específico.
Definir o status de anulação do documento	Define o status de um determinado documento a ser anulado.
Definir o status de anulação do envelope	Define o status de um determinado envelope a ser anulado.
Definir o status do lixo do envelope	Define o status de um determinado envelope como destruído.
Enviar notificação	Envia uma notificação aos recepientes 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 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 arquivos por ID do documento	Obtém todos os arquivos conectados a um determinado documento.
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 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 informações do usuário	Obtém informações do usuário conectado no momento.
Obter o estado do fluxo por ID do envelope	Obtém o estado de fluxo atual de um determinado envelope.
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 ID do envelope	Obtém todos os documentos relacionados a um determinado envelope.
Obter um destinatário específico para um envelope	Obtém um destinatário específico para um determinado envelope.
Obter URL do arquivo por id	Obtém a URL para um determinado arquivo.
Pesquisar todos os envelopes	Pesquise todos os envelopes correspondentes a um determinado filtro.

Adicionar arquivo ao documento

ID da operação:: PostEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Adiciona um arquivo a um documento existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do documento	document-id	True	string	A ID do documento em questão
Nome	name	True	string
FileType	fileType	True	string
Hash	hash		string

Retornos

File: File

Adicionar destinatário ao envelope

ID da operação:: PostEnvelopesEnvelopeIdRecipients

Adiciona um destinatário a um determinado envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
Primeiro Nome	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
Email	email	True	string
Telefone	telephone		string	O formato deve ser +<countryCode><telephonenumber>
Pedido	order		integer
Ação	action	True	string	O nome 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
CPF	ssn		string
Banco	bank		string

Adicionar documento ao envelope

ID da operação:: PostEnvelopesEnvelopeIdDocuments

Adiciona um novo documento a um envelope existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
Hash	hash		integer
Nome	name	True	string
Source	source		string

Atualizar configurações de envelope

ID da operação:: PutEnvelopesEnvelopeId

Atualiza as configurações de um determinado envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
Assinatura sequencial	sequentialSigning		boolean
Saudação	greeting		string
Vencimento	expiration		date	Data no seguinte formato 2017-02-26T21:59:59.999Z
Lembretes automáticos	automaticReminders		number	X Dias antes da expiração

Atualizar destinatário por id

ID da operação:: PutEnvelopesEnvelopeIdRecipientsRecipientId

Atualiza um destinatário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do destinatário	recipient-id	True	string	A ID dos destinatários em questão
Primeiro Nome	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
Email	email	True	string
Telefone	telephone		string	O formato deve ser +<countryCode><telephonenumber>
Pedido	order		integer
Ação	action	True	string	O nome 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
CPF	ssn		string
Banco	bank		string

Atualizar o status de publicação do envelope

ID da operação:: PutEnvelopesEnvelopeIdPublishStatus

Atualiza o status de publicação de um determinado envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
Publicado	published	True	boolean

Consultar todos os envelopes (preterido)

ID da operação:: GetQueryEnvelopes

Consulta todos os envelopes que correspondem a um determinado filtro. (Preterido)

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Filtros	filters		string	Filtrar consulta para selecionar subamount
De	from		integer	A partir da data
Limit	limit		integer	Valor de limite
Classificar	sort		string	Classificar por

Retornos

response: array of EnvelopeDescriptorString

Criar envelope – descritor

ID da operação:: PostEnvelopeDescriptorsEnvelopeDescriptorIdEnvelopes

Cria um envelope com base em um descritor específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
ID do Descritor de Envelope	envelope-descriptor-id	True	string	ID do Descritor de Envelope
Email	email		string
Primeiro Nome	givenName		string
Apelido	familyName		string
Lembretes automáticos	automaticReminders		number
Vencimento	expiration		string
Hash	hash		string

Retornos

Nome	Caminho	Tipo	Description
uid	uid	string

Criar envelope – padrão

ID da operação:: PostEnvelopeDescriptorsDefaultEnvelopes

Cria um novo envelope usando o descritor padrão.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Email	email		string
Primeiro Nome	givenName		string
Apelido	familyName		string
Lembretes automáticos	automaticReminders		number
Vencimento	expiration		string
Hash	hash		string

Retornos

Nome	Caminho	Tipo	Description
uid	uid	string

Criar link de assinatura

ID da operação:: PostEnvelopesEnvelopeIdJobsGetSignLink

Cria um link de assinatura. A implementação é específica do fluxo e pode estar ausente para seu fluxo específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID	id		string
Redirecionar para	redirectTo		uri	URL completa para redirecionar o usuário para depois do sinal.

Retornos

Nome	Caminho	Tipo	Description
URL	getSignLink.recipient.{recipient-id}.url	string

Definir o status de anulação do documento

ID da operação:: PostEnvelopesEnvelopeIdDocumentsDocumentIdStatusAborted

Define o status de um determinado documento a ser anulado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do documento	document-id	True	string	A ID do documento em questão

Definir o status de anulação do envelope

ID da operação:: PutEnvelopesEnvelopeIdAbortStatus

Define o status de um determinado envelope a ser anulado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
comentário	comment		string

Definir o status do lixo do envelope

ID da operação:: PutEnvelopesEnvelopeIdTrashStatus

Define o status de um determinado envelope como destruído.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
Comment	comment		string

Enviar notificação

ID da operação:: PostEnvelopesEnvelopIdJobsSendNotification

Envia uma notificação aos recepientes de um determinado envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
Saudação	greeting		string
ID do destinatário	id	True	string	A ID do destinatário para o qual a notificação deve ser enviada.

Excluir documento por ID

ID da operação:: DeleteEnvelopesEnvelopeIdDocumentsDocumentId

Exclui um determinado documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do documento	document-id	True	string	A ID do documento em questão

Excluir envelope por ID

ID da operação:: DeleteEnvelopesEnvelopeId

Exclui um determinado envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão

Gerar documento a partir do modelo

ID da operação:: PostEnvelopesEnvelopeIdDocumentsDocumentIdTemplatesTemplateIdUserData

Gera um documento de um modelo pré-configurado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do documento	document-id	True	string	A ID do documento em questão
ID do modelo	template-id	True	string	A ID do modelo que deve ser usado
			object

Gerar token de segurança

ID da operação:: PostAuthenticate

Obtém o token de autenticação da API Verificada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Sem bloqueio de IP	withoutIpLock	True	integer	Se verificado ativa o bloqueio IP (0, padrão) ou não (1)

Retornos

Nome	Caminho	Tipo	Description
Símbolo	token	string	Token de acesso

Obter arquivo por id

ID da operação:: GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileId

Obtém informações sobre um determinado arquivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do documento	document-id	True	string	A ID do documento em questão
ID do arquivo	file-id	True	string	A ID do arquivo em questão

Retornos

File: File

Obter arquivos por ID do documento

ID da operação:: GetEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Obtém todos os arquivos conectados a um determinado documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do documento	document-id	True	string	A ID do documento em questão

Retornos

response: array of File

Obter configurações do usuário

ID da operação:: GetCompaniesCompanyIdUsersUserIdSettings

Obtém as configurações de um determinado usuário.

Parâmetros

Nome	Chave	Obrigató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	A ID da empresa em questão
Identificação de usuário	user-id	True	string	ID do usuário em questão

Retornos

Corpo: Setting

Obter descritor padrão

ID da operação:: GetEnvelopeDescriptorsDefault

Obtém o descritor padrão para envelopes.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Filtros	filters		string	Filtrar consulta para selecionar subamount

Retornos

Descritor: Descriptor

Obter descritor por id

ID da operação:: GetEnvelopeDescriptorsEnvelopeDescriptorId

Obtém informações de um determinado descritor.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
ID do Descritor de Envelope	envelope-descriptor-id	True	string	ID do Descritor de Envelope

Retornos

Descritor: Descriptor

Obter documento por id

ID da operação:: GetEnvelopesEnvelopeIdDocumentsDocumentId

Obtém informações de um determinado documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do documento	document-id	True	string	A ID do documento em questão

Retornos

Documento: Document

Obter empresa por ID

ID da operação:: GetCompaniesCompanyId

Obtém informações de uma determinada empresa.

Parâmetros

Nome	Chave	Obrigató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	A ID da empresa em questão

Retornos

Empresa: Company

Obter envelope por ID

ID da operação:: GetEnvelopesEnvelopeId

Obtém detalhes de um determinado envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão

Retornos

Envelope: Envelope

Obter informações do usuário

ID da operação:: GetAuthUserinfo

Obtém informações do usuário conectado no momento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'

Retornos

Corpo: UserInfo

Obter o estado do fluxo por ID do envelope

ID da operação:: GetFlowsFlowIdJobsEnvelopeId

Obtém o estado de fluxo atual de um determinado envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do fluxo	flow-id	True	string	ID do fluxo em questão

Retornos

Nome	Caminho	Tipo	Description
Símbolo	token	string

Obter todos os descritores

ID da operação:: GetEnvelopeDescriptors

Obtém uma lista de todos os descritores presentes na empresa atual. A lista pode ser filtrada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Filtros	filters		string	Filtrar consulta para selecionar subamount

Retornos

response: array of Descriptor

Obter todos os destinatários do envelope

ID da operação:: GetEnvelopesEnvelopeIdRecipients

Obtém todos os destinatários de um determinado envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão

Retornos

response: array of Recipient

Obter todos os documentos por ID do envelope

ID da operação:: GetEnvelopesEnvelopeIdDocuments

Obtém todos os documentos relacionados a um determinado envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão

Retornos

response: array of Document

Obter um destinatário específico para um envelope

ID da operação:: GetEnvelopesEnvelopeIdRecipientsRecipientId

Obtém um destinatário específico para um determinado envelope.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do destinatário	recipient-id	True	string	A ID dos destinatários em questão

Retornos

Recipient: Recipient

Obter URL do arquivo por id

ID da operação:: GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileIdUrl

Obtém a URL para um determinado arquivo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Envelope Id	envelope-id	True	string	ID do envelope em questão
ID do documento	document-id	True	string	A ID do documento em questão
ID do arquivo	file-id	True	string	A ID do arquivo em questão
Como objeto	asObject		boolean	Define se a resposta é um objeto

Retornos

Nome	Caminho	Tipo	Description
URL	url	string	URL do Arquivo

Pesquisar todos os envelopes

ID da operação:: GetSearchEnvelopes

Pesquise todos os envelopes correspondentes a um determinado filtro.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Símbolo	token	True	string	Token recebido da ação 'Gerar token de segurança'
ID da Empresa	x-namespace		string	A ID da empresa que deve ser usada para a ação. Formatar /companies/<id> da empresa. O padrão é a ID da empresa de conexões se não for definida.
Filtros	filters		string	Filtrar consulta para selecionar subamount
De	from		integer	A partir da data
Limit	limit		integer	Valor de limite
Classificar	sort		string	Classificar por

Retornos

response: array of EnvelopeDescriptorString

Definições

Configurações

Nome	Caminho	Tipo
Global	global	string
Idioma signatário	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

Nome	Caminho	Tipo
Primeiro Nome	givenName	string
Apelido	familyName	string
Email	email	string
Linguagem	metadata.language	string
Senha ausente	missingPassword	boolean
Está habilitado	isEnabled	boolean
Namespace	namespace	string
Enabled	enabled	boolean
UID	uid	string
ID	id	string
Funções	roles	array of Role
Validated	validated	boolean

Empresa

Nome	Caminho	Tipo
Nome	name	string
Reg. Number	regNumber	string
Criado	created	string
Modificado	modified	string
Endereço	address	string
City	city	string
Código Postal	zipCode	string
Logotipo	logo	string
País	country	string
UID	uid	string
ID	id	string

Recipient

Nome	Caminho	Tipo	Description
UID	uid	string	UID do destinatário
Namespace	namespace	string	Namespace do destinatário
Criado	created	string	Destinatário criado
Função	role	RoleActionString
Apelido	familyName	string	Sobrenome do destinatário
Primeiro Nome	givenName	string	Nome do frist do destinatário
Linguagem	language	string	Idioma do destinatário
Email	email	string	Email do destinatário
Método de Assinatura	signingMethod	string	Methid de assinatura do destinatário
Método de notificação	notificationMethod	string
Pedido	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
CPF	ssn	string
Banco	bank	string
Secure	secure	boolean
SMS	sms	boolean
Telefone	telephone	string
Assinaturas	signatures	object
Notifications	notifications	array of Notification

Função

Nome	Caminho	Tipo	Description
Tipo	action.type	string
Métodos	action.methods	array of string
Etiqueta	label	string	Etiqueta
Núm. Máximo	numMax	integer	Núm. Máximo
Núm. Minuto	numMin	integer	Núm. Minuto
Nome da Função	roleName	string

RoleActionString

Nome	Caminho	Tipo	Description
Ação	action	ActionString	Ação
Etiqueta	label	string	Etiqueta
Núm. Máximo	numMax	integer	Núm. Máximo
Núm. Minuto	numMin	integer	Núm. Minuto
Nome da Função	roleName	string

ActionString

Ação

Ação: string

Envelope

Nome	Caminho	Tipo	Description
ID	id	string	Envelope Id
UID	uid	string	Envelope UID
Namespace	namespace	string	Envelope Namespace
Versão	version	integer	Versão do envelope
Publicado	published	boolean	Envelope Publicado
Concluir	completed	boolean	Envelope concluído
Anulada	aborted	boolean	Envelope avorado
Destruiu	trashed	boolean	Envelope Destruído
Assinatura sequencial	sequentialSigning	boolean
Lembretes autáticos	automaticReminders	integer
Criado	created	string	Envelope Criado
Modificado	modified	string	Envelope modificado
Expirado	expired	boolean	Envelope expirado
Flow	flow	Flow
Descritor	descriptor	Descriptor
Pessoa	sender	Person
Documentos	documents	array of Document
Destinatários	recipients	array of Recipient
Etiquetas	tags	array of object
Proprietários	owners	array of Person

EnvelopeDescriptorString

Nome	Caminho	Tipo	Description
ID	id	string	Envelope Id
UID	uid	string	Envelope UID
Namespace	namespace	string	Envelope Namespace
Versão	version	integer	Versão do envelope
Publicado	published	boolean	Envelope Publicado
Concluir	completed	boolean	Envelope concluído
Anulada	aborted	boolean	Envelope avorado
Destruiu	trashed	boolean	Envelope Destruído
Assinatura sequencial	sequentialSigning	boolean
Lembretes autáticos	automaticReminders	integer
Criado	created	string	Envelope Criado
Modificado	modified	string	Envelope modificado
Expirado	expired	boolean	Envelope expirado
Flow	flow	Flow
Descritor	descriptor	string	Descritor de envelope
Pessoa	sender	Person
Documentos	documents	array of Document
Destinatários	recipients	array of Recipient
Etiquetas	tags	array of object
Proprietários	owners	array of Person

File

Nome	Caminho	Tipo	Description
ID	id	string	ID do arquivo
URL	url	string	URL do Arquivo
Nome	name	string	Nome do Arquivo
Tipo MIME	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	UID do proprietário do arquivo
ID	owners._id	string	ID do proprietário do arquivo
Namespace	namespace	string
UID	uid	string	UID do arquivo

Flow

Nome	Caminho	Tipo	Description
ID	id	string	ID do fluxo
Nome	name	string	Nome do fluxo

Descritor

Nome	Caminho	Tipo	Description
Nome	name	string	Nome do descritor
Versão	version	integer	Versão do descritor
UID	uid	string	UID do descritor
Excluído(a)	deleted	boolean	Descritor Deletd
Público	public	boolean	Descritor Público
Expirado	expired	boolean	Descritor expirado
ID	id	string	ID do descritor
Obrigatório	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
Instâncias	instances	array of object

Pessoa

Nome	Caminho	Tipo	Description
UID	uid	string	UID de pessoa
Primeiro Nome	givenName	string	Nome da pessoa
Apelido	familyName	string	Sobrenome da Pessoa
Email	email	string	Email de pessoa
Linguagem	language	string	Linguagem de Pessoa
Pedido	order	integer	Pedido de Pessoa

Documento

Nome	Caminho	Tipo	Description
Etiqueta	label	string	Rótulo do documento
Tipo	type	string	Tipo de documento
Hash	hash	integer	Hash do documento
Núm. Máximo	numMax	integer	Número do Documento. Máximo
Núm. Minuto	numMin	integer	Número do Documento. Minuto
UID	uid	string	UID do documento
Namespace	namespace	string	Namespace do documento
Source	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
Rejected	rejected	boolean	Documento rejeitado
Assinado	signed	boolean	Documento assinado
Destruiu	trashed	boolean	Documento destruído
Anulada	aborted	boolean	Documento Anulado
Versão	version	integer	Versão do documento
attachments	attachments	array of Attachment
Flow	flow	Flow
funções	roles	array of Role
Template	template	Template
Descritor	descriptor	Descriptor
Assinaturas	signatures	array of Signature

Anexo

Nome	Caminho	Tipo	Description
Etiqueta	label	string	Rótulo de anexo
Núm. Máximo	numMax	integer	Núm do anexo. Máximo
Núm. Minuto	numMin	integer	Anexo Num.Min
Hash	hash	integer	Hash de anexo

Template

Nome	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
Anulada	aborted	boolean

Signature

Nome	Caminho	Tipo	Description
ID	id	string
Origin	origin	string
Primeiro Nome	givenName	string	Primeiro Nome
Apelido	familyName	string	Apelido
Email	email	string	Email
IP	ip	string
Date	date	string
Situação	status	string
Comment	comment	string

DefaultValues

defaultValues

Nome	Caminho	Tipo	Description
Pessoa	signer	Person
Pessoa	reviewer	Person

Notification

Nome	Caminho	Tipo
ID	id	string
UID	uid	string
Namespace	namespace	string
Situação	status	string
Pedido	order	integer
Detalhes	details	object
Date	date	string

Compartilhar via

Verificado(a)

Pré-requisitos

Como obter credenciais

Introdução

Problemas e limitações conhecidos

perguntas frequentes

Como fazer para carregar um documento no Verified?

Como fazer para obter o envelope depois de usar a ação Obter ID envelope?

Como fazer para obter a ID do documento depois de usar a ação Adicionar documento ao envelope?

Como fazer para obter a ID do Fluxo de um envelope?

Como posso usar a nova ação Pesquisar?

Criando uma conexão

Padrão

Limitações

Ações

Adicionar arquivo ao documento

Parâmetros

Retornos

Adicionar destinatário ao envelope

Parâmetros

Adicionar documento ao envelope

Parâmetros

Atualizar configurações de envelope

Parâmetros

Atualizar destinatário por id

Parâmetros

Atualizar o status de publicação do envelope

Parâmetros

Consultar todos os envelopes (preterido)

Parâmetros

Retornos

Criar envelope – descritor

Parâmetros

Retornos

Criar envelope – padrão

Parâmetros

Retornos

Criar link de assinatura

Parâmetros

Retornos

Definir o status de anulação do documento

Parâmetros

Definir o status de anulação do envelope

Parâmetros

Definir o status do lixo do envelope

Parâmetros

Enviar notificação

Parâmetros

Excluir documento por ID

Parâmetros

Excluir envelope por ID

Parâmetros

Gerar documento a partir do modelo

Parâmetros

Gerar token de segurança

Parâmetros

Retornos

Obter arquivo por id

Parâmetros

Retornos

Obter arquivos por ID do documento

Parâmetros

Retornos

Obter configurações do usuário

Parâmetros

Retornos

Obter descritor padrão

Parâmetros

Retornos

Obter descritor por id

Parâmetros

Retornos

Obter documento por id

Parâmetros

Retornos

Obter empresa por ID

Parâmetros

Retornos

Obter envelope por ID