API reference
Generated from the live API's own OpenAPI schema -- every route
below is a route that actually exists, not hand-maintained documentation
that can drift.
GET /.well-known/actaseal-keys.json
Well Known Keys
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /.well-known/security.txt
Well Known Security Txt
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /accounts
List Breach Budget Accounts
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /accounts/{account_id}/balance
Get Breach Budget Account Balance
Parameters
| Name | In | Required |
|---|
| account_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /admin/agents
List Agents Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /admin/agents/declare
Declare Agent Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /admin/agents/export.csv
Export Agents Csv
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /admin/agents/export.json
Export Agents Json
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /admin/agents/reconciliation
Agents Reconciliation Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /admin/agents/{agent_id}
Get Agent Route
Parameters
| Name | In | Required |
|---|
| agent_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /admin/apikeys
List Api Keys
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /admin/apikeys
Mint Api Key Route
Responses
| Status | Description |
|---|
| 201 | Successful Response |
| 422 | Validation Error |
DELETE /admin/apikeys/{key_id}
Revoke Api Key Route
Parameters
| Name | In | Required |
|---|
| key_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /admin/apikeys/{key_id}/rotate
Rotate Api Key Route
Parameters
| Name | In | Required |
|---|
| key_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /admin/workos/group-role-map
Get Workos Group Role Map
Responses
| Status | Description |
|---|
| 200 | Successful Response |
PUT /admin/workos/group-role-map
Edit Workos Group Role Map Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /approvals
Pending Approvals
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /approvals/bulk-decision
Approvals Bulk Decision
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /approvals/export.csv
Approvals Export Csv
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /approvals/export.json
Approvals Export Json
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /approvals/pending
Approvals Pending
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /approvals/{request_id}
Approval Detail
Parameters
| Name | In | Required |
|---|
| request_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /approvals/{request_id}/challenge
Approvals Challenge
Parameters
| Name | In | Required |
|---|
| request_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /approvals/{request_id}/claim
Claim Approval Route
Parameters
| Name | In | Required |
|---|
| request_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /approvals/{request_id}/decision
Approvals Decision
Parameters
| Name | In | Required |
|---|
| request_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /approvals/{request_id}/release
Release Approval Claim Route
Parameters
| Name | In | Required |
|---|
| request_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /approvals/{request_id}/resolve
Resolve Approval
Parameters
| Name | In | Required |
|---|
| request_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /archive/engagements
Archive List Engagements
Parameters
| Name | In | Required |
|---|
| offset | query | no |
| limit | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /archive/engagements
Archive Create Engagement
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /archive/engagements/{engagement_id}
Archive Get Engagement
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /archive/engagements/{engagement_id}/attestation
Archive Issue Attestation
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /archive/engagements/{engagement_id}/control-export.zip
Archive Control Export
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /archive/engagements/{engagement_id}/inspection-pack
Archive Inspection Pack Export
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /archive/engagements/{engagement_id}/legal-hold
Archive Place Legal Hold
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
DELETE /archive/engagements/{engagement_id}/legal-hold
Archive Release Legal Hold
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /archive/engagements/{engagement_id}/lock
Archive Lock Status
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /archive/engagements/{engagement_id}/preservation-precedence-report
Archive Preservation Precedence Report
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
| matter_id | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /archive/engagements/{engagement_id}/report-release-date
Archive Set Report Release Date
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /archive/engagements/{engagement_id}/requests
Archive List Request Items
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /archive/engagements/{engagement_id}/requests
Archive Open Request Item
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /archive/engagements/{engagement_id}/requests/{item_id}/fulfill
Archive Fulfill Request Item
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
| item_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /archive/engagements/{engagement_id}/retention
Archive Retention Status
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /archive/engagements/{engagement_id}/workpapers
Archive List Workpapers
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
| offset | query | no |
| limit | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /archive/engagements/{engagement_id}/workpapers
Archive Attach Workpaper
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /archive/engagements/{engagement_id}/workpapers/bulk-ingest
Archive Bulk Ingest Workpapers
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /archive/engagements/{engagement_id}/workpapers/{workpaper_id}/post-archive-addition
Archive Post Addition
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
| workpaper_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /archive/requests
Archive List All Request Items
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /assessment/active-profile
Assessment Set Active Profile Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /assessment/manifest-candidates
Assessment Manifest Candidates Route
Parameters
| Name | In | Required |
|---|
| root | query | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /assessment/manifest-uploads
Assessment Manifest Upload List Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /assessment/manifest-uploads
Assessment Manifest Upload Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /assessment/manifest-uploads/{upload_id}
Assessment Manifest Upload Get Route
Parameters
| Name | In | Required |
|---|
| upload_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
DELETE /assessment/manifest-uploads/{upload_id}
Assessment Manifest Upload Delete Route
Parameters
| Name | In | Required |
|---|
| upload_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /assessment/manifest-uploads/{upload_id}/raw
Assessment Manifest Upload Raw Route
Parameters
| Name | In | Required |
|---|
| upload_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /assessment/profiles
Assessment List Profiles Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /assessment/scan
Assessment Scan Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /auditor/controls
Auditor Controls
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /auditor/engagement
Auditor Engagement
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /auditor/engagements
Auditor Create Engagement
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /auditor/engagements/{engagement_id}/revoke
Auditor Revoke Engagement
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /auditor/evidence-package/{receipt_id}.zip
Auditor Evidence Package
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /auditor/evidence/{receipt_id}/review
Auditor Review Evidence
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /auditor/preview
Auditor Preview
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /auth/oidc/callback
Oidc Login Callback
Parameters
| Name | In | Required |
|---|
| code | query | yes |
| state | query | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /auth/oidc/login
Oidc Login Start
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /auth/workos/callback
Workos Login Callback
Parameters
| Name | In | Required |
|---|
| code | query | yes |
| state | query | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /auth/workos/login
Workos Login Start
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /badge/{engagement_id}/status.json
Badge Status
Parameters
| Name | In | Required |
|---|
| engagement_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /breaches
List Breaches
Parameters
| Name | In | Required |
|---|
| status | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /breaches/export.csv
Breaches Export Csv
Parameters
| Name | In | Required |
|---|
| status | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /breaches/export.json
Breaches Export Json
Parameters
| Name | In | Required |
|---|
| status | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /breaches/{case_id}
Breach Case Detail
Parameters
| Name | In | Required |
|---|
| case_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /breaches/{case_id}/acknowledge
Acknowledge Breach
Parameters
| Name | In | Required |
|---|
| case_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /breaches/{case_id}/binder.html
Breaches Binder
Parameters
| Name | In | Required |
|---|
| case_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /breaches/{case_id}/binder.pdf
Breaches Binder Pdf
Parameters
| Name | In | Required |
|---|
| case_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /breaches/{case_id}/resolve
Resolve Breach
Parameters
| Name | In | Required |
|---|
| case_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /console/integrity
Console Integrity
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /console/onboarding-checklist
Onboarding Checklist
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /console/summary
Console Summary
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /decisions
List Decisions
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /gateway/preflight
Gateway Preflight Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /healthz
Healthz
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /invite/{token}/accept
Accept Invite
Parameters
| Name | In | Required |
|---|
| token | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /ledger
Browse Ledger
Parameters
| Name | In | Required |
|---|
| offset | query | no |
| limit | query | no |
| date_from | query | no |
| date_to | query | no |
| event_type | query | no |
| action_type | query | no |
| actor_id | query | no |
| q | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /ledger/chain-badge
Ledger Chain Badge
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ledger/export.csv
Ledger Export Csv
Parameters
| Name | In | Required |
|---|
| date_from | query | no |
| date_to | query | no |
| event_type | query | no |
| action_type | query | no |
| actor_id | query | no |
| q | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /ledger/export.json
Ledger Export Json
Parameters
| Name | In | Required |
|---|
| date_from | query | no |
| date_to | query | no |
| event_type | query | no |
| action_type | query | no |
| actor_id | query | no |
| q | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /ledger/integrity
Ledger Integrity
Parameters
| Name | In | Required |
|---|
| deep | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /licence/status
Licence Status Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /metrics
Metrics Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /notifications
List Notifications
Parameters
| Name | In | Required |
|---|
| since | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /policy
Get Policy
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /policy/history
Policy History
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /policy/rollback
Rollback
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /policy/rules
Add Rule
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
PUT /policy/rules/{rule_id}
Edit Rule
Parameters
| Name | In | Required |
|---|
| rule_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
DELETE /policy/rules/{rule_id}
Delete Rule
Parameters
| Name | In | Required |
|---|
| rule_id | path | yes |
| actor_id | query | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /policy/rules/{rule_id}/enabled
Set Rule Enabled
Parameters
| Name | In | Required |
|---|
| rule_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /policy/templates
List Policy Templates
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /policy/templates/{name}/install
Install Policy Template
Parameters
| Name | In | Required |
|---|
| name | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /policy/versions
Policy Versions List
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /policy/versions
Policy Versions Propose
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /policy/versions/{version}
Policy Versions Detail
Parameters
| Name | In | Required |
|---|
| version | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /policy/versions/{version}/activate
Policy Versions Activate
Parameters
| Name | In | Required |
|---|
| version | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /policy/versions/{version}/discard
Policy Versions Discard
Parameters
| Name | In | Required |
|---|
| version | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /policy/versions/{version}/dry-run
Policy Versions Dry Run
Parameters
| Name | In | Required |
|---|
| version | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /quality/deficiencies
Quality Deficiencies Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /quality/internal-regulator-delta
Quality Internal Regulator Delta Route
Parameters
| Name | In | Required |
|---|
| engagement_id | query | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /quality/monitoring-report
Quality Monitoring Report Route
Parameters
| Name | In | Required |
|---|
| window_start | query | no |
| window_end | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /quality/overdue
Quality Overdue Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /quality/recurring-deficiencies
Quality Recurring Deficiencies Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /quality/route-coverage
Quality Route Coverage Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /readyz
Readyz
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /receipts
Receipts List
Parameters
| Name | In | Required |
|---|
| offset | query | no |
| limit | query | no |
| date_from | query | no |
| date_to | query | no |
| decision | query | no |
| q | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /receipts/export.csv
Receipts Export Csv
Parameters
| Name | In | Required |
|---|
| date_from | query | no |
| date_to | query | no |
| decision | query | no |
| q | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /receipts/export.json
Receipts Export Json
Parameters
| Name | In | Required |
|---|
| date_from | query | no |
| date_to | query | no |
| decision | query | no |
| q | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /receipts/verify
Receipts Verify
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /receipts/{receipt_id}
Receipts Detail
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /receipts/{receipt_id}/binder.html
Receipts Binder
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /receipts/{receipt_id}/certificate.pdf
Receipts Certificate Pdf
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /receipts/{receipt_id}/email-packet
Receipts Email Packet
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /receipts/{receipt_id}/evidence-pack.zip
Receipts Evidence Pack
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /receipts/{receipt_id}/explanation.html
Receipts Explanation Html
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /receipts/{receipt_id}/explanation.json
Receipts Explanation Json
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /receipts/{receipt_id}/export/acta-v01
Receipts Export Acta V01
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /receipts/{receipt_id}/fre902-certification-package
Receipts Fre902 Certification Package
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /receipts/{receipt_id}/verify
Receipts Verify Full
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /roles
List Roles
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /roles
Create Role Route
Responses
| Status | Description |
|---|
| 201 | Successful Response |
| 422 | Validation Error |
PUT /roles/{role_id}
Edit Role Route
Parameters
| Name | In | Required |
|---|
| role_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
DELETE /roles/{role_id}
Delete Role Route
Parameters
| Name | In | Required |
|---|
| role_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /search
Global Search
Parameters
| Name | In | Required |
|---|
| q | query | no |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /settings/keys/rotate
Rotate Signing Key
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /settings/status
Settings Status
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /setup/create-first-policy
Setup Create First Policy Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /setup/register-approver
Setup Register Approver Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /setup/status
Setup Status Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /setup/test-decision
Setup Run Test Decision Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /setup/test-decision/{action_id}/evidence-pack.zip
Setup Test Decision Packet Route
Parameters
| Name | In | Required |
|---|
| action_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /setup/verify-signing-key
Setup Verify Signing Key Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /static/badge.js
Badge Js
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /trust/archive-transparency-sth.json
Trust Archive Transparency Sth
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /trust/caiq-lite.csv
Trust Caiq Lite Csv
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /trust/caiq-lite.json
Trust Caiq Lite Json
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /trust/sig-lite.csv
Trust Sig Lite Csv
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /trust/sig-lite.json
Trust Sig Lite Json
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /trust/trust-center.json
Trust Center Bundle
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/accept-invite
Accept Invite Page
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/admin
Admin Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/agents
Agents Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/approvals
Approvals Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/approvals/{request_id}
Approval Permalink Ui
Parameters
| Name | In | Required |
|---|
| request_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /ui/breaches
Breaches Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /ui/change-password
Change Password
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /ui/engagements
Engagements Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/ledger
Ledger Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/licence
Licence Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/login
Login Page
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /ui/login
Login
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
POST /ui/logout
Logout
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/me
Me
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/playground
Playground Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/policies
Policies Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/quality
Quality Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/readiness
Readiness Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/receipts
Receipts Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/receipts/{receipt_id}
Receipt Permalink Ui
Parameters
| Name | In | Required |
|---|
| receipt_id | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /ui/requests
Requests Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/settings
Settings Ui
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /ui/{path}
Ui Not Found
Parameters
| Name | In | Required |
|---|
| path | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /users
List Users
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /users
Create User Route
Responses
| Status | Description |
|---|
| 201 | Successful Response |
| 422 | Validation Error |
PUT /users/{username}
Edit User Route
Parameters
| Name | In | Required |
|---|
| username | path | yes |
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |
GET /verify
Verify Sandbox Redirect
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /verify/
Verify Sandbox Page
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /verify/receipt_verify.js
Verify Sandbox Js
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /version
Version Route
Responses
| Status | Description |
|---|
| 200 | Successful Response |
GET /webauthn/register/options
Webauthn Register Options
Responses
| Status | Description |
|---|
| 200 | Successful Response |
POST /webauthn/register/verify
Webauthn Register Verify
Responses
| Status | Description |
|---|
| 200 | Successful Response |
| 422 | Validation Error |