Enviar a assinatura incremental

POST

signer

incremental-signatures

:uuid

send

Enviar a assinatura incremental

curl --request POST \
  --url https://api.valid.com/signer/v1/incremental-signatures/: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/incremental-signatures/: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/incremental-signatures/: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/incremental-signatures/: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/incremental-signatures/: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",
    "title": "CCB 2026-0001",
    "stateId": 6,
    "state": "Aguardando assinatura",
    "dueDate": "2026-12-31T23:59:59.000Z",
    "reminderEveryHours": 24,
    "signingMode": "parallel",
    "notificationChannel": "EMAIL",
    "urlNotification": null,
    "createdAt": "2026-11-13T10:30:00.000Z"
  },
  "signers": [
    {
      "signerUuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "sessionToken": "TOKEN",
      "signUrl": "https://assinador.exemplo.com/envelopes/TOKEN"
    }
  ]
}

Último passo: envia aos signatários. Só vale na conferência (estado 5). Abre a sessão de cada signatário, avisa pelo canal escolhido e devolve os links. Com notificationChannel=NONE, ninguém é avisado e entregar os links é com você. Quando o último signatário assina, o portal assina cada documento com o certificado do assinador, de forma invisível, e a assinatura é finalizada. Acompanhe pelos webhooks ou por GET /signer/v1/envelopes/:uuid.

Parâmetros

string

required

UUID da assinatura incremental em rascunho.

Respostas

object

A assinatura no estado 6, “Aguardando assinatura”, no formato de POST .../drafts.

array

Cada signatário com signerUuid, sessionToken e signUrl, o link da página de assinatura.

Erros

Veja Autenticação e erros.

404: Não existe assinatura incremental com este uuid no seu projeto. Um envelope comum também responde 404 aqui: ele se edita pelas rotas de /signer/v1/envelopes.
409: Fora da conferência, ou com pendência (por exemplo, chancela sem lugar), com o motivo na mensagem.

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

{
  "envelope": {
    "envelopeUuid": "550e8400-e29b-41d4-a716-446655440000",
    "title": "CCB 2026-0001",
    "stateId": 6,
    "state": "Aguardando assinatura",
    "dueDate": "2026-12-31T23:59:59.000Z",
    "reminderEveryHours": 24,
    "signingMode": "parallel",
    "notificationChannel": "EMAIL",
    "urlNotification": null,
    "createdAt": "2026-11-13T10:30:00.000Z"
  },
  "signers": [
    {
      "signerUuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "sessionToken": "TOKEN",
      "signUrl": "https://assinador.exemplo.com/envelopes/TOKEN"
    }
  ]
}

Exemplo

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

⌘I

Enviar a assinatura incremental

curl --request POST \
  --url https://api.valid.com/signer/v1/incremental-signatures/: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/incremental-signatures/: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/incremental-signatures/: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/incremental-signatures/: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/incremental-signatures/: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",
    "title": "CCB 2026-0001",
    "stateId": 6,
    "state": "Aguardando assinatura",
    "dueDate": "2026-12-31T23:59:59.000Z",
    "reminderEveryHours": 24,
    "signingMode": "parallel",
    "notificationChannel": "EMAIL",
    "urlNotification": null,
    "createdAt": "2026-11-13T10:30:00.000Z"
  },
  "signers": [
    {
      "signerUuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "sessionToken": "TOKEN",
      "signUrl": "https://assinador.exemplo.com/envelopes/TOKEN"
    }
  ]
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Storage

Coleção Postman

Enviar a assinatura incremental

Parâmetros

Respostas

Erros

Exemplo