Através deste guia, demonstraremos como reenviar um envelope através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de reenviar um envelope a partir de seu UUID.
Antes de iniciar sua integração:
Certifique-se que você possui credenciais válidas para utilizar o Unico Sign. Se você ainda não possui suas credenciais, siga nosso guia de Primeiros Passos para configurar sua conta de teste e obter suas chaves de API.
Entenda os conceitos básicos sobre nosso produto. É extremamente importante que você entenda estes conceitos para fazer uma boa utilização das APIs do Unico Sign. Você pode encontrar nossos conceitos básicos neste guia.
Como explicamos em nosso guia de conceitos básicos, nossa entidade Envelope (envelope) é a representação virtual de um envelope com documentos na vida real. Ele é o objeto que agrupa todos os documentos (document) e seus assinantes (subscriber), sendo que um envelope pode conter mais de documento, que por sua vez pode conter um ou mais assinantes.
Disponibilizamos este end-point para reenviar os envelopes (ainda pendentes de assinatura) para seus assinantes, podendo inclusive informar um novo e-mail ou telefone.
Fluxo de assinatura dentro de um frame
Envelopes criados com a opção isFrame=True não podem ser reenviados.
Entenda, a seguir, como chamar nossa API REST para reenviar um envelope.
Para efetuar requisições à nossa API REST você necessitará de um token de acesso OAuth válido. Caso não esteja familiarizado com o modelo de autenticação OAuth, entenda como gerar um token válido neste artigo. Após sua geração, o token de acesso deverá ser enviado no header de sua requisição, junto ao parâmetro Authorization.
Ambientes
Ao iniciar sua integração você receberá credenciais a nosso ambiente de homologação. Somente após o processo de testes e certificação você receberá credenciais de produção.
Você deverá apontar suas requisições às URLs corretas em cada estágio de sua integração. Abaixo listamos as URLs de homologação e produção:
Ambiente de homologação: https://signhom.acesso.io;
Ambiente de produção: https://sign.acesso.io.
/resend/Após gerar um token de acesso válido, faça uma requisição para o endpoint de reenvio de envelopes da nossa API REST (POST/service/resend) enviando os parâmetros conforme o schema abaixo:
UUID
string <uuid>
Identificador do envelope que será reenviado
O envelope deve estar no status pendente
Subscribers
Array of objects or null
(ResendEnvelopeRequest_Subscriber)
Lista de Subscribers do envelope
Abaixo um exemplo de como reenviar um um envelope com o UUID igual a 00000000-0000-0000-0000-000000000000, atualizando as informações de Subscribers.
Se tudo der certo em sua requisição, você receberá como resposta um código HTTP 200, que confirma o reenvio de seu envelope.
Conheça as funcionalidades disponíveis para o Gerenciamento de documentos.
Conheça as funcionalidades disponíveis para o Gerenciamento de envelopes.
Tendo problemas em nossa integração? Acesse nossa seção de FAQ e problemas comuns.
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.
Através deste guia, demonstraremos como listar os documentos pertencentes a um envelope através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de obter todos os documentos de um envelope (assim como alguns de seus detalhes), de forma estruturada em uma resposta JSON.
Antes de iniciar sua integração:
Certifique-se que você possui credenciais válidas para utilizar o Unico Sign. Se você ainda não possui suas credenciais, siga nosso guia de Primeiros Passos para configurar sua conta de teste e obter suas chaves de API.
Entenda os conceitos básicos sobre nosso produto. É extremamente importante que você entenda estes conceitos para fazer uma boa utilização das APIs do Unico Sign. Você pode encontrar nossos conceitos básicos neste guia.
Como explicamos em nosso guia de conceitos básicos, nossa entidade Envelope (envelope) é a representação virtual de um envelope com documentos na vida real. Ele é o objeto que agrupa todos os documentos (document) e seus assinantes (subscriber), sendo que um envelope pode conter mais de documento, que por sua vez pode conter um ou mais assinantes.
Entenda, a seguir, como chamar nossa API REST para obter todos os documentos de um envelope.
Para efetuar requisições à nossa API REST você necessitará de um token de acesso OAuth válido. Caso não esteja familiarizado com o modelo de autenticação OAuth, entenda como gerar um token válido neste artigo. Após sua geração, o token de acesso deverá ser enviado no header de sua requisição, junto ao parâmetro Authorization.
Ambientes
Ao iniciar sua integração você receberá credenciais a nosso ambiente de homologação. Somente após o processo de testes e certificação você receberá credenciais de produção.
Você deverá apontar suas requisições às URLs corretas em cada estágio de sua integração. Abaixo listamos as URLs de homologação e produção:
Ambiente de homologação: https://signhom.acesso.io;
Ambiente de produção: https://sign.acesso.io.
Opcionalmente, você pode configurar alguns critérios para sua busca. Para isto, os campos de filtro devem ser enviados no body de sua requisição.
Obrigatoriedade dos filtros
Nenhum dos filtros é obrigatório. Caso não informados, por padrão, retornaremos 30 envelopes em nossa resposta JSON.
O schema abaixo contêm os parâmetros e domínios permitidos para a configuração dos filtros:
CPF
string or null
Default: null
Número de cadastro de pessoa física do assinante.
Se fornecido valor para EnvelopeUUID o valor de CPF será ignorado
sem formatação, apenas os 11 números
EnvelopeUUID
string or null <uuid>
Default: null
Identificador único do envelope
Status
integer <int32>
(EnvelopeStatusEnum)
Enum: 0 1 2 3 4 5 6
Estado do envelope, que pode ser:
0 - Expirado
1 - Pendente
2 - Concluído
3 - Cancelado
4 - Processando
5 - Recusado
6 - Agendado
Page
integer or null <int32>
Default: 1
Número da página da busca Ops, estamos corrigindo! Paginação não suportada da página 334 em diante. Por favor utilizar mais filtros para fazer uma busca mais precisa de acordo com seu objetivo
StartDate
string or null <date>
Data inicial para busca sob a data de criação do envelope
Se esta data for definida, também deve ser definida a data em EndDate
A data deve ser após 01/01/2018
A data deve ser anterior a data definida em EndDate
EndDate
string or null <date>
Data final para busca sob a data de criação do envelope
Se esta data for definida, também deve ser definida a data em StartDate
A data deve ser após 01/01/2018
Order
string (Orders)
Enum: "ASC" "DESC"
Ordenação dos elementos da lista, que pode ser:
ASC - Crescente
DESC - Decrescente
EnvelopeTags
Array of strings or null
Lista de tags do envelope Ao passar mais de uma tag, a busca retornará apenas envelope que contenha todas as tags informadas
O exemplo abaixo solicita em ordem ascendente, envelopes cujos assinantes possuam o CPF 100.000.000-19, criados de 01/08/2022 a 31/08/2022, com status pendente.
/envelopes/Após gerar um token de acesso válido e, opcionalmente, montar o body com os filtros, faça uma requisição para o endpoint de obtenção de lista de documentos da nossa API REST (POST/service/envelopes). Serão obtidos os dados de todos envelopes atrelados ao usuário do token utilizado.
Permissão para Visualizar Documentos
Para utilizar esta rota é necessário que o usuário tenha permissão de Visualizar Documentos.
Exemplo solicitando em ordem ascendente, envelopes cujos assinantes possuam o CPF 100.000.000-19, criados de 01/08/2022 a 31/08/2022, com status pendente:
Se tudo der certo em sua requisição, você receberá como resposta um JSON contendo uma lista todos os envelopes associados a sua consulta:
Limite de páginas
Atualmente não é possível listar documentos da página 334 em diante. Caso seja necessário acessar uma dessas páginas, recomendamos utilizar os filtros para uma busca mais precisa.
Cada elemento do objeto Envelopes representa um envelope com seus respectivos documentos, contidos no objeto Documents.
Conheça as funcionalidades disponíveis para o Gerenciamento de documentos.
Conheça as funcionalidades disponíveis para o Gerenciamento de envelopes.
Tendo problemas em nossa integração? Acesse nossa seção de FAQ e problemas comuns.
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.
Através deste guia, demonstraremos como cancelar um envelope através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de cancelar um envelope a partir de seu UUID e receber uma confirmação em uma resposta JSON.
Antes de iniciar sua integração:
Certifique-se que você possui credenciais válidas para utilizar o Unico Sign. Se você ainda não possui suas credenciais, siga nosso guia de Primeiros Passos para configurar sua conta de teste e obter suas chaves de API.
Entenda os conceitos básicos sobre nosso produto. É extremamente importante que você entenda estes conceitos para fazer uma boa utilização das APIs do Unico Sign. Você pode encontrar nossos conceitos básicos neste guia.
Como explicamos em nosso guia de conceitos básicos, nossa entidade Envelope (envelope) é a representação virtual de um envelope com documentos na vida real. Ele é o objeto que agrupa todos os documentos (document) e seus assinantes (subscriber), sendo que um envelope pode conter mais de documento, que por sua vez pode conter um ou mais assinantes.
Ao cancelar um envelope, um e-mail e/ou SMS serão enviados para os assinantes dos documentos contidos no envelope. O método de notificação irá dependender de quais dados dos assinantes foram cadastrados no momento do envio do envelope.
Uma vez cancelado, o envelope não poderá mais ser acessado, assinado ou recusado pelos assinantes.
Entenda, a seguir, como chamar nossa API REST para cancelar um envelope.
Para efetuar requisições à nossa API REST você necessitará de um token de acesso OAuth válido. Caso não esteja familiarizado com o modelo de autenticação OAuth, entenda como gerar um token válido neste artigo. Após sua geração, o token de acesso deverá ser enviado no header de sua requisição, junto ao parâmetro Authorization.
Ambientes
Ao iniciar sua integração você receberá credenciais a nosso ambiente de homologação. Somente após o processo de testes e certificação você receberá credenciais de produção.
Você deverá apontar suas requisições às URLs corretas em cada estágio de sua integração. Abaixo listamos as URLs de homologação e produção:
Ambiente de homologação: https://signhom.acesso.io;
Ambiente de produção: https://sign.acesso.io.
/cancel/Após gerar um token de acesso válido, faça uma requisição para o endpoint de cancelamento de envelopes da nossa API REST (POST/service/cancel) enviando os parâmetros conforme o schema abaixo:
EnvelopeUUID
string <uuid>
Identificador único do envelope
Reason
string
Motivo de cancelamento do envelope
UserName
string or null
Default: "Integração"
Nome do usuário que está cancelando
Se não fornecido será extraído o nome de usuário do token utilizado, e se não encontrado o nome será Integração
Permissão para Visualizar Documentos
Para utilizar esta rota é necessário que o usuário tenha permissão de Enviar Documentos.
Abaixo um exemplo de como cancelar um envelope com o UUID igual a 00000000-0000-0000-0000-000000000000 informando como motivo "Solicitação de correção":
Se tudo der certo em sua requisição, você receberá como resposta um JSON contendo a confirmação da exclusão do envelope.
Conheça as funcionalidades disponíveis para o Gerenciamento de documentos.
Conheça as funcionalidades disponíveis para o Gerenciamento de envelopes.
Tendo problemas em nossa integração? Acesse nossa seção de FAQ e problemas comuns.
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.