Iniciar processo

Muda o estado do processo para ‘PROCESSING’ e envia os e-mails aos signatários.

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

Iniciar processo

cURL

curl --request POST \
  --url https://api.valid.com/api/signature-processes/{signature_process}/start \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "send_init_emails": true
}
'

import requests

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

payload = { "send_init_emails": True }
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({send_init_emails: true})
};

fetch('https://api.valid.com/api/signature-processes/{signature_process}/start', 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}/start",
  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([
    'send_init_emails' => true
  ]),
  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}/start"

	payload := strings.NewReader("{\n  \"send_init_emails\": true\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}/start")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"send_init_emails\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/api/signature-processes/{signature_process}/start")

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  \"send_init_emails\": true\n}"

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

200 OK

{
  "message": "Processo de assinatura iniciado com sucesso.",
  "signers": [
    {
      "code": "SIG-001",
      "uuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "url": "https://validsigner.com.br/signature/Token/uuid"
    }
  ]
}

Parâmetros de Path

signature_process · string · required

UUID do processo de assinatura. Exemplo: 8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d

Body

send_init_emails · boolean

Define se deve enviar e-mails de assinatura imediatamente. Padrão: true. Exemplo: true

Resposta

message · string

Mensagem de sucesso.

signers · array

Dados dos signatários (incluindo URLs geradas).

Show Signatário

code · string

Código.

uuid · string

UUID.

url · string

URL de assinatura única.

200 OK

{
  "message": "Processo de assinatura iniciado com sucesso.",
  "signers": [
    {
      "code": "SIG-001",
      "uuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "url": "https://validsigner.com.br/signature/Token/uuid"
    }
  ]
}