Pack
curl --request GET \
--url https://{deployment}/v1/packs/{key} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{deployment}/v1/packs/{key}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{deployment}/v1/packs/{key}', 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://{deployment}/v1/packs/{key}",
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://{deployment}/v1/packs/{key}"
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://{deployment}/v1/packs/{key}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployment}/v1/packs/{key}")
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{
"pack_version": 123,
"generated_at": "2023-11-07T05:31:56Z",
"workspace_id": "<string>",
"disclaimer": {},
"instrument": {
"key": "<string>",
"jurisdiction": "<string>",
"regulator": "<string>",
"instrument": "<string>",
"version": "<string>",
"status": "<string>",
"accepted_by_customer": true,
"clauses": 123,
"by_provenance": {},
"instrument_ref": "<string>",
"source_url": "<string>",
"accepted_by": "<string>",
"accepted_on": "2023-11-07T05:31:56Z",
"caveat": "<string>"
},
"score": {
"satisfied": 123,
"scored_clauses": 123,
"percent": 123,
"note": "<string>"
},
"sections": [
{}
],
"gaps": [
{
"clause": "<string>",
"title": "<string>",
"missing": [
"<string>"
],
"fixes": []
}
],
"regime": {
"code": "<string>",
"name": "<string>",
"resolved_from": "<string>",
"assessed_against": "<string>",
"applies": [],
"requires_second_approver_above_minor": 123,
"second_approver_currency": "<string>",
"forbids": {}
},
"seal": {
"seal_version": 123,
"algorithm": "<string>",
"content_hash": "<string>",
"signature": "<string>",
"public_key": "<string>",
"signing_key_ref": "<string>",
"ephemeral": true,
"custody": "<string>",
"custody_means": "<string>",
"how_to_verify": "<string>",
"warning": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Regulatory
Pack
Assemble an evidence pack LIVE.
Never cached. A pack generated after evidence was tampered with must show that, and a document that cannot go stale cannot mislead.
Who may call it: any role. A workspace API key is refused here: this is an act that belongs to a named person.
GET
/
v1
/
packs
/
{key}
Pack
curl --request GET \
--url https://{deployment}/v1/packs/{key} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{deployment}/v1/packs/{key}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{deployment}/v1/packs/{key}', 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://{deployment}/v1/packs/{key}",
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://{deployment}/v1/packs/{key}"
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://{deployment}/v1/packs/{key}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployment}/v1/packs/{key}")
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{
"pack_version": 123,
"generated_at": "2023-11-07T05:31:56Z",
"workspace_id": "<string>",
"disclaimer": {},
"instrument": {
"key": "<string>",
"jurisdiction": "<string>",
"regulator": "<string>",
"instrument": "<string>",
"version": "<string>",
"status": "<string>",
"accepted_by_customer": true,
"clauses": 123,
"by_provenance": {},
"instrument_ref": "<string>",
"source_url": "<string>",
"accepted_by": "<string>",
"accepted_on": "2023-11-07T05:31:56Z",
"caveat": "<string>"
},
"score": {
"satisfied": 123,
"scored_clauses": 123,
"percent": 123,
"note": "<string>"
},
"sections": [
{}
],
"gaps": [
{
"clause": "<string>",
"title": "<string>",
"missing": [
"<string>"
],
"fixes": []
}
],
"regime": {
"code": "<string>",
"name": "<string>",
"resolved_from": "<string>",
"assessed_against": "<string>",
"applies": [],
"requires_second_approver_above_minor": 123,
"second_approver_currency": "<string>",
"forbids": {}
},
"seal": {
"seal_version": 123,
"algorithm": "<string>",
"content_hash": "<string>",
"signature": "<string>",
"public_key": "<string>",
"signing_key_ref": "<string>",
"ephemeral": true,
"custody": "<string>",
"custody_means": "<string>",
"how_to_verify": "<string>",
"warning": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Response
Successful Response
A regulator-facing pack for one instrument.
