Listar processos

Retorna todos os processos de assinatura com base em filtros opcionais.

GET /api/signature-processes

Listar processos

cURL

curl --request GET \
  --url https://api.valid.com/api/signature-processes \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.valid.com/api/signature-processes"

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', 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",
  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"

	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")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

200 OK

{
  "signature_processes": [
    {
      "uuid": "8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d",
      "code": "PRC-2023-001",
      "title": "Contrato de Prestação de Serviços",
      "type": 1,
      "state": 1,
      "created_at": "2023-10-15T14:30:00Z",
      "updated_at": "2023-10-15T14:35:00Z"
    }
  ]
}

Parâmetros de Query

title · string

Nome do envelope (processo). Exemplo: Contrato

code · string

Código do processo. Exemplo: PRC-2023-001

type · integer

Tipo do processo. Exemplo: 1

signer_code · string

Código do signatário. Exemplo: SIG001

signer_name · string

Nome do signatário. Exemplo: Maria Silva

signer_email · string

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

signer_identifier · string

CPF/CNPJ do signatário. Exemplo: 12345678900

Resposta

signature_processes · array

Show Propriedades do Processo

uuid · string

UUID do processo.

code · string

Código externo do processo.

title · string

Título/Nome do processo.

type · integer

Tipo do processo.

state · integer

Estado atual (ex: Rascunho, Em andamento, Finalizado).

created_at · string

Data de criação.

updated_at · string

Data da última atualização.

200 OK

{
  "signature_processes": [
    {
      "uuid": "8e3b2e50-8b9a-4d7a-9b8c-1e2f3a4b5c6d",
      "code": "PRC-2023-001",
      "title": "Contrato de Prestação de Serviços",
      "type": 1,
      "state": 1,
      "created_at": "2023-10-15T14:30:00Z",
      "updated_at": "2023-10-15T14:35:00Z"
    }
  ]
}