Obter dados de envelope via sessão de validação

GET

signer

validator

session

:sessionUuid

Obter dados de envelope via sessão de validação

curl --request GET \
  --url https://api.valid.com/signer/v1/validator/session/:sessionUuid \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/signer/v1/validator/session/:sessionUuid', 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/signer/v1/validator/session/:sessionUuid",
  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/signer/v1/validator/session/:sessionUuid"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/signer/v1/validator/session/:sessionUuid")

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "validatedAt": "2025-07-27T11:00:00Z",
  "envelope": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "state": "FINALIZADO",
    "title": "Contrato de Serviços",
    "processId": "PROC-2025-001",
    "originalDocumentId": "DOC-001",
    "originalDocumentHash": "abc123def456..."
  },
  "signers": [
    {
      "name": "João da Silva",
      "email": "joao@empresa.com",
      "cpf": "123.456.789-00",
      "signedAt": "2025-07-27T10:30:00Z"
    },
    {
      "name": "Maria Santos",
      "email": "maria@empresa.com",
      "cpf": "987.654.321-00",
      "signedAt": "2025-07-27T10:45:00Z"
    }
  ],
  "downloadUrl": "https://storage.googleapis.com/bucket/signed-doc.pdf?X-Goog-Algorithm=..."
}

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "statusCode": 410,
  "message": "Validation session expired"
}

Resolve uma sessão de validação em dados completos do envelope: metadados, lista de signatários com datas de assinatura, e link para download do documento assinado. Na primeira chamada bem-sucedida, marca a sessão como validada. Autenticação: este endpoint é público — nenhuma autenticação é necessário.

Parâmetros

string

required

UUID da sessão de validação retornado por POST /signer/v1/validator/verify.

Respostas

string

Timestamp (ISO-8601) de quando a sessão foi validada pela primeira vez. Presente apenas após a primeira chamada bem-sucedida (não será null em chamadas subsequentes).

object

required

Dados gerais do envelope.

Show Propriedades de envelope

string

UUID do envelope.

string

Estado atual do envelope (ex: FINALIZADO).

string

Título do envelope.

string

ID do processo.

string

ID do documento original.

string

Hash do documento original (para integridade).

array

required

Lista de signatários do envelope com status de assinatura.

Show Propriedades de signers[]

string

Nome do signatário.

string

E-mail do signatário.

string

CPF do signatário.

string

Timestamp (ISO-8601) de quando o signatário assinou (ou null se ainda não assinou).

string

URL pré-assinada para download do documento assinado. Presente apenas se o envelope foi finalizado (todos os signatários assinaram). URL válida por 15 minutos.

Erros

404: Sessão de validação, envelope ou arquivo não encontrado.
410: A sessão de validação expirou (TTL de 15 minutos).

HTTP/1.1 200 OK
Content-Type: application/json

{
  "validatedAt": "2025-07-27T11:00:00Z",
  "envelope": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "state": "FINALIZADO",
    "title": "Contrato de Serviços",
    "processId": "PROC-2025-001",
    "originalDocumentId": "DOC-001",
    "originalDocumentHash": "abc123def456..."
  },
  "signers": [
    {
      "name": "João da Silva",
      "email": "joao@empresa.com",
      "cpf": "123.456.789-00",
      "signedAt": "2025-07-27T10:30:00Z"
    },
    {
      "name": "Maria Santos",
      "email": "maria@empresa.com",
      "cpf": "987.654.321-00",
      "signedAt": "2025-07-27T10:45:00Z"
    }
  ],
  "downloadUrl": "https://storage.googleapis.com/bucket/signed-doc.pdf?X-Goog-Algorithm=..."
}

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "statusCode": 410,
  "message": "Validation session expired"
}

Exemplo

curl -X GET "https://api.valid.com/signer/v1/validator/session/550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json"

Importante

Sem autenticação: este endpoint é totalmente público — qualquer pessoa com o sessionUuid pode consultar.
TTL de 15 minutos: se a sessão tiver expirado, crie uma nova com POST /signer/v1/validator/verify.
Idempotente: chamar múltiplas vezes com o mesmo sessionUuid retorna os mesmos dados; validatedAt não muda.
URL de download com prazo: o downloadUrl, quando presente, expira em 15 minutos — faça o download logo após obter a URL.

Próximas etapas

Se o envelope ainda não foi finalizado (nem todos os signatários assinaram), downloadUrl será null.
Se o envelope foi finalizado, use downloadUrl para fazer download do documento assinado.
Se a sessão expirou, crie uma nova com POST /signer/v1/validator/verify.

⌘I

Obter dados de envelope via sessão de validação

curl --request GET \
  --url https://api.valid.com/signer/v1/validator/session/:sessionUuid \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/signer/v1/validator/session/:sessionUuid', 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/signer/v1/validator/session/:sessionUuid",
  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/signer/v1/validator/session/:sessionUuid"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/signer/v1/validator/session/:sessionUuid")

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "validatedAt": "2025-07-27T11:00:00Z",
  "envelope": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "state": "FINALIZADO",
    "title": "Contrato de Serviços",
    "processId": "PROC-2025-001",
    "originalDocumentId": "DOC-001",
    "originalDocumentHash": "abc123def456..."
  },
  "signers": [
    {
      "name": "João da Silva",
      "email": "joao@empresa.com",
      "cpf": "123.456.789-00",
      "signedAt": "2025-07-27T10:30:00Z"
    },
    {
      "name": "Maria Santos",
      "email": "maria@empresa.com",
      "cpf": "987.654.321-00",
      "signedAt": "2025-07-27T10:45:00Z"
    }
  ],
  "downloadUrl": "https://storage.googleapis.com/bucket/signed-doc.pdf?X-Goog-Algorithm=..."
}

HTTP/1.1 410 Gone
Content-Type: application/json

{
  "statusCode": 410,
  "message": "Validation session expired"
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Obter dados de envelope via sessão de validação

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas

​Parâmetros

​Respostas

​Erros

​Exemplo

​Importante

​Próximas etapas

Parâmetros

Respostas

Erros

Exemplo

Importante

Próximas etapas