API
Listar signatários
Retorna todos os signatários vinculados ao processo de assinatura informado, com filtros opcionais.
GET
/
api
/
signature-processes
/
{signature_process}
/
signers
Listar signatários
curl --request GET \
--url https://api.valid.com/api/signature-processes/{signature_process}/signers \
--header 'x-api-key: <api-key>'import requests
url = "https://api.valid.com/api/signature-processes/{signature_process}/signers"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.valid.com/api/signature-processes/{signature_process}/signers', 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/{signature_process}/signers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/api/signature-processes/{signature_process}/signers"
req, _ := http.NewRequest("GET", 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))
}HttpResponse<String> response = Unirest.get("https://api.valid.com/api/signature-processes/{signature_process}/signers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/signature-processes/{signature_process}/signers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"signers": [
{
"uuid": "d6c8a310-1af1-4bc5-99c9-e80d9260de3c",
"code": "SIGN001",
"name": "João da Silva",
"identifier": "12345678901",
"email": "joao@example.com"
}
]
}
Path Parameters
UUID do processo de assinatura. Exemplo:
26a95ec3-9484-4e4a-917b-e44f23a16a22Query Parameters
Código interno do signatário. Exemplo:
SIG001Nome do signatário (busca parcial). Exemplo:
JoaoE-mail do signatário (busca parcial). Exemplo:
joao@exemplo.comCPF do signatário. Exemplo:
12345678901Response
Lista de signatários.
Show properties
Show properties
UUID do signatário. Exemplo:
d6c8a310-1af1-4bc5-99c9-e80d9260de3cCódigo do signatário. Exemplo:
SIGN001Nome do signatário. Exemplo:
João da SilvaIdentificador (CPF/CNPJ). Exemplo:
12345678901E-mail do signatário. Exemplo:
joao@example.com{
"signers": [
{
"uuid": "d6c8a310-1af1-4bc5-99c9-e80d9260de3c",
"code": "SIGN001",
"name": "João da Silva",
"identifier": "12345678901",
"email": "joao@example.com"
}
]
}
⌘I
Listar signatários
curl --request GET \
--url https://api.valid.com/api/signature-processes/{signature_process}/signers \
--header 'x-api-key: <api-key>'import requests
url = "https://api.valid.com/api/signature-processes/{signature_process}/signers"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.valid.com/api/signature-processes/{signature_process}/signers', 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/{signature_process}/signers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/api/signature-processes/{signature_process}/signers"
req, _ := http.NewRequest("GET", 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))
}HttpResponse<String> response = Unirest.get("https://api.valid.com/api/signature-processes/{signature_process}/signers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/signature-processes/{signature_process}/signers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"signers": [
{
"uuid": "d6c8a310-1af1-4bc5-99c9-e80d9260de3c",
"code": "SIGN001",
"name": "João da Silva",
"identifier": "12345678901",
"email": "joao@example.com"
}
]
}