Obter template

GET

templates

:uuid

Obter template

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

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

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

	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/templates/:uuid")

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

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Contrato de Serviços",
  "filename": "contrato.pdf",
  "pageCount": 2,
  "pages": [
    { "index": 0, "nativeW": 595, "nativeH": 842 },
    { "index": 1, "nativeW": 595, "nativeH": 842 }
  ],
  "fields": [
    {
      "key": "nome_cliente",
      "fieldUuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "type": "text",
      "label": "Nome Completo",
      "required": true,
      "pageIndex": 0,
      "x": 0.1,
      "y": 0.2,
      "width": 0.8,
      "height": 0.05
    }
  ],
  "documentUrl": "https://storage.googleapis.com/bucket/template-550e8400.pdf?X-Goog-Algorithm=...",
  "expiresAt": "2025-07-27T11:00:00.000Z",
  "createdAt": "2025-07-27T10:30:00.000Z"
}

Retorna todos os detalhes de um template, incluindo campos dinâmicos e uma URL assinada para download do PDF em branco (sem campos preenchidos). Autenticação: esta operação não exige autenticação — qualquer um com o UUID do template consegue acessá-lo.

Parâmetros

string

required

UUID do template.

Respostas

string

UUID do template.

string

Título do template.

string

Nome do arquivo.

integer

Número de páginas.

array

Metadados das páginas.

array

Campos dinâmicos (mesmo shape de POST /v1/templates).

string

URL assinada para download do PDF em branco (sem campos preenchidos). Válida por 15 minutos.

string

Timestamp de expiração da URL.

string

Timestamp de criação.

Erros

Veja Autenticação e erros.

404: Template não encontrado.

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

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Contrato de Serviços",
  "filename": "contrato.pdf",
  "pageCount": 2,
  "pages": [
    { "index": 0, "nativeW": 595, "nativeH": 842 },
    { "index": 1, "nativeW": 595, "nativeH": 842 }
  ],
  "fields": [
    {
      "key": "nome_cliente",
      "fieldUuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "type": "text",
      "label": "Nome Completo",
      "required": true,
      "pageIndex": 0,
      "x": 0.1,
      "y": 0.2,
      "width": 0.8,
      "height": 0.05
    }
  ],
  "documentUrl": "https://storage.googleapis.com/bucket/template-550e8400.pdf?X-Goog-Algorithm=...",
  "expiresAt": "2025-07-27T11:00:00.000Z",
  "createdAt": "2025-07-27T10:30:00.000Z"
}

Exemplo

curl -X GET "https://signer.vcc-service.com/v1/templates/550e8400-e29b-41d4-a716-446655440000"

Importante

Sem autenticação: esta endpoint é pública para permitir que clientes visualizem templates sem API key.
PDF em branco: a URL aponta para o template original, sem campos preenchidos.
Campos com IDs internos: use o key (ex: "nome_cliente") para referenciar campos em chamadas de envelope/fields; o fieldUuid é apenas para compatibilidade interna.

Relacionado

GET /v1/templates — listar templates
POST /v1/templates/:uuid/fill — pré-visualizar com valores preenchidos
POST /v1/templates/:uuid/envelopes — criar envelope

⌘I

Obter template

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

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

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

	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/templates/:uuid")

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

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Contrato de Serviços",
  "filename": "contrato.pdf",
  "pageCount": 2,
  "pages": [
    { "index": 0, "nativeW": 595, "nativeH": 842 },
    { "index": 1, "nativeW": 595, "nativeH": 842 }
  ],
  "fields": [
    {
      "key": "nome_cliente",
      "fieldUuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "type": "text",
      "label": "Nome Completo",
      "required": true,
      "pageIndex": 0,
      "x": 0.1,
      "y": 0.2,
      "width": 0.8,
      "height": 0.05
    }
  ],
  "documentUrl": "https://storage.googleapis.com/bucket/template-550e8400.pdf?X-Goog-Algorithm=...",
  "expiresAt": "2025-07-27T11:00:00.000Z",
  "createdAt": "2025-07-27T10:30:00.000Z"
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

BPO

Extração Dados

Mensageria

Documentoscopia

Parâmetros

Respostas

Erros

Exemplo

Importante

Relacionado

​Parâmetros

​Respostas

​Erros

​Exemplo

​Importante

​Relacionado

Parâmetros

Respostas

Erros

Exemplo

Importante

Relacionado