Nossa API utiliza uma série de conceitos e objetos como base para nossas funcionalidades. Este guia tem o objetivo de tornar familiar cada um desses conceitos para que você tenha um processo de integração totalmente fluido.
Ao explorar os conceitos deste guia, você será capaz de entender todo o fluxo de vida de um documento dentro do Unico Sign.
Entenda abaixo alguns conceitos básicos e termos importantes para sua integração.
A entidade Envelope é uma representação de um envelope com documentos na vida real. Ele é o objeto que agrupa todos os documentos(Document) e seus assinantes(Subscriber). Um envelope deve conter pelo menos um documento. A quantidade de documentos em um envelope é ilimitada, no entando, o tamanho do envelope não pode exceder 20Mb.
A entidade Document é a representação de um documento e pode ter duas formas:
O documento pode ser um arquivo pdf na forma de Base64 ou pode ser um modelo(Template) pré pronto.
Um documento pode conter um ou mais assinantes(Subscribers).
Em ambos os casos, o tamanho de cada documento não pode exceder 10Mb.
Subscriber é o assinante de um documento(Document). Todo assinante tem um tipo(SubscriberRole), sendo que existem três possíveis, são eles: Assinatura própria, Representante Legal ou Testemunha. Em cada envelope, o assinante pode ter apenas um dos três tipos. Segue abaixo a descrição de cada tipo.
Assinatura própria: é a assinatura do contratado.
Representante Legal: é a assinatura de uma pessoa que representa terceiros, sejam empresas ou outras pessoas.
Testemunha: é a assinatura da testemunha do documento.
Template é um modelo de documento, normalmente utilizado em casos de envio de arquivos recorrentes, uma vez que pode ser reutilizado em vários envelopes. Um exemplo de uso é o envio de holerites ou folha de ponto. Além disso, modelos podem conter formulários, para que o assinante possa preencher ou ser preenchido pelo emissor com uma informação como, por exemplo, data da emissão ou assinatura, idade, nome dos pais, nome completo, opções sexuais, e qualquer coisa que precise ser preenchido em tempo de emissão ou assinatura.
Para criar um modelo é necessário acessar o Dashboard do Unico Sign, criar o modelo a partir de um arquivo pdf válido e configurar o seu formulário visualmente, caso seja necessário. A partir desse ponto, os modelos poderão ser utilizados na emissão via API.
Emitter se trata do emissor do documento, ou seja o usuário que está realizando a criação do envelope. Caso o emissor precise também ser assinante do envelope, ele pode ser adicionado como assinante e terá o tipo de representante legal.
Conjunto formado pelas principais informações do envelope. Serve para comprovar juridicamente a conformidade e validade de um envelope, documento ou assinatura.
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.