Download agreement PDF

Download the current agreement PDF for a silo entry. Returns the signed mandate if already signed, otherwise the unsigned template.

GET /apps/gov-fr/v1/entry/{silo_entry_id}/agreement

Download the agreement PDF

cURL

curl --request GET \
  --url https://api.invopop.com/apps/gov-fr/v1/entry/{silo_entry_id}/agreement \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.invopop.com/apps/gov-fr/v1/entry/{silo_entry_id}/agreement"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.invopop.com/apps/gov-fr/v1/entry/{silo_entry_id}/agreement', 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.invopop.com/apps/gov-fr/v1/entry/{silo_entry_id}/agreement",
  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: Bearer <token>"
  ],
]);

$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.invopop.com/apps/gov-fr/v1/entry/{silo_entry_id}/agreement"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.invopop.com/apps/gov-fr/v1/entry/{silo_entry_id}/agreement")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.invopop.com/apps/gov-fr/v1/entry/{silo_entry_id}/agreement")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

"<string>"

{
  "error": "missing enrollment"
}

{
  "error": "directory API is only available for live workspaces"
}

{
  "error": "silo entry not found"
}

{
  "error": "draft party is missing signer details"
}

{
  "error": "internal server error"
}

Returns the current agreement PDF. If the signer has already completed the signing step (POST /sign or POST /agreement), the signed mandate is returned. Otherwise the unsigned template is returned, pre-filled with the party’s details.

Authorizations

Authorization · string · header · required

Authenticate using a valid Invopop enrollment token in the Bearer scheme.

Example: Authorization: Bearer <token>

Path Parameters

silo_entry_id · string · required

ID of the org.Party silo entry being onboarded.

Example:

"5b45453c-cdd0-11ed-afa1-0242ac120002"

Response

200

application/pdf

Agreement PDF, served inline.

The response is of type file.