API
Obter detalhes de uma assinatura
Retorna os dados completos de uma assinatura específica associada a um signatário e um arquivo dentro de um processo de assinatura.
GET
/
api
/
signature-processes
/
{signature_process}
/
files
/
{file}
/
signatures
/
{signature}
Obter detalhes de uma assinatura
curl --request GET \
--url https://api.valid.com/api/signature-processes/{signature_process}/files/{file}/signatures/{signature} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.valid.com/api/signature-processes/{signature_process}/files/{file}/signatures/{signature}"
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/{signature_process}/files/{file}/signatures/{signature}', 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}/files/{file}/signatures/{signature}",
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/{signature_process}/files/{file}/signatures/{signature}"
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/{signature_process}/files/{file}/signatures/{signature}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/signature-processes/{signature_process}/files/{file}/signatures/{signature}")
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{
"code": "ARQ123",
"uuid": "6de96b5e-c14d-4eab-a08e-f59c270b18e9",
"type": 1,
"filename": "documento.pdf",
"signature": {
"type": "DIGITAL",
"signer": {
"uuid": "2b1e8a93-42d1-4ad4-8f53-7dfe5c994de2",
"code": "SIG001",
"certificate": {
"name": "Maria Silva",
"identifier": "12345678900",
"common_name": "Maria S.",
"certificate_authority": "ICP-Brasil",
"organizational_unit": "Validadora",
"organization_name": "Valid Certificadora",
"country": "BR",
"serial": "0123456789ABCDEF",
"start_at": "2025-01-01T00:00:00Z",
"end_at": "2026-01-01T00:00:00Z",
"version": "3",
"fields": [
"string"
]
}
},
"signed_filename": "documento_assinado.pdf",
"signed_extension": "pdf",
"signed_mime": "application/pdf",
"signed_hash_sha256": "abc123def456...",
"signed_size": 1048576,
"signed_at": "2025-05-23 14:00:00",
"signed_content": "JVBERi0xLjQKJcTl8uXrp/Og0MTGC..."
}
}
Path Parameters
string
required
UUID do processo de assinatura. Exemplo:
9a8e7c5f-3b90-4df7-b9ec-a3215b2fef17string
required
UUID do arquivo assinado. Exemplo:
6de96b5e-c14d-4eab-a08e-f59c270b18e9string
required
UUID do signatário (assinatura). Exemplo:
2b1e8a93-42d1-4ad4-8f53-7dfe5c994de2Response
string
Código do arquivo. Exemplo:
ARQ123string
UUID do arquivo. Exemplo:
6de96b5e-c14d-4eab-a08e-f59c270b18e9integer
Tipo do arquivo. Exemplo:
1string
Nome do arquivo original. Exemplo:
documento.pdfobject
Detalhes da assinatura.
Show properties
Show properties
string
Tipo de assinatura. Exemplo:
DIGITALobject
Dados do signatário.
Show properties
Show properties
string
UUID do signatário.
string
Código do signatário. Exemplo:
SIG001object
Informações do certificado.
Show properties
Show properties
string
Nome no certificado. Exemplo:
Maria Silvastring
CPF/CNPJ. Exemplo:
12345678900string
Common Name (CN). Exemplo:
Maria S.string
Autoridade Certificadora. Exemplo:
ICP-Brasilstring
Exemplo:
Validadorastring
Nome da Organização. Exemplo:
Valid Certificadorastring
País. Exemplo:
BRstring
Serial. Exemplo:
0123456789ABCDEFstring
Início da validade. Exemplo:
2025-01-01T00:00:00Zstring
Fim da validade. Exemplo:
2026-01-01T00:00:00Zinteger
Versão. Exemplo:
1array
Campos extras. Exemplo:
["string"]string
Nome do arquivo assinado. Exemplo:
documento_assinado.pdfstring
Extensão do arquivo assinado. Exemplo:
pdfstring
MIME Type do arquivo assinado. Exemplo:
application/pdfstring
Hash SHA256 do arquivo assinado. Exemplo:
abc123def456...integer
Tamanho do arquivo assinado em bytes. Exemplo:
1048576string
Data e hora da assinatura. Exemplo:
2025-05-23 14:00:00string
Conteúdo do arquivo assinado em Base64. Exemplo:
JVBERi0xLjQKJcTl8uXrp/Og0MTGC...{
"code": "ARQ123",
"uuid": "6de96b5e-c14d-4eab-a08e-f59c270b18e9",
"type": 1,
"filename": "documento.pdf",
"signature": {
"type": "DIGITAL",
"signer": {
"uuid": "2b1e8a93-42d1-4ad4-8f53-7dfe5c994de2",
"code": "SIG001",
"certificate": {
"name": "Maria Silva",
"identifier": "12345678900",
"common_name": "Maria S.",
"certificate_authority": "ICP-Brasil",
"organizational_unit": "Validadora",
"organization_name": "Valid Certificadora",
"country": "BR",
"serial": "0123456789ABCDEF",
"start_at": "2025-01-01T00:00:00Z",
"end_at": "2026-01-01T00:00:00Z",
"version": "3",
"fields": [
"string"
]
}
},
"signed_filename": "documento_assinado.pdf",
"signed_extension": "pdf",
"signed_mime": "application/pdf",
"signed_hash_sha256": "abc123def456...",
"signed_size": 1048576,
"signed_at": "2025-05-23 14:00:00",
"signed_content": "JVBERi0xLjQKJcTl8uXrp/Og0MTGC..."
}
}
⌘I
Obter detalhes de uma assinatura
curl --request GET \
--url https://api.valid.com/api/signature-processes/{signature_process}/files/{file}/signatures/{signature} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.valid.com/api/signature-processes/{signature_process}/files/{file}/signatures/{signature}"
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/{signature_process}/files/{file}/signatures/{signature}', 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}/files/{file}/signatures/{signature}",
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/{signature_process}/files/{file}/signatures/{signature}"
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/{signature_process}/files/{file}/signatures/{signature}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/signature-processes/{signature_process}/files/{file}/signatures/{signature}")
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{
"code": "ARQ123",
"uuid": "6de96b5e-c14d-4eab-a08e-f59c270b18e9",
"type": 1,
"filename": "documento.pdf",
"signature": {
"type": "DIGITAL",
"signer": {
"uuid": "2b1e8a93-42d1-4ad4-8f53-7dfe5c994de2",
"code": "SIG001",
"certificate": {
"name": "Maria Silva",
"identifier": "12345678900",
"common_name": "Maria S.",
"certificate_authority": "ICP-Brasil",
"organizational_unit": "Validadora",
"organization_name": "Valid Certificadora",
"country": "BR",
"serial": "0123456789ABCDEF",
"start_at": "2025-01-01T00:00:00Z",
"end_at": "2026-01-01T00:00:00Z",
"version": "3",
"fields": [
"string"
]
}
},
"signed_filename": "documento_assinado.pdf",
"signed_extension": "pdf",
"signed_mime": "application/pdf",
"signed_hash_sha256": "abc123def456...",
"signed_size": 1048576,
"signed_at": "2025-05-23 14:00:00",
"signed_content": "JVBERi0xLjQKJcTl8uXrp/Og0MTGC..."
}
}