API
Criar envelope a partir de template
Cria um envelope baseado em um template, semeando valores de campos.
POST
/
v1
/
templates
/
:uuid
/
envelopes
Criar envelope a partir de template
curl --request POST \
--url https://api.valid.com/v1/templates/:uuid/envelopes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"externalCode": "<string>",
"dueDate": "<string>",
"urlOrigin": "<string>",
"urlNotification": "<string>",
"signers": [
{
"name": "<string>",
"email": "<string>",
"cpf": "<string>",
"phoneCountryCode": "<string>",
"phoneNumber": "<string>",
"queueOrder": 123
}
],
"values": {},
"fieldValues": [
{
"key": "<string>",
"value": [
"<string>"
],
"editable": true
}
],
"fieldAssignments": [
{
"key": "<string>",
"signerIndex": 123
}
],
"signatureAssignments": [
{
"key": "<string>",
"signerIndex": 123
}
]
}
'import requests
url = "https://api.valid.com/v1/templates/:uuid/envelopes"
payload = {
"title": "<string>",
"externalCode": "<string>",
"dueDate": "<string>",
"urlOrigin": "<string>",
"urlNotification": "<string>",
"signers": [
{
"name": "<string>",
"email": "<string>",
"cpf": "<string>",
"phoneCountryCode": "<string>",
"phoneNumber": "<string>",
"queueOrder": 123
}
],
"values": {},
"fieldValues": [
{
"key": "<string>",
"value": ["<string>"],
"editable": True
}
],
"fieldAssignments": [
{
"key": "<string>",
"signerIndex": 123
}
],
"signatureAssignments": [
{
"key": "<string>",
"signerIndex": 123
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
externalCode: '<string>',
dueDate: '<string>',
urlOrigin: '<string>',
urlNotification: '<string>',
signers: [
{
name: '<string>',
email: '<string>',
cpf: '<string>',
phoneCountryCode: '<string>',
phoneNumber: '<string>',
queueOrder: 123
}
],
values: {},
fieldValues: [{key: '<string>', value: ['<string>'], editable: true}],
fieldAssignments: [{key: '<string>', signerIndex: 123}],
signatureAssignments: [{key: '<string>', signerIndex: 123}]
})
};
fetch('https://api.valid.com/v1/templates/:uuid/envelopes', 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/v1/templates/:uuid/envelopes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'externalCode' => '<string>',
'dueDate' => '<string>',
'urlOrigin' => '<string>',
'urlNotification' => '<string>',
'signers' => [
[
'name' => '<string>',
'email' => '<string>',
'cpf' => '<string>',
'phoneCountryCode' => '<string>',
'phoneNumber' => '<string>',
'queueOrder' => 123
]
],
'values' => [
],
'fieldValues' => [
[
'key' => '<string>',
'value' => [
'<string>'
],
'editable' => true
]
],
'fieldAssignments' => [
[
'key' => '<string>',
'signerIndex' => 123
]
],
'signatureAssignments' => [
[
'key' => '<string>',
'signerIndex' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.valid.com/v1/templates/:uuid/envelopes"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"urlOrigin\": \"<string>\",\n \"urlNotification\": \"<string>\",\n \"signers\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phoneCountryCode\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"queueOrder\": 123\n }\n ],\n \"values\": {},\n \"fieldValues\": [\n {\n \"key\": \"<string>\",\n \"value\": [\n \"<string>\"\n ],\n \"editable\": true\n }\n ],\n \"fieldAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ],\n \"signatureAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.valid.com/v1/templates/:uuid/envelopes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"urlOrigin\": \"<string>\",\n \"urlNotification\": \"<string>\",\n \"signers\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phoneCountryCode\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"queueOrder\": 123\n }\n ],\n \"values\": {},\n \"fieldValues\": [\n {\n \"key\": \"<string>\",\n \"value\": [\n \"<string>\"\n ],\n \"editable\": true\n }\n ],\n \"fieldAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ],\n \"signatureAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/v1/templates/:uuid/envelopes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"urlOrigin\": \"<string>\",\n \"urlNotification\": \"<string>\",\n \"signers\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phoneCountryCode\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"queueOrder\": 123\n }\n ],\n \"values\": {},\n \"fieldValues\": [\n {\n \"key\": \"<string>\",\n \"value\": [\n \"<string>\"\n ],\n \"editable\": true\n }\n ],\n \"fieldAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ],\n \"signatureAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyHTTP/1.1 201 Created
Content-Type: application/json
{
"envelopeUuid": "550e8400-e29b-41d4-a716-446655440000",
"fileUuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"signers": [
{
"signerUuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
"sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"signUrl": "https://seu-app.com/sign?token=..."
}
],
"state": "CREATED",
"createdAt": "2025-07-27T10:30:00.000Z"
}
Cria um novo envelope usando um template como base. Você pode pré-preencher valores de campos, atribuir campos a signatários específicos e configurar signatários.
Parâmetros
string
required
UUID do template.
string
required
Título do envelope (ex:
"Contrato do cliente ACME").string
Código externo único (ex:
"CONT-2025-ACME"). Deve ser único por projeto.string
required
Data limite para assinatura (ISO 8601).
string
URL origem do seu app (para links em e-mails).
string
URL webhook para notificações de status.
array
required
object
Atalho para pré-preencher campos:
{ key: value }. Locked (não editável por signatários).array
array
array
Respostas
Retorna envelope criado (mesmo shape dePOST /v1/envelopes):
string
UUID do envelope.
array
Signatários com
sessionToken.Erros
Veja Autenticação e erros.- 400: Campo desconhecido, valor inválido, campo obrigatório sem valor.
- 401: API key inválido.
- 404: Template não encontrado.
- 409:
externalCodeduplicado.
HTTP/1.1 201 Created
Content-Type: application/json
{
"envelopeUuid": "550e8400-e29b-41d4-a716-446655440000",
"fileUuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"signers": [
{
"signerUuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
"sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"signUrl": "https://seu-app.com/sign?token=..."
}
],
"state": "CREATED",
"createdAt": "2025-07-27T10:30:00.000Z"
}
Exemplo
curl -X POST "https://signer.vcc-service.com/v1/templates/550e8400-e29b-41d4-a716-446655440000/envelopes" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Contrato ACME 2025",
"externalCode": "CONT-ACME-001",
"dueDate": "2025-12-31T23:59:59Z",
"urlOrigin": "https://seu-app.com",
"signers": [
{
"name": "João Cliente",
"email": "joao@acme.com",
"cpf": "12345678901"
}
],
"values": {
"nome_cliente": "ACME Inc.",
"data_criacao": "2025-07-27"
},
"fieldAssignments": [
{
"key": "data_assinatura",
"signerIndex": 0
}
]
}'
Fluxo recomendado
- Criar template:
POST /v1/templates - Criar envelope:
POST /v1/templates/:uuid/envelopes(pré-preenche valores) - Signatário assina:
POST /signature/envelope-sessions/:sessionToken/submit - Obter assinado:
GET /v1/sign/:sessionToken/signed-document
Relacionado
POST /v1/templates/:uuid/fill— pré-visualizar preenchido sem criar envelopePOST /v1/envelopes— criar envelope avulso (sem template)
⌘I
Criar envelope a partir de template
curl --request POST \
--url https://api.valid.com/v1/templates/:uuid/envelopes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"externalCode": "<string>",
"dueDate": "<string>",
"urlOrigin": "<string>",
"urlNotification": "<string>",
"signers": [
{
"name": "<string>",
"email": "<string>",
"cpf": "<string>",
"phoneCountryCode": "<string>",
"phoneNumber": "<string>",
"queueOrder": 123
}
],
"values": {},
"fieldValues": [
{
"key": "<string>",
"value": [
"<string>"
],
"editable": true
}
],
"fieldAssignments": [
{
"key": "<string>",
"signerIndex": 123
}
],
"signatureAssignments": [
{
"key": "<string>",
"signerIndex": 123
}
]
}
'import requests
url = "https://api.valid.com/v1/templates/:uuid/envelopes"
payload = {
"title": "<string>",
"externalCode": "<string>",
"dueDate": "<string>",
"urlOrigin": "<string>",
"urlNotification": "<string>",
"signers": [
{
"name": "<string>",
"email": "<string>",
"cpf": "<string>",
"phoneCountryCode": "<string>",
"phoneNumber": "<string>",
"queueOrder": 123
}
],
"values": {},
"fieldValues": [
{
"key": "<string>",
"value": ["<string>"],
"editable": True
}
],
"fieldAssignments": [
{
"key": "<string>",
"signerIndex": 123
}
],
"signatureAssignments": [
{
"key": "<string>",
"signerIndex": 123
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
externalCode: '<string>',
dueDate: '<string>',
urlOrigin: '<string>',
urlNotification: '<string>',
signers: [
{
name: '<string>',
email: '<string>',
cpf: '<string>',
phoneCountryCode: '<string>',
phoneNumber: '<string>',
queueOrder: 123
}
],
values: {},
fieldValues: [{key: '<string>', value: ['<string>'], editable: true}],
fieldAssignments: [{key: '<string>', signerIndex: 123}],
signatureAssignments: [{key: '<string>', signerIndex: 123}]
})
};
fetch('https://api.valid.com/v1/templates/:uuid/envelopes', 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/v1/templates/:uuid/envelopes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'externalCode' => '<string>',
'dueDate' => '<string>',
'urlOrigin' => '<string>',
'urlNotification' => '<string>',
'signers' => [
[
'name' => '<string>',
'email' => '<string>',
'cpf' => '<string>',
'phoneCountryCode' => '<string>',
'phoneNumber' => '<string>',
'queueOrder' => 123
]
],
'values' => [
],
'fieldValues' => [
[
'key' => '<string>',
'value' => [
'<string>'
],
'editable' => true
]
],
'fieldAssignments' => [
[
'key' => '<string>',
'signerIndex' => 123
]
],
'signatureAssignments' => [
[
'key' => '<string>',
'signerIndex' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.valid.com/v1/templates/:uuid/envelopes"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"urlOrigin\": \"<string>\",\n \"urlNotification\": \"<string>\",\n \"signers\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phoneCountryCode\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"queueOrder\": 123\n }\n ],\n \"values\": {},\n \"fieldValues\": [\n {\n \"key\": \"<string>\",\n \"value\": [\n \"<string>\"\n ],\n \"editable\": true\n }\n ],\n \"fieldAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ],\n \"signatureAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.valid.com/v1/templates/:uuid/envelopes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"urlOrigin\": \"<string>\",\n \"urlNotification\": \"<string>\",\n \"signers\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phoneCountryCode\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"queueOrder\": 123\n }\n ],\n \"values\": {},\n \"fieldValues\": [\n {\n \"key\": \"<string>\",\n \"value\": [\n \"<string>\"\n ],\n \"editable\": true\n }\n ],\n \"fieldAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ],\n \"signatureAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/v1/templates/:uuid/envelopes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"externalCode\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"urlOrigin\": \"<string>\",\n \"urlNotification\": \"<string>\",\n \"signers\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"cpf\": \"<string>\",\n \"phoneCountryCode\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"queueOrder\": 123\n }\n ],\n \"values\": {},\n \"fieldValues\": [\n {\n \"key\": \"<string>\",\n \"value\": [\n \"<string>\"\n ],\n \"editable\": true\n }\n ],\n \"fieldAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ],\n \"signatureAssignments\": [\n {\n \"key\": \"<string>\",\n \"signerIndex\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyHTTP/1.1 201 Created
Content-Type: application/json
{
"envelopeUuid": "550e8400-e29b-41d4-a716-446655440000",
"fileUuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"signers": [
{
"signerUuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
"sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"signUrl": "https://seu-app.com/sign?token=..."
}
],
"state": "CREATED",
"createdAt": "2025-07-27T10:30:00.000Z"
}