Enviar envelope aos signatários

POST

signer

envelopes

:uuid

send

Enviar envelope aos signatários

curl --request POST \
  --url https://api.valid.com/signer/v1/envelopes/:uuid/send \
  --header 'x-api-key: <api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/signer/v1/envelopes/:uuid/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valid.com/signer/v1/envelopes/:uuid/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/signer/v1/envelopes/:uuid/send"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/signer/v1/envelopes/:uuid/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

HTTP/1.1 200 OK
Content-Type: application/json

{
  "envelope": {
    "envelopeUuid": "550e8400-e29b-41d4-a716-446655440000",
    "stateId": 6,
    "state": "Aguardando assinatura",
    "title": "Contrato de Serviços 2025"
  },
  "signers": [
    {
      "signerUuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "signUrl": "https://seu-app.com/signer/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    },
    {
      "signerUuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "signUrl": "https://seu-app.com/signer/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    }
  ]
}

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "statusCode": 409,
  "message": "Envelope must be in review step to send"
}

Finaliza o assistente de criação de envelope. Esta chamada:

Cria uma sessão única para cada signatário (com sessionToken).
Registra o histórico de criação.
Muda o envelope para “Aguardando assinatura”.
Dispara e-mails de convite aos signatários.

Importante: o estado muda antes de disparar e-mails, para evitar duplicar sessões em caso de falha parcial. Autenticação: x-api-key no header. Também aceita Authorization: Bearer.

Parâmetros

string

required

UUID do envelope (na etapa “Conferência”).

Respostas

object

Dados do envelope (mesmo formato de POST .../drafts).

array

Lista de signatários com sessões criadas:

signerUuid — UUID do signatário.
sessionToken — token único para a sessão de assinatura deste signatário.
signUrl — URL completa (ex.: https://seu-app.com/signer/{sessionToken}) para compartilhar com o signatário.

Erros

Veja Autenticação e erros.

404: Envelope não encontrado.
409: Envelope não está na etapa “Conferência”, ou faltam documentos/signatários.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "envelope": {
    "envelopeUuid": "550e8400-e29b-41d4-a716-446655440000",
    "stateId": 6,
    "state": "Aguardando assinatura",
    "title": "Contrato de Serviços 2025"
  },
  "signers": [
    {
      "signerUuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "signUrl": "https://seu-app.com/signer/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    },
    {
      "signerUuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "signUrl": "https://seu-app.com/signer/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    }
  ]
}

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "statusCode": 409,
  "message": "Envelope must be in review step to send"
}

Exemplo

curl -X POST "https://api.valid.com/signer/v1/envelopes/550e8400-e29b-41d4-a716-446655440000/send" \
  -H "x-api-key: YOUR_API_KEY"

Importante

Irreversível: após send, o envelope não pode voltar a “Rascunho”.
Sessões criadas: cada signatário recebe um sessionToken único para acessar sua sessão de assinatura.
E-mails: convites são disparados após a mudança de estado. Se alguns e-mails falharem, o envelope já saiu de rascunho (estado já mudou) — o operador pode usar POST .../:uuid/signers/:signerUuid/resend-invitation para reenviar.
URLs dos signatários: distribua o signUrl de cada signatário para que acessem suas sessões de assinatura.

Próximas etapas

Compartilhe o signUrl de cada signatário (via e-mail, SMS, ou QR Code).
Cada signatário acessa sua sessão: GET /signer/v1/sign/:sessionToken.
Preenche campos (se houver) e assina: POST /signer/v1/sign/:sessionToken/sign.
Quando o último signatário assina, o envelope muda para “Finalizado” e um webhook é disparado (se configurado).

Relacionado

POST .../:uuid/advance — chegar à etapa de conferência antes disto
POST .../:uuid/signers/:signerUuid/resend-invitation — reenviar convite
POST /signer/v1/sign/:sessionToken/sign — signatário assina

⌘I

Enviar envelope aos signatários

curl --request POST \
  --url https://api.valid.com/signer/v1/envelopes/:uuid/send \
  --header 'x-api-key: <api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/signer/v1/envelopes/:uuid/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valid.com/signer/v1/envelopes/:uuid/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/signer/v1/envelopes/:uuid/send"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/signer/v1/envelopes/:uuid/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

HTTP/1.1 200 OK
Content-Type: application/json

{
  "envelope": {
    "envelopeUuid": "550e8400-e29b-41d4-a716-446655440000",
    "stateId": 6,
    "state": "Aguardando assinatura",
    "title": "Contrato de Serviços 2025"
  },
  "signers": [
    {
      "signerUuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "signUrl": "https://seu-app.com/signer/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    },
    {
      "signerUuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "signUrl": "https://seu-app.com/signer/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    }
  ]
}

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "statusCode": 409,
  "message": "Envelope must be in review step to send"
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Storage

Coleção Postman

Enviar envelope aos signatários

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas

Relacionado

​Parâmetros

​Respostas

​Erros

​Exemplo

​Importante

​Próximas etapas

​Relacionado

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas

Relacionado