Skip to main content
GET
Pack

Authorizations

Authorization
string
header
required

A token from the identity provider your deployment federates with. It identifies a person; their roles in the workspace decide what they may do.

Path Parameters

key
string
required

Query Parameters

sign
boolean
default:false

attach an Ed25519 signature

Response

Successful Response

A regulator-facing pack for one instrument.

pack_version
integer
required
generated_at
string<date-time>
required

ISO 8601. Passed through verbatim; the signature covers it.

workspace_id
string
required
disclaimer
Disclaimer · object
required
instrument
ClauseMapOut · object
required

One regulatory instrument we claim to map, and how far we stand behind it.

score
PackScoreOut · object
required

How much of the instrument is evidenced.

sections
Sections · object[]
required
gaps
PackGapOut · object[]
required
regime
RegimeDisclosureOut · object | null

Which law an artefact was produced under, and what it required.

seal
DocumentSealOut · object | null

The seal, as it goes over the wire.