Packages
Download
GET
/
packages
/
{packageId}
/
documents
/
{documentId}
/
pdf
/
{version}
/
download
Download
curl --request GET \
--url https://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download \
--header 'api_key: <api-key>'import requests
url = "https://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download"
headers = {"api_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_key: '<api-key>'}};
fetch('https://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download', 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://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("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://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyHTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; name="example.pdf";filename*=utf-8''example.pdf
<PDF-BINARY-DATA>
Request
- Executed
- CAC
- Current revision
- Specific revision
Download the executed version of a document within a package. This provides access to the completed document that has been fully signed and is ready for record-keeping or distribution.
Request
GET /packages/{packageId}/documents/{documentId}/pdf/executed/download
Download the CAC (Compliance Audit Certificate) for a package.
Request
GET /packages/{packageId}/documents/{documentId}/pdf/cac/download
Download the current revision of a document within a package. This allows you to retrieve the most up-to-date version of the document, which may include any recent changes or signatures.
Request
GET /packages/{packageId}/documents/{documentId}/pdf/current/download
Use the
revisionId to download a specific revision of a document within a package. This is useful when you need to access a particular version of the document, such as one before or after certain changes were made.Request
GET /packages/{packageId}/documents/{documentId}/pdf/{revisionId}/download
Parameters
string
required
Unique identifier for the package to download a document from.
string
required
Unique identifier for the document within the package to download.
string
required
Specifies the version of the document to download. Accepted values are:
| Value | Description |
|---|---|
| executed | The fully signed and completed version of the document. |
| cac | The Compliance Audit Certificate for the package. |
| current | The most up-to-date revision of the document. |
{revisionId} | A specific unique revision identifier to download that particular version of the document. |
See the MasterFile download API for more information on downloading MasterFiles.
Response
Returns a PDF file of the requested document version.HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; name="example.pdf";filename*=utf-8''example.pdf
<PDF-BINARY-DATA>
⌘I
Download
curl --request GET \
--url https://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download \
--header 'api_key: <api-key>'import requests
url = "https://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download"
headers = {"api_key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {api_key: '<api-key>'}};
fetch('https://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download', 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://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("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://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download")
.header("api_key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.syngrafii.com/api/v1/packages/{packageId}/documents/{documentId}/pdf/{version}/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyHTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; name="example.pdf";filename*=utf-8''example.pdf
<PDF-BINARY-DATA>