Download one document of a signing request

curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/download \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/download"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/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://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/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 => [
    "Authorization: <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.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/download"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<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.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/download")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "download_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "code": "ALREADY_CANCELLED",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "<string>",
  "code": "ALREADY_CANCELLED",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "ALREADY_CANCELLED",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

Signing Requests

Download one document of a signing request

type=original (the default): a signed URL to the document as uploaded (404 DOCUMENT_ORIGINAL_NOT_AVAILABLE when it is no longer stored). type=document: a signed URL to the individually sealed document, available once the certificate is bound (404 DOCUMENT_SIGNED_NOT_AVAILABLE before). The URL is valid for 1 hour.

Available to every company. This operation is part of the multi-document contract (API 01.39.00). For a signing request or template the API key cannot see, it answers 404 with code NOT_FOUND (“Endpoint not found”), exactly as an unknown endpoint does. While multi-document editing is suspended, this operation remains available for parents on the multi-document read-only path; parents on the single-document path answer 404 NOT_FOUND.

GET

signing-requests

{id}

documents

{document_id}

download

Download one document of a signing request

curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/download \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/download"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/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://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/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 => [
    "Authorization: <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.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/download"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<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.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/download")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/documents/{document_id}/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "download_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "code": "ALREADY_CANCELLED",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "<string>",
  "code": "ALREADY_CANCELLED",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "ALREADY_CANCELLED",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

{
  "error": "<string>",
  "code": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "details": {}
}

Authorizations

Authorization

string

header

required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

string<uuid>

required

Signing request ID

document_id

string<uuid>

required

The document id (documents[].document_id)

Query Parameters

type

enum<string>

default:original

Which file to download

Available options:

original,

document

Response

A signed download URL

download_url

string<uri>

required

expires_at

string<date-time>

required