API
New Horizon
Log In
API

Iniciar uma requisição de assinatura

post
https://easysign.hom.bry.com.br/api/service/sign/v1/signatures

Realiza uma requisição de envio de um ou mais documentos para assinatura, conforme parâmetros e gera links de acesso a página de assinatura para cada assinante listado.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Determina o nome que será atribuído ao envio e exibido para o assinante no momento da assinatura.

string
required

Determina o nome que será atribuído ao criador do envio e exibido para o assinante no momento da assinatura.

number
Defaults to 604800

Determina a duração da requisição de envio de assinaturas gerada em segundos. Mínimo: 86400 (1 dia). Default: 604800 (7 dias)

string
enum
Defaults to UNORDERED

Determina se existirá uma ordem pré-definida para os assinantes. ORDERED - criador do envelope define a ordem das assinaturas; UNORDERED - sem ordem pré-definida entre as assinaturas; GROUPED - criador do envelope define a ordem dos grupos que podem realizar as assinaturas;

Allowed:
string
enum
Defaults to pt-br

Linguagem padrão do envelope. Define a linguagem para os signatários que não a definirem.

Allowed:
boolean
Defaults to true
deprecated

Define se as mensagens de notificação definidas para os signatários serão enviadas na criação do envelope. Deprecated: para não enviar as notificações configuradas na inicialização deve ser utilizado o parâmetro 'startAsDraft' e iniciar o envelope pela página de configuração

boolean
Defaults to false

Define se o envelope será iniciado no estado de 'DRAFT'. Caso esteja verdadeiro, as notificações dos signatários não serão enviadas, sendo necessário iniciar o envelope após finalizar as alterações. Para inicializar o envelope, acesse a página de configuração do envelope.

boolean
Defaults to false

Define se os documentos assinados serão mantidos após a expiração do envelope. Caso esteja verdadeiro, os documentos não serão removidos automaticamente após a expiração do envelope

linkMark
object

Marcas de referência adicionadas aos documentos

creator
object

Informações do criador do envelope

signersData
array of objects
required
signersData*
documents
array of objects
required
documents*
images
array of objects
images
groups
array of objects
groups
Responses

Updated 3 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago