Obter sessão de assinatura

GET

sign

:sessionToken

curl --request GET \
  --url https://api.valid.com/v1/sign/:sessionToken \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.valid.com/v1/sign/:sessionToken', 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/v1/sign/:sessionToken",
  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/v1/sign/:sessionToken"

	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/v1/sign/:sessionToken")

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

{
  "envelope": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Contrato de Serviços",
    "externalCode": "CONT-2025-001",
    "state": "SIGNING_IN_PROGRESS",
    "dueDate": "2025-12-31T23:59:59Z",
    "templateId": null
  },
  "signer": {
    "uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "name": "João Silva",
    "email": "jo***@empresa.com",
    "cpf": "123.456.789-**",
    "phoneCountryCode": "55",
    "phoneNumber": "11987654321"
  },
  "file": {
    "uuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
    "filename": "contrato.pdf",
    "mime": "application/pdf",
    "sizeBytes": 250000,
    "downloadUrl": "https://storage.googleapis.com/bucket/file.pdf?X-Goog-Algorithm=...",
    "downloadUrlExpiresAt": "2025-07-27T11:00:00.000Z"
  },
  "fields": []
}

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

{
  "statusCode": 410,
  "message": "Session expired"
}

Retorna todos os dados necessários para o signatário assinar: detalhes do envelope, seus dados como signatário, arquivo a assinar e campos dinâmicos (se houver). Esta chamada também marca a sessão como acessada (transição para SIGNING_IN_PROGRESS). Autenticação: use apenas o sessionToken na URL — nenhum header de autenticação é necessário.

Parâmetros

string

required

Token único da sessão do signatário (obtido em POST /v1/envelopes ou POST /v1/templates/:uuid/envelopes).

Respostas

object

Dados gerais do envelope.

Show Propriedades de envelope

string

UUID do envelope.

string

Título do envelope.

string

Código externo do seu sistema (se fornecido).

string

Estado atual do envelope.

string

Data limite (ISO 8601).

string

ID do template (se baseado em template).

object

Dados do signatário.

Show Propriedades de signer

string

UUID do signatário.

string

Nome completo (não mascarado neste contexto).

string

E-mail (mascarado parcialmente, ex: jo***@empresa.com).

string

CPF (mascarado, ex: 123.456.789-**).

string

Código de país do telefone.

string

Número de telefone.

object

Arquivo a assinar.

Show Propriedades de file

string

UUID do arquivo.

string

Nome do arquivo.

string

MIME type (ex: application/pdf).

integer

Tamanho em bytes.

string

URL assinada para download do PDF (válida por 15 minutos). Aponta para o PDF em branco/original, não o assinado.

string

Timestamp de expiração da URL.

array

Campos dinâmicos do template (vazio se não houver template).

Show Propriedades de fields[]

string

Identificador do campo.

string

UUID interno.

string

Tipo: text, signature, checkbox, radio, date, select.

string

Rótulo do campo.

boolean

Se é obrigatório.

string | string[] | boolean

Valor atual (pode estar vazio se pendente).

string

Estado: pending, filled, locked, invalid.

boolean

Se este campo está atribuído ao signatário atual (responsável por preencher).

boolean

Se o signatário pode preencher este campo (combinação de editableBySigner e estado).

array

Para radio/select, lista de opções disponíveis.

Erros

Veja Autenticação e erros.

404: Session token não encontrado ou envelope/signatário inválido.
410: Session token expirado (envelope expirou ou foi deletado).

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

{
  "envelope": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Contrato de Serviços",
    "externalCode": "CONT-2025-001",
    "state": "SIGNING_IN_PROGRESS",
    "dueDate": "2025-12-31T23:59:59Z",
    "templateId": null
  },
  "signer": {
    "uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "name": "João Silva",
    "email": "jo***@empresa.com",
    "cpf": "123.456.789-**",
    "phoneCountryCode": "55",
    "phoneNumber": "11987654321"
  },
  "file": {
    "uuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
    "filename": "contrato.pdf",
    "mime": "application/pdf",
    "sizeBytes": 250000,
    "downloadUrl": "https://storage.googleapis.com/bucket/file.pdf?X-Goog-Algorithm=...",
    "downloadUrlExpiresAt": "2025-07-27T11:00:00.000Z"
  },
  "fields": []
}

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

{
  "statusCode": 410,
  "message": "Session expired"
}

Exemplo

curl -X GET "https://signer.vcc-service.com/v1/sign/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json"

Importante

Sem autenticação por header: o sessionToken é toda a autenticação necessária.
URL de preview: para visualizar o PDF com campos preenchidos, use GET /v1/sign/:sessionToken/preview em vez de downloadUrl.
Primeiro acesso: esta chamada marca a sessão como acessada, transicionando o envelope para SIGNING_IN_PROGRESS.

Próximas etapas

Se houver campos pendentes: preencha com PATCH /v1/sign/:sessionToken/fields.
Visualize o PDF: use GET /v1/sign/:sessionToken/preview.
Assine: chame POST /v1/sign/:sessionToken/sign (ou POST /signature/envelope-sessions/:sessionToken/submit para templates).
Se recusar: POST /v1/sign/:sessionToken/refuse.

⌘I

Obter sessão de assinatura

curl --request GET \
  --url https://api.valid.com/v1/sign/:sessionToken \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.valid.com/v1/sign/:sessionToken', 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/v1/sign/:sessionToken",
  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/v1/sign/:sessionToken"

	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/v1/sign/:sessionToken")

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

{
  "envelope": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Contrato de Serviços",
    "externalCode": "CONT-2025-001",
    "state": "SIGNING_IN_PROGRESS",
    "dueDate": "2025-12-31T23:59:59Z",
    "templateId": null
  },
  "signer": {
    "uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "name": "João Silva",
    "email": "jo***@empresa.com",
    "cpf": "123.456.789-**",
    "phoneCountryCode": "55",
    "phoneNumber": "11987654321"
  },
  "file": {
    "uuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
    "filename": "contrato.pdf",
    "mime": "application/pdf",
    "sizeBytes": 250000,
    "downloadUrl": "https://storage.googleapis.com/bucket/file.pdf?X-Goog-Algorithm=...",
    "downloadUrlExpiresAt": "2025-07-27T11:00:00.000Z"
  },
  "fields": []
}

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

{
  "statusCode": 410,
  "message": "Session expired"
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

BPO

Extração Dados

Mensageria

Documentoscopia

Obter sessão de assinatura

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