Criar Envelope

POST /esignglobal/v1/envelope/create

Descrição da Interface

Cria um envelope em estado de rascunho.

Parâmetros de Requisição

Nome do Parâmetro		Tipo	Obrigatório	Descrição
subject		string	true	Assunto do envelope, exemplo: “Offer Letter”
remark		string	false	Observações do envelope, limite de 1000 caracteres
signerSettings		object	false	Operações permitidas ao signatário
	allowTransfer	boolean	false	Se o signatário pode transferir este envelope para outra pessoa assinar, por defeito é falso true- Permite que o signatário no envelope tenha o poder de transferir o envelope para outra pessoa; false- Não permite que o signatário no envelope tenha o poder de transferir o envelope para outra pessoa;
	allowModifyName	boolean	false	Se a parte signatária pode modificar o nome, apenas efetivo para assinaturas de modelo, por defeito é falso true- Permite que o signatário modifique o nome false- O signatário não tem permissão para modificar o nome
expireAfterSeconds		long	false	Tempo de expiração do envelope: após quantos segundos o envelope expira Intervalo de expiração: 86.400 segundos (1 dia) ~ 7.776.000 segundos (90 dias).
redirectUrl		string	false	Endereço de redirecionamento após a conclusão da assinatura (comprimento 2048), deve ser um endereço http válido
callBackUrl		string	false	Endereço de callback (comprimento 500), deve estar em conformidade com o endereço do protocolo https / http

Exemplo de pedido

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

Parâmetros de resposta

Nome do parâmetro

Tipo

Descrição

envelopeId

string

ID do envelope

envelopeStatus

int

Estado do envelope

0 - Criado (rascunho)

1 - Em assinatura

2 - Concluído

3 - Expirado

5 - Revogado

Exemplo de Resposta

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}