POST Send request with document

Solicitações de Assinatura de Documentos

Este endpoint permite enviar solicitações de assinatura em documentos para múltiplos destinatários (e-mails ou telefones). Todos os signatários assinarão o mesmo documento. Abaixo, explicamos o processo e fornecemos detalhes sobre como configurar campos e dados necessários.

Enviar solicitações sem local definido

Para configurar uma solicitação sem local definido é necessário atribuir os valores -999 aos campos xPos e yPos. Veja o exemplo abaixo:

{ "page": 1, "type": "signature", "width": 200, "height": 75, "xPos": -999, "yPos": -999 }

Resultado Final

Quando você solicita uma assinatura sem especificar o local, a assinatura será inserida em uma página extra gerada após o documento. Nessa página, serão exibidos todos os dados do usuário e a assinatura gerada.

Logo do R

Importante: Quando se solicita assinaturas de convidados, o sistema não armazena os dados ou a assinatura do signatário. Portanto, será necessária uma página extra para cada signatário. Se houver 4 signatários, o documento terá 4 páginas extras, cada uma com a assinatura de um signatário.

Enviar documento com rubrica

Para adicionar uma rubrica, defina o campo type como rubric dentro de fields. Essa configuração irá adicionar uma posição de assinatura em todas as páginas, conforme as posições definidas. Lembre-se de que cada signatário pode usar a rubrica apenas uma vez.

O tipo rubric funciona de maneira semelhante ao image, com a diferença de que não é necessário fornecer o campo "page".

Enviar documento com texto

Ao enviar um documento com o tipo text dentro de fields, é possível utilizar os campos validateData e default:

  • default: Define um valor padrão que será automaticamente preenchido no campo, desde que o validateData seja diferente de 1.
  • validateData: Não preenche automaticamente o campo com o valor do default, mas valida se o usuário inseriu o valor correspondente.

Ambos os campos são opcionais. Se não forem definidos, o comportamento do sistema permanecerá o mesmo.

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

Document Key do documento.

string
required

Largura da página em pixels, este número será utilizado na hora de calcular as posições e campos de solicitação e/ou assinatura.

observer
array of strings

Os observadores irão receber comunicados referentes à situação da solicitação. Para isso, inclua uma lista de emails.

observer
boolean

Se a solicitação é em cadeia, ou seja, deve respeitar a ordem dos e-mails para envio ou se será enviada para todos ao mesmo tempo.

string

Identifica o colaborador que aparecerá como remetente deste documento. Pode ser o ID do usuário ou o e-mail dele. Se omitido, o documento será enviado pela conta do admin da empresa.

int32

A validade do documento em meses, por exemplo, um contrato com 12 meses de validade. Nós iremos monitorar a data e avisaremos antes do vencimento, para que possam refazer a solicitação e reenviar para assinatura.

boolean
Defaults to false

Quando ativado (True), o request não gera um e-mail para o cliente. Apenas o URL de assinatura e o e-mail serão retornados.

recipients
array of objects
required

Destinatários.

recipients*
Response

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