API
Atualizar signatário
Atualiza os dados de um signatário em um processo de assinatura.
PUT
/
api
/
signature-processes
/
{signature_process}
/
signers
/
{signer}
Atualizar signatário
curl --request PUT \
--url https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"code": "<string>",
"name": "<string>",
"identifier": "<string>",
"email": "<string>",
"qualification": "<string>",
"signature_process_type_id": 123,
"phone_country_code": "<string>",
"phone_number": "<string>",
"birth_date": "<string>",
"token_type": 123
}
'import requests
url = "https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}"
payload = {
"code": "<string>",
"name": "<string>",
"identifier": "<string>",
"email": "<string>",
"qualification": "<string>",
"signature_process_type_id": 123,
"phone_country_code": "<string>",
"phone_number": "<string>",
"birth_date": "<string>",
"token_type": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: '<string>',
name: '<string>',
identifier: '<string>',
email: '<string>',
qualification: '<string>',
signature_process_type_id: 123,
phone_country_code: '<string>',
phone_number: '<string>',
birth_date: '<string>',
token_type: 123
})
};
fetch('https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}', 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/{signer}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'code' => '<string>',
'name' => '<string>',
'identifier' => '<string>',
'email' => '<string>',
'qualification' => '<string>',
'signature_process_type_id' => 123,
'phone_country_code' => '<string>',
'phone_number' => '<string>',
'birth_date' => '<string>',
'token_type' => 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/api/signature-processes/{signature_process}/signers/{signer}"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"qualification\": \"<string>\",\n \"signature_process_type_id\": 123,\n \"phone_country_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"token_type\": 123\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"qualification\": \"<string>\",\n \"signature_process_type_id\": 123,\n \"phone_country_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"token_type\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"qualification\": \"<string>\",\n \"signature_process_type_id\": 123,\n \"phone_country_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"token_type\": 123\n}"
response = http.request(request)
puts response.read_body{
"message": "Signatário atualizado com sucesso"
}
Path Parameters
UUID do processo de assinatura. Exemplo:
e7d4f2aa-34bc-4321-ae11-123456789abcUUID do signatário. Exemplo:
fe98d89b-9abc-4f67-a891-123456789abcBody Parameters
Código interno do signatário. Exemplo:
SIGN001Nome do signatário. Exemplo:
Maria OliveiraCPF do signatário. Exemplo:
12345678909E-mail do signatário. Exemplo:
maria@example.comQualificação (ex: Cargo). Exemplo:
DiretoraTipo de assinatura: 1 (Digital), 2 (Eletrônico), 3 (Híbrido). Exemplo:
1DDI do telefone. Exemplo:
55Número do telefone. Exemplo:
11999999999Data de nascimento (YYYY-MM-DD). Exemplo:
1985-07-15Tipo de token. Exemplo:
1Response
Mensagem de sucesso. Exemplo:
Signatário atualizado com sucesso{
"message": "Signatário atualizado com sucesso"
}
⌘I
Atualizar signatário
curl --request PUT \
--url https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"code": "<string>",
"name": "<string>",
"identifier": "<string>",
"email": "<string>",
"qualification": "<string>",
"signature_process_type_id": 123,
"phone_country_code": "<string>",
"phone_number": "<string>",
"birth_date": "<string>",
"token_type": 123
}
'import requests
url = "https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}"
payload = {
"code": "<string>",
"name": "<string>",
"identifier": "<string>",
"email": "<string>",
"qualification": "<string>",
"signature_process_type_id": 123,
"phone_country_code": "<string>",
"phone_number": "<string>",
"birth_date": "<string>",
"token_type": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: '<string>',
name: '<string>',
identifier: '<string>',
email: '<string>',
qualification: '<string>',
signature_process_type_id: 123,
phone_country_code: '<string>',
phone_number: '<string>',
birth_date: '<string>',
token_type: 123
})
};
fetch('https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}', 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/{signer}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'code' => '<string>',
'name' => '<string>',
'identifier' => '<string>',
'email' => '<string>',
'qualification' => '<string>',
'signature_process_type_id' => 123,
'phone_country_code' => '<string>',
'phone_number' => '<string>',
'birth_date' => '<string>',
'token_type' => 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/api/signature-processes/{signature_process}/signers/{signer}"
payload := strings.NewReader("{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"qualification\": \"<string>\",\n \"signature_process_type_id\": 123,\n \"phone_country_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"token_type\": 123\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"qualification\": \"<string>\",\n \"signature_process_type_id\": 123,\n \"phone_country_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"token_type\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/signature-processes/{signature_process}/signers/{signer}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"<string>\",\n \"name\": \"<string>\",\n \"identifier\": \"<string>\",\n \"email\": \"<string>\",\n \"qualification\": \"<string>\",\n \"signature_process_type_id\": 123,\n \"phone_country_code\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"token_type\": 123\n}"
response = http.request(request)
puts response.read_body{
"message": "Signatário atualizado com sucesso"
}