Adicionar signatário

Insere um novo signatário em um processo de assinatura.

POST /api/signature-processes/{signature_process}/signers

Adicionar signatário

cURL

curl --request POST \
  --url https://api.valid.com/api/signature-processes/{signature_process}/signers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "code": "<string>",
  "identifier": "<string>",
  "qualification": "<string>",
  "signature_process_type_id": 123,
  "phone_country_code": "<string>",
  "phone_number": "<string>",
  "birth_date": "<string>",
  "token_type": 123,
  "files_uuids": [
    {}
  ],
  "options": {}
}
'

import requests

url = "https://api.valid.com/api/signature-processes/{signature_process}/signers"

payload = {
    "name": "<string>",
    "email": "<string>",
    "code": "<string>",
    "identifier": "<string>",
    "qualification": "<string>",
    "signature_process_type_id": 123,
    "phone_country_code": "<string>",
    "phone_number": "<string>",
    "birth_date": "<string>",
    "token_type": 123,
    "files_uuids": [{}],
    "options": {}
}
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({
    name: '<string>',
    email: '<string>',
    code: '<string>',
    identifier: '<string>',
    qualification: '<string>',
    signature_process_type_id: 123,
    phone_country_code: '<string>',
    phone_number: '<string>',
    birth_date: '<string>',
    token_type: 123,
    files_uuids: [{}],
    options: {}
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'email' => '<string>',
    'code' => '<string>',
    'identifier' => '<string>',
    'qualification' => '<string>',
    'signature_process_type_id' => 123,
    'phone_country_code' => '<string>',
    'phone_number' => '<string>',
    'birth_date' => '<string>',
    'token_type' => 123,
    'files_uuids' => [
        [
                
        ]
    ],
    'options' => [
        
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"code\": \"<string>\",\n  \"identifier\": \"<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  \"files_uuids\": [\n    {}\n  ],\n  \"options\": {}\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/{signature_process}/signers")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"code\": \"<string>\",\n  \"identifier\": \"<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  \"files_uuids\": [\n    {}\n  ],\n  \"options\": {}\n}")
  .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::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"code\": \"<string>\",\n  \"identifier\": \"<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  \"files_uuids\": [\n    {}\n  ],\n  \"options\": {}\n}"

response = http.request(request)
puts response.read_body

200 OK

{
  "message": "Signatário inserido com sucesso.",
  "code": "SIGN001",
  "uuid": "d7d3ac84-1234-4bbb-bbbb-abcdefabcdef"
}

Path Parameters

signature_process · string · required

UUID do processo de assinatura. Exemplo: e7d4f2aa-34bc-4321-ae11-123456789abc

Body Parameters

name · string · required

Nome do signatário. Exemplo: João da Silva

email · string · required

E-mail do signatário. Exemplo: [e-mail]

code · string

Código interno do signatário. Exemplo: SIGN001

identifier · string

CPF do signatário. Exemplo: 12345678909

qualification · string

Qualificação (ex: Cargo). Exemplo: Advogado

signature_process_type_id · integer

Tipo de assinatura: 1 (Digital), 2 (Eletrônico), 3 (Híbrido). Exemplo: 1

phone_country_code · string

DDI do telefone. Exemplo: 55

phone_number · string

Número do telefone. Exemplo: 11999999999

birth_date · string

Data de nascimento (YYYY-MM-DD). Exemplo: 1990-01-01

token_type · integer

Tipo de token. Exemplo: 1

files_uuids · array

Lista de UUIDs dos arquivos que o signatário deve assinar.

options · object

Opções adicionais.

Show properties

send_init_emails · boolean

Enviar e-mails de inicialização. Exemplo: true

Response

message · string

Mensagem de sucesso. Exemplo: Signatário inserido com sucesso.

code · string

Código do signatário. Exemplo: SIGN001

uuid · string

UUID do signatário criado. Exemplo: d7d3ac84-1234-4bbb-bbbb-abcdefabcdef

200 OK

{
  "message": "Signatário inserido com sucesso.",
  "code": "SIGN001",
  "uuid": "d7d3ac84-1234-4bbb-bbbb-abcdefabcdef"
}