Reference
Enums
Every enum value used by the Bedrock API. Sourced from packages/types/src/enums.ts.
These enums are versioned alongside the API. New values are additive only — they never get renamed or removed within a major version, and any new value will appear here before it can be returned by the API.
FirmPlan
| Value | Description |
|---|---|
LEDGER | Ledger only — record-keeping subscription |
PRINCIPAL | Principal only — review-as-a-service subscription |
BOTH | Full Bedrock platform |
LedgerEventType
| Value | Description |
|---|---|
DOCUMENT_SUBMITTED | A new piece of advice has been submitted for review. |
REVIEW_STARTED | A reviewer has opened the document and begun the review session. |
REVIEW_COMPLETED | A reviewer has submitted their decision (approve / modify / reject). |
DOCUMENT_APPROVED | The reviewer approved the document as drafted. |
DOCUMENT_MODIFIED | The reviewer approved with modifications. The modifications are recorded verbatim. |
DOCUMENT_REJECTED | The reviewer rejected the document. A rejection reason is recorded. |
CERTIFICATE_ISSUED | Deprecated. The worker no longer emits this event — a certificate is just a presentation envelope around an already-signed ledger record. To know when a certificate exists, subscribe to the underlying event type (e.g. DOCUMENT_APPROVED) and look up the certificate by `ledgerRecordId`. |
SLA_BREACHED | A review job has crossed its SLA deadline without a decision. |
IMPACT_ASSESSMENT_APPROVED | A Consumer Duty impact assessment for an AI use case has been approved and signed off by a senior (PRIN 2A · SYSC 7.1). |
INCIDENT_LOGGED | An operational or compliance incident has been recorded against the firm (FG21/1 · SYSC 15A). |
INCIDENT_RESOLVED | A previously-logged incident has been resolved or closed. |
FIRM_SETTINGS_UPDATED | A compliance-relevant firm setting (e.g. enforceImpactAssessments) was toggled. The snapshot carries the field-level diff and the authenticated actor. |
CertificateOutcome
| Value | Description |
|---|---|
APPROVED | Reviewer approved the document as drafted |
APPROVED_WITH_MODIFICATIONS | Reviewer approved with described changes |
REJECTED | Reviewer rejected the document |
DocumentType
| Value | Description |
|---|---|
SUITABILITY_REPORT | COBS 9.4 suitability report |
KYC_DOCUMENT | Know-your-customer evidence |
INVESTMENT_RECOMMENDATION | Specific investment recommendation |
FACT_FIND | Initial fact-find document |
RISK_ASSESSMENT | Customer risk profile |
OTHER | Anything else; see metadata |
ReviewStatus
| Value | Description |
|---|---|
QUEUED | Awaiting routing |
ASSIGNED | Routed to a reviewer, not yet opened |
IN_REVIEW | Reviewer has the document open |
APPROVED | Decision: approved |
MODIFIED | Decision: approved with modifications |
REJECTED | Decision: rejected |
ESCALATED | Reviewer escalated to a lead reviewer |
CANCELLED | Job cancelled before a decision was reached |
ReviewOutcome
| Value | Description |
|---|---|
APPROVED | Document approved as drafted |
APPROVED_WITH_MODIFICATIONS | Approved after the reviewer made changes (recorded verbatim) |
REJECTED | Document rejected and not delivered to the client |
ReviewPriority
| Value | Description |
|---|---|
STANDARD | Default SLA |
URGENT | Tighter SLA, escalates faster |
UserRole
| Value | Description |
|---|---|
FIRM_ADMIN | Manages users, keys, webhooks, compliance settings |
REVIEWER | Reviews documents in the Principal app |
LEAD_REVIEWER | Reviewer + reassignment + escalation + senior sign-off |
ReviewerQualification
| Value | Description |
|---|---|
CFA | Chartered Financial Analyst |
CFP | Certified Financial Planner |
DIP_PFS | Diploma in Regulated Financial Planning |
CISI | Chartered Institute for Securities & Investment |
IMC | Investment Management Certificate |
ReviewActionType
| Value | Description |
|---|---|
SESSION_STARTED | Reviewer opened the job in Principal |
DOCUMENT_OPENED | Reviewer opened the source document |
DOCUMENT_SCROLLED | Scroll event during document review |
DOCUMENT_READ_COMPLETE | Scroll + time thresholds met — full document read |
CHECKLIST_ITEM_CHECKED | Reviewer ticked a checklist item |
CHECKLIST_ITEM_UNCHECKED | Reviewer unticked a previously-ticked item |
NOTE_ADDED | Reviewer added an annotation / note |
MODIFICATION_DESCRIBED | Reviewer recorded a verbatim modification to the advice |
REJECTION_REASON_SELECTED | Reviewer selected a rejection reason |
DECISION_SUBMITTED | Reviewer submitted their final decision |
ChainInvalidReason
| Value | Description |
|---|---|
HASH_MISMATCH | A stored hash does not match the recomputed hash |
SIGNATURE_INVALID | The ECDSA P-256 signature does not verify |
SEQUENCE_GAP | A sequence number was skipped |
PREVIOUS_HASH_MISMATCH | previousHash does not match the previous entry |
VulnerabilityFlag
| Value | Description |
|---|---|
health | Physical or mental health conditions, illness, or disability |
life_event | Bereavement, divorce, job loss, retirement, or similar disruption |
capability | Low financial knowledge, language, or digital skills |
resilience | Low ability to withstand financial shocks |
ImpactAssessmentStatus
| Value | Description |
|---|---|
DRAFT | Author is preparing the assessment; freely editable |
PENDING_SIGNOFF | Submitted for senior review; still editable |
APPROVED | Senior has signed off; immutable from this point and anchored to the ledger |
REJECTED | Sent back to draft |
SUPERSEDED | Explicitly retired by a newer assessment for the same use case |
RiskRating
| Value | Description |
|---|---|
LOW | Routine controls and existing oversight are sufficient for this PRIN 2A outcome |
MEDIUM | Mitigations exist but warrant explicit governing-body review before approval |
HIGH | Material residual risk for this outcome — board attention required and detailed responses are highlighted in the report |
IncidentSeverity
| Value | Description |
|---|---|
LOW | Minor issue, no material regulatory exposure |
MEDIUM | Material issue, limited scope |
HIGH | Serious issue requiring prompt remediation |
CRITICAL | Severe issue requiring immediate action and senior attention |
IncidentCategory
| Value | Description |
|---|---|
MODEL_FAILURE | AI model produced a wrong, inconsistent, or unavailable output |
BAD_ADVICE | Unsuitable advice was generated or nearly released to a client |
DATA_ISSUE | Data inconsistency, validation gap, or integration error |
SLA_BREACH | One or more reviews breached the firm’s SLA |
SECURITY | Security event (auth, access, dependency vulnerability, probe) |
OTHER | Anything else; see metadata for context |
IncidentStatus
| Value | Description |
|---|---|
OPEN | Reported but not yet picked up |
INVESTIGATING | Actively being investigated |
REMEDIATING | Root cause known, remediation in progress |
RESOLVED | Remediated; awaiting closure |
CLOSED | Fully closed and archived |
RemediationStatus
| Value | Description |
|---|---|
PENDING | Assigned but not yet started |
IN_PROGRESS | Active work ongoing |
COMPLETED | Done |
CANCELLED | No longer required |
ReportType
| Value | Description |
|---|---|
CONSUMER_DUTY_OUTCOME | Consumer Duty outcome report (PRIN 2A.8.3R) |