API
Criar novo processo de assinatura em lote
Cria um lote de assinaturas com base em signatários ainda não assinados. O lote inclui os arquivos associados a cada signatário.
POST
/
api
/
signature-processes-batch
Criar novo processo de assinatura em lote
curl --request POST \
--url https://api.valid.com/api/signature-processes-batch \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"code": "<string>",
"signers": [
{}
],
"options": {
"url_origin": "<string>",
"url_notification": "<string>"
}
}
'import requests
url = "https://api.valid.com/api/signature-processes-batch"
payload = {
"code": "<string>",
"signers": [{}],
"options": {
"url_origin": "<string>",
"url_notification": "<string>"
}
}
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({
code: '<string>',
signers: [{}],
options: {url_origin: '<string>', url_notification: '<string>'}
})
};
fetch('https://api.valid.com/api/signature-processes-batch', 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/api/signature-processes-batch",
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([
'code' => '<string>',
'signers' => [
[
]
],
'options' => [
'url_origin' => '<string>',
'url_notification' => '<string>'
]
]),
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/api/signature-processes-batch"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"signers\": [\n {}\n ],\n \"options\": {\n \"url_origin\": \"<string>\",\n \"url_notification\": \"<string>\"\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/api/signature-processes-batch")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"signers\": [\n {}\n ],\n \"options\": {\n \"url_origin\": \"<string>\",\n \"url_notification\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/signature-processes-batch")
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 \"code\": \"<string>\",\n \"signers\": [\n {}\n ],\n \"options\": {\n \"url_origin\": \"<string>\",\n \"url_notification\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Lote de assinatura inserido com sucesso.",
"uuid": "43fc2d36-e9a3-41a3-9c42-49894f75a1d7",
"code": "BATCH-001",
"url": "https://portal.validsigner.com.br/signature/batch/{token}"
}
Body Parameters
Código do processo em lote. Exemplo:
BATCH-001Lista de UUIDs dos signatários. Exemplo:
["2fd968f7-36f2-4db2-a47d-278cdb8dc1c4"]Response
Mensagem de sucesso. Exemplo:
Lote de assinatura inserido com sucesso.UUID do lote criado. Exemplo:
43fc2d36-e9a3-41a3-9c42-49894f75a1d7Código do lote. Exemplo:
BATCH-001URL para assinatura do lote. Exemplo:
https://portal.validsigner.com.br/signature/batch/{token}{
"message": "Lote de assinatura inserido com sucesso.",
"uuid": "43fc2d36-e9a3-41a3-9c42-49894f75a1d7",
"code": "BATCH-001",
"url": "https://portal.validsigner.com.br/signature/batch/{token}"
}
Previous
Cancelar processo em loteAltera o estado de um processo de assinatura em lote para 'cancelado'.
Next
⌘I
Criar novo processo de assinatura em lote
curl --request POST \
--url https://api.valid.com/api/signature-processes-batch \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"code": "<string>",
"signers": [
{}
],
"options": {
"url_origin": "<string>",
"url_notification": "<string>"
}
}
'import requests
url = "https://api.valid.com/api/signature-processes-batch"
payload = {
"code": "<string>",
"signers": [{}],
"options": {
"url_origin": "<string>",
"url_notification": "<string>"
}
}
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({
code: '<string>',
signers: [{}],
options: {url_origin: '<string>', url_notification: '<string>'}
})
};
fetch('https://api.valid.com/api/signature-processes-batch', 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/api/signature-processes-batch",
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([
'code' => '<string>',
'signers' => [
[
]
],
'options' => [
'url_origin' => '<string>',
'url_notification' => '<string>'
]
]),
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/api/signature-processes-batch"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"signers\": [\n {}\n ],\n \"options\": {\n \"url_origin\": \"<string>\",\n \"url_notification\": \"<string>\"\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/api/signature-processes-batch")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"signers\": [\n {}\n ],\n \"options\": {\n \"url_origin\": \"<string>\",\n \"url_notification\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/signature-processes-batch")
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 \"code\": \"<string>\",\n \"signers\": [\n {}\n ],\n \"options\": {\n \"url_origin\": \"<string>\",\n \"url_notification\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Lote de assinatura inserido com sucesso.",
"uuid": "43fc2d36-e9a3-41a3-9c42-49894f75a1d7",
"code": "BATCH-001",
"url": "https://portal.validsigner.com.br/signature/batch/{token}"
}