API
Inserir novo arquivo
Insere um novo arquivo no processo de assinatura. O conteúdo pode ser enviado via base64 ou via URL.
POST
/
api
/
signature-processes
/
{signature_process}
/
files
Inserir novo arquivo
curl --request POST \
--url https://api.valid.com/api/signature-processes/{signature_process}/files \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"filename": "<string>",
"extension": "<string>",
"code": "<string>",
"content": "<string>",
"url": "<string>",
"signers_uuids": [
{}
]
}
'import requests
url = "https://api.valid.com/api/signature-processes/{signature_process}/files"
payload = {
"filename": "<string>",
"extension": "<string>",
"code": "<string>",
"content": "<string>",
"url": "<string>",
"signers_uuids": [{}]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filename: '<string>',
extension: '<string>',
code: '<string>',
content: '<string>',
url: '<string>',
signers_uuids: [{}]
})
};
fetch('https://api.valid.com/api/signature-processes/{signature_process}/files', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filename' => '<string>',
'extension' => '<string>',
'code' => '<string>',
'content' => '<string>',
'url' => '<string>',
'signers_uuids' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.valid.com/api/signature-processes/{signature_process}/files"
payload := strings.NewReader("{\n \"filename\": \"<string>\",\n \"extension\": \"<string>\",\n \"code\": \"<string>\",\n \"content\": \"<string>\",\n \"url\": \"<string>\",\n \"signers_uuids\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.valid.com/api/signature-processes/{signature_process}/files")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filename\": \"<string>\",\n \"extension\": \"<string>\",\n \"code\": \"<string>\",\n \"content\": \"<string>\",\n \"url\": \"<string>\",\n \"signers_uuids\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/signature-processes/{signature_process}/files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filename\": \"<string>\",\n \"extension\": \"<string>\",\n \"code\": \"<string>\",\n \"content\": \"<string>\",\n \"url\": \"<string>\",\n \"signers_uuids\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "Arquivo inserido com sucesso.",
"code": "ARQ001",
"uuid": "fa17f9e4-5555-41c3-8b69-e7e9b71cf3c4",
"type": 1
}
Path Parameters
string
required
UUID do processo de assinatura. Exemplo:
a2e9cbf7-442e-4c03-a353-5e58c53d1d1fBody Parameters
string
required
Nome do arquivo. Exemplo:
contrato.pdfstring
required
Extensão do arquivo. Exemplo:
pdfstring
Código do arquivo. Exemplo:
ARQ001string
Conteúdo do arquivo em Base64. Exemplo:
JVBERi0xLjQKJcTl8uXrp/Og0MTGC...string
URL do arquivo para download. Exemplo:
https://exemplo.com/arquivo.pdfarray
Lista de UUIDs dos signatários associados a este arquivo.
Response
string
Mensagem de sucesso. Exemplo:
Arquivo inserido com sucesso.string
Código do arquivo. Exemplo:
ARQ001string
UUID do arquivo criado. Exemplo:
fa17f9e4-5555-41c3-8b69-e7e9b71cf3c4integer
Tipo do arquivo. Exemplo:
1{
"message": "Arquivo inserido com sucesso.",
"code": "ARQ001",
"uuid": "fa17f9e4-5555-41c3-8b69-e7e9b71cf3c4",
"type": 1
}
⌘I
Inserir novo arquivo
curl --request POST \
--url https://api.valid.com/api/signature-processes/{signature_process}/files \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"filename": "<string>",
"extension": "<string>",
"code": "<string>",
"content": "<string>",
"url": "<string>",
"signers_uuids": [
{}
]
}
'import requests
url = "https://api.valid.com/api/signature-processes/{signature_process}/files"
payload = {
"filename": "<string>",
"extension": "<string>",
"code": "<string>",
"content": "<string>",
"url": "<string>",
"signers_uuids": [{}]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filename: '<string>',
extension: '<string>',
code: '<string>',
content: '<string>',
url: '<string>',
signers_uuids: [{}]
})
};
fetch('https://api.valid.com/api/signature-processes/{signature_process}/files', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filename' => '<string>',
'extension' => '<string>',
'code' => '<string>',
'content' => '<string>',
'url' => '<string>',
'signers_uuids' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.valid.com/api/signature-processes/{signature_process}/files"
payload := strings.NewReader("{\n \"filename\": \"<string>\",\n \"extension\": \"<string>\",\n \"code\": \"<string>\",\n \"content\": \"<string>\",\n \"url\": \"<string>\",\n \"signers_uuids\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.valid.com/api/signature-processes/{signature_process}/files")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filename\": \"<string>\",\n \"extension\": \"<string>\",\n \"code\": \"<string>\",\n \"content\": \"<string>\",\n \"url\": \"<string>\",\n \"signers_uuids\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/api/signature-processes/{signature_process}/files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filename\": \"<string>\",\n \"extension\": \"<string>\",\n \"code\": \"<string>\",\n \"content\": \"<string>\",\n \"url\": \"<string>\",\n \"signers_uuids\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "Arquivo inserido com sucesso.",
"code": "ARQ001",
"uuid": "fa17f9e4-5555-41c3-8b69-e7e9b71cf3c4",
"type": 1
}