Obter detalhes de um arquivo

GET

api

signature-processes

{signature_process}

files

{file}

Obter detalhes de um arquivo

curl --request GET \
  --url https://api.valid.com/api/signature-processes/{signature_process}/files/{file} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.valid.com/api/signature-processes/{signature_process}/files/{file}"

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}', 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}",
  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}"

	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/api/signature-processes/{signature_process}/files/{file}")

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

{
  "uuid": "a71f3f7e-e48f-472e-8d9d-45c2c7861aa7",
  "code": "ARQ001",
  "filename": "contrato-assinado.pdf",
  "type": 1,
  "extension": "pdf",
  "mime": "application/pdf",
  "hash_sha256": "abc123hashsha256...",
  "size": 204800,
  "signers_uuids": [
    "string"
  ],
  "file_content": "JVBERi0xLjcKJeLjz9M..."
}

Path Parameters

string

required

UUID do processo de assinatura. Exemplo: c8f84d0c-91f3-4a36-b899-19bd859edfa4

string

required

UUID do arquivo. Exemplo: a71f3f7e-e48f-472e-8d9d-45c2c7861aa7

Response

string

UUID do arquivo. Exemplo: a71f3f7e-e48f-472e-8d9d-45c2c7861aa7

string

Código do arquivo. Exemplo: ARQ001

string

Nome do arquivo. Exemplo: contrato-assinado.pdf

integer

Tipo do arquivo. Exemplo: 1

string

Extensão do arquivo. Exemplo: pdf

string

Tipo MIME do arquivo. Exemplo: application/pdf

string

Hash SHA256 do arquivo. Exemplo: abc123hashsha256...

integer

Tamanho do arquivo em bytes. Exemplo: 204800

array

Lista de UUIDs dos signatários.

string

Conteúdo do arquivo em Base64. Exemplo: JVBERi0xLjcKJeLjz9M...

{
  "uuid": "a71f3f7e-e48f-472e-8d9d-45c2c7861aa7",
  "code": "ARQ001",
  "filename": "contrato-assinado.pdf",
  "type": 1,
  "extension": "pdf",
  "mime": "application/pdf",
  "hash_sha256": "abc123hashsha256...",
  "size": 204800,
  "signers_uuids": [
    "string"
  ],
  "file_content": "JVBERi0xLjcKJeLjz9M..."
}

⌘I

Obter detalhes de um arquivo

curl --request GET \
  --url https://api.valid.com/api/signature-processes/{signature_process}/files/{file} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.valid.com/api/signature-processes/{signature_process}/files/{file}"

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}', 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}",
  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}"

	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/api/signature-processes/{signature_process}/files/{file}")

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

{
  "uuid": "a71f3f7e-e48f-472e-8d9d-45c2c7861aa7",
  "code": "ARQ001",
  "filename": "contrato-assinado.pdf",
  "type": 1,
  "extension": "pdf",
  "mime": "application/pdf",
  "hash_sha256": "abc123hashsha256...",
  "size": 204800,
  "signers_uuids": [
    "string"
  ],
  "file_content": "JVBERi0xLjcKJeLjz9M..."
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

BPO

Extração Dados

Mensageria

Documentoscopia

Obter detalhes de um arquivo

Path Parameters

Response

​Path Parameters

​Response

Path Parameters

Response