All API endpoints

Every route the platform exposes, grouped by controller, with the exact permission required. Generated at build time from the NestJS controllers — this page is the source of truth for what is public and what is not.

380

Endpoints

72

Controllers

17

Public

2

Client session

361

Restricted

Generated 13 Jul 2026, 06:00 UTC

Showing 380 / 380

AgentKyc6 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/agents/:id/kyc/documents	documents	🔒 Restricted	AgentKycRead (any)AgentKycReadOwn (any)	Schema →
POST	/api/v1/agents/:id/kyc/documents/:docId/review	review	🔒 Restricted	AgentKycReview	Schema →
POST	/api/v1/agents/:id/kyc/reject	reject	🔒 Restricted	AgentKycReject	Schema →
GET	/api/v1/agents/:id/kyc/requirements	requirements	🔒 Restricted	AgentKycRequirementsRead	Schema →
POST	/api/v1/agents/:id/kyc/submit	submit	🔒 Restricted	AgentKycSubmit	Schema →
POST	/api/v1/agents/:id/kyc/verify	verify	🔒 Restricted	AgentKycVerify	Schema →

AgentLicenses5 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/agents/:agentId/licences	list	🔒 Restricted	AgentLicenseRead	Schema →
POST	/api/v1/agents/:agentId/licences	create	🔒 Restricted	AgentLicenseWrite	Schema →
GET	/api/v1/agents/:agentId/licences/:id	find	🔒 Restricted	AgentLicenseRead	Schema →
PATCH	/api/v1/agents/:agentId/licences/:id	update	🔒 Restricted	AgentLicenseWrite	Schema →
DELETE	/api/v1/agents/:agentId/licences/:id	delete	🔒 Restricted	AgentLicenseWrite	Schema →

Agents17 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/agents	list	🔒 Restricted	AgentRead (any)AgentReadOwn (any)	Schema →
POST	/api/v1/agents	create	🔒 Restricted	AgentWrite	Schema →
GET	/api/v1/agents/:id	find	🔒 Restricted	AgentRead (any)AgentReadOwn (any)	Schema →
PATCH	/api/v1/agents/:id	update	🔒 Restricted	AgentWrite	Schema →
POST	/api/v1/agents/:id/approve	approve	🔒 Restricted	AgentApprove	Schema →
POST	/api/v1/agents/:id/blacklist	blacklist	🔒 Restricted	AgentBlacklist	Schema →
GET	/api/v1/agents/:id/commissions	commissions	🔒 Restricted	CommissionRead	Schema →
GET	/api/v1/agents/:id/internal-referrals	internalReferrals	🔒 Restricted	ReferralRead (any)ReferralReadOwn (any)	Schema →
GET	/api/v1/agents/:id/introducers	introducers	🔒 Restricted	AgentRead (any)AgentReadOwn (any)	Schema →
GET	/api/v1/agents/:id/payouts	payouts	🔒 Restricted	PaymentRead	Schema →
GET	/api/v1/agents/:id/referrals	referrals	🔒 Restricted	ReferralRead	Schema →
POST	/api/v1/agents/:id/reject	reject	🔒 Restricted	AgentReject	Schema →
GET	/api/v1/agents/:id/statement	statement	🔒 Restricted	AgentStatement	Schema →
GET	/api/v1/agents/:id/statement.pdf	statementPdf	🔒 Restricted	AgentStatement	Schema →
POST	/api/v1/agents/:id/suspend	suspend	🔒 Restricted	AgentSuspend	Schema →
POST	/api/v1/agents/bulk-import	bulkImport	🔒 Restricted	AgentWrite	Schema →
POST	/api/v1/agents/self-register	selfRegister	🌐 Public	—	Schema →

AgentSubscriptions5 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/agent-subscriptions	list	🔒 Restricted	AgentSubscriptionRead	Schema →
POST	/api/v1/agent-subscriptions	create	🔒 Restricted	AgentSubscriptionWrite	Schema →
GET	/api/v1/agent-subscriptions/:id	find	🔒 Restricted	AgentSubscriptionRead	Schema →
POST	/api/v1/agent-subscriptions/:id/cancel	cancel	🔒 Restricted	AgentSubscriptionCancel	Schema →
POST	/api/v1/agent-subscriptions/:id/renew	renew	🔒 Restricted	AgentSubscriptionRenew	Schema →

ApiKeys3 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/api-keys	list	🔒 Restricted	ApiKeyRead	Schema →
POST	/api/v1/api-keys	create	🔒 Restricted	ApiKeyWrite	Schema →
DELETE	/api/v1/api-keys/:id	revoke	🔒 Restricted	ApiKeyWrite	Schema →

AuditRead4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/audit-events	events	🔒 Restricted	AuditRead	Schema →
GET	/api/v1/audit-events/:id	event	🔒 Restricted	AuditRead	Schema →
GET	/api/v1/audit-events/verify	verifyChain	🔒 Restricted	AuditRead	Schema →
GET	/api/v1/security-events	securityEvents	🔒 Restricted	SecurityEventRead	Schema →

Auth13 endpoints

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/auth/change-password	change	🔒 Restricted	SelfPasswordChange	Schema →
POST	/api/v1/auth/forgot-password	forgot	🌐 Public	—	Schema →
POST	/api/v1/auth/login	login	🌐 Public	—	Schema →
POST	/api/v1/auth/logout	logout	🔒 Restricted	SelfSessionManage	Schema →
POST	/api/v1/auth/logout-all	logoutAll	🔒 Restricted	SelfSessionManage	Schema →
GET	/api/v1/auth/me	me	🔒 Restricted	SelfProfileRead	Schema →
POST	/api/v1/auth/mfa/disable	mfaDisable	🔒 Restricted	SelfMfaManage	Schema →
POST	/api/v1/auth/mfa/setup	mfaSetup	🔒 Restricted	SelfMfaManage	Schema →
POST	/api/v1/auth/mfa/verify	mfaVerify	🔒 Restricted	SelfMfaManage	Schema →
POST	/api/v1/auth/refresh	refresh	🌐 Public	—	Schema →
POST	/api/v1/auth/reset-password	reset	🌐 Public	—	Schema →
GET	/api/v1/auth/sessions	listSessions	🔒 Restricted	SelfSessionManage	Schema →
DELETE	/api/v1/auth/sessions/:familyId	revokeSession	🔒 Restricted	SelfSessionManage	Schema →

Bordereau8 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/bordereau	list	🔒 Restricted	BordereauRead	Schema →
POST	/api/v1/bordereau	generate	🔒 Restricted	BordereauGenerate	Schema →
GET	/api/v1/bordereau/:id	find	🔒 Restricted	BordereauRead	Schema →
POST	/api/v1/bordereau/:id/dispute	dispute	🔒 Restricted	BordereauDispute	Schema →
GET	/api/v1/bordereau/:id/export.pdf	exportPdf	🔒 Restricted	BordereauExport	Schema →
GET	/api/v1/bordereau/:id/export.xlsx	exportXlsx	🔒 Restricted	BordereauExport	Schema →
POST	/api/v1/bordereau/:id/reconcile	reconcile	🔒 Restricted	BordereauReconcile	Schema →
POST	/api/v1/bordereau/:id/share	share	🔒 Restricted	BordereauShare	Schema →

Claims15 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/claims	list	🔒 Restricted	ClaimReadOwn (any)ClaimRead (any)	Schema →
POST	/api/v1/claims	file	🔒 Restricted	ClaimFile	Schema →
GET	/api/v1/claims/:id	find	🔒 Restricted	ClaimReadOwn (any)ClaimRead (any)	Schema →
POST	/api/v1/claims/:id/appeal	appeal	🔒 Restricted	ClaimAppeal	Schema →
POST	/api/v1/claims/:id/assign	assign	🔒 Restricted	ClaimAssign	Schema →
POST	/api/v1/claims/:id/close	close	🔒 Restricted	ClaimSettle	Schema →
POST	/api/v1/claims/:id/documents	addDocument	🔒 Restricted	ClaimDocumentWrite	Schema →
POST	/api/v1/claims/:id/investigate	investigate	🔒 Restricted	ClaimInvestigate	Schema →
POST	/api/v1/claims/:id/notes	addNote	🔒 Restricted	ClaimNoteWrite	Schema →
POST	/api/v1/claims/:id/payments	recordPayment	🔒 Restricted	ClaimSettle	Schema →
POST	/api/v1/claims/:id/repudiate	repudiate	🔒 Restricted	ClaimRepudiate	Schema →
POST	/api/v1/claims/:id/request-documents	requestDocs	🔒 Restricted	ClaimInvestigate	Schema →
POST	/api/v1/claims/:id/review	review	🔒 Restricted	ClaimInvestigate	Schema →
POST	/api/v1/claims/:id/settle	settle	🔒 Restricted	ClaimSettle	Schema →
POST	/api/v1/claims/:id/withdraw	withdraw	🔒 Restricted	ClaimWithdraw	Schema →

Clients6 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/clients	list	🔒 Restricted	ClientRead	Schema →
POST	/api/v1/clients	create	🔒 Restricted	ClientWrite	Schema →
GET	/api/v1/clients/:id	find	🔒 Restricted	ClientReadOwn (any)ClientRead (any)	Schema →
PATCH	/api/v1/clients/:id	update	🔒 Restricted	ClientWrite	Schema →
GET	/api/v1/clients/:id/timeline	timeline	🔒 Restricted	ClientReadOwn (any)ClientRead (any)	Schema →
POST	/api/v1/clients/merge	merge	🔒 Restricted	ClientMerge	Schema →

CommissionRules7 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/commission-rules	list	🔒 Restricted	CommissionRuleRead	Schema →
POST	/api/v1/commission-rules	create	🔒 Restricted	CommissionRuleWrite	Schema →
GET	/api/v1/commission-rules/:id	find	🔒 Restricted	CommissionRuleRead	Schema →
PATCH	/api/v1/commission-rules/:id	update	🔒 Restricted	CommissionRuleWrite	Schema →
POST	/api/v1/commission-rules/:id/activate	activate	🔒 Restricted	CommissionRuleActivate	Schema →
POST	/api/v1/commission-rules/:id/deactivate	deactivate	🔒 Restricted	CommissionRuleActivate	Schema →
POST	/api/v1/commission-rules/simulate	simulate	🔒 Restricted	CommissionRuleSimulate	Schema →

Commissions9 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/commissions	list	🔒 Restricted	CommissionRead	Schema →
GET	/api/v1/commissions/:id	find	🔒 Restricted	CommissionRead	Schema →
POST	/api/v1/commissions/:id/adjust	adjust	🔒 Restricted	CommissionAdjust	Schema →
POST	/api/v1/commissions/:id/approve	approve	🔒 Restricted	CommissionApprove	Schema →
GET	/api/v1/commissions/:id/audit	audit	🔒 Restricted	CommissionAuditRead	Schema →
GET	/api/v1/commissions/:id/deductions	deductions	🔒 Restricted	CommissionDeductionRead	Schema →
POST	/api/v1/commissions/:id/dispute	dispute	🔒 Restricted	CommissionDispute	Schema →
POST	/api/v1/commissions/:id/recalculate	recalculate	🔒 Restricted	CommissionRecalculate	Schema →
POST	/api/v1/commissions/:id/reverse	reverse	🔒 Restricted	CommissionReverse	Schema →

Communications5 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/communications/agents/:id	agentTimeline	🔒 Restricted	CommunicationsRead	Schema →
GET	/api/v1/communications/claims/:id	claimTimeline	🔒 Restricted	CommunicationsRead	Schema →
GET	/api/v1/communications/clients/:id	clientTimeline	🔒 Restricted	CommunicationsRead	Schema →
GET	/api/v1/communications/policies/:id	policyTimeline	🔒 Restricted	CommunicationsRead	Schema →
GET	/api/v1/communications/referrals/:id	referralTimeline	🔒 Restricted	CommunicationsRead	Schema →

Compliance2 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/compliance/cases	cases	🔒 Restricted	ComplianceCasesRead	Schema →
GET	/api/v1/compliance/referrals/:id	referral	🔒 Restricted	ComplianceRead	Schema →

ContentAssets6 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/content	list	🔒 Restricted	ContentAssetRead	Schema →
POST	/api/v1/content	create	🔒 Restricted	ContentAssetWrite	Schema →
GET	/api/v1/content/:id	find	🔒 Restricted	ContentAssetRead	Schema →
PATCH	/api/v1/content/:id	update	🔒 Restricted	ContentAssetWrite	Schema →
POST	/api/v1/content/:id/archive	archive	🔒 Restricted	ContentAssetArchive	Schema →
POST	/api/v1/content/:id/publish	publish	🔒 Restricted	ContentAssetPublish	Schema →

DeductionTypes5 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/deduction-types	list	🔒 Restricted	DeductionTypeRead	Schema →
POST	/api/v1/deduction-types	create	🔒 Restricted	DeductionTypeWrite	Schema →
GET	/api/v1/deduction-types/:id	find	🔒 Restricted	DeductionTypeRead	Schema →
PATCH	/api/v1/deduction-types/:id	update	🔒 Restricted	DeductionTypeWrite	Schema →
POST	/api/v1/deduction-types/preview	preview	🔒 Restricted	DeductionPreview	Schema →

Disputes9 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/disputes	list	🔒 Restricted	DisputeReadOwn (any)DisputeRead (any)	Schema →
POST	/api/v1/disputes	raise	🔒 Restricted	DisputeRaise	Schema →
GET	/api/v1/disputes/:id	find	🔒 Restricted	DisputeReadOwn (any)DisputeRead (any)	Schema →
POST	/api/v1/disputes/:id/close	close	🔒 Restricted	DisputeResolve	Schema →
POST	/api/v1/disputes/:id/escalate	escalate	🔒 Restricted	DisputeEscalate	Schema →
POST	/api/v1/disputes/:id/notes	addNote	🔒 Restricted	DisputeNoteWrite	Schema →
POST	/api/v1/disputes/:id/resolve	resolve	🔒 Restricted	DisputeResolve	Schema →
POST	/api/v1/disputes/:id/triage	triage	🔒 Restricted	DisputeTriage	Schema →
POST	/api/v1/disputes/:id/withdraw	withdraw	🔒 Restricted	DisputeWithdraw	Schema →

Documents6 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/documents/:id	find	🔒 Restricted	DocumentRead	Schema →
PATCH	/api/v1/documents/:id	update	🔒 Restricted	DocumentWrite	Schema →
DELETE	/api/v1/documents/:id	delete	🔒 Restricted	DocumentDelete	Schema →
GET	/api/v1/documents/:id/download	download	🔒 Restricted	DocumentRead	Schema →
GET	/api/v1/documents/:id/signed-url	signedUrl	🔒 Restricted	DocumentRead	Schema →
POST	/api/v1/documents/upload	upload	🔒 Restricted	DocumentWrite	Schema →

Dsar2 endpoints

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/compliance/dsar/erase/:userId	erase	🔒 Restricted	DsarErase	Schema →
GET	/api/v1/compliance/dsar/export/:userId	export	🔒 Restricted	DsarExport	Schema →

Fraud7 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/fraud/alerts	listAlerts	🔒 Restricted	FraudAlertRead	Schema →
POST	/api/v1/fraud/alerts/:id/resolve	resolve	🔒 Restricted	FraudAlertResolve	Schema →
POST	/api/v1/fraud/alerts/:id/triage	triage	🔒 Restricted	FraudAlertTriage	Schema →
GET	/api/v1/fraud/rules	listRules	🔒 Restricted	FraudRuleRead	Schema →
POST	/api/v1/fraud/rules	createRule	🔒 Restricted	FraudRuleWrite	Schema →
PATCH	/api/v1/fraud/rules/:id	updateRule	🔒 Restricted	FraudRuleWrite	Schema →
POST	/api/v1/fraud/scan	scan	🔒 Restricted	FraudScan	Schema →

FxRates2 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/fx-rates	list	🔒 Restricted	FxRateRead	Schema →
POST	/api/v1/fx-rates	upsert	🔒 Restricted	FxRateWrite	Schema →

Health3 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/health	health	🌐 Public	—	Schema →
GET	/api/v1/health/live	live	🌐 Public	—	Schema →
GET	/api/v1/health/ready	ready	🌐 Public	—	Schema →

IdPatterns4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/id-patterns	list	🔒 Restricted	IdPatternRead	Schema →
POST	/api/v1/id-patterns	create	🔒 Restricted	IdPatternWrite	Schema →
GET	/api/v1/id-patterns/:id	find	🔒 Restricted	IdPatternRead	Schema →
PATCH	/api/v1/id-patterns/:id	update	🔒 Restricted	IdPatternWrite	Schema →

InsurerContacts4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/insurers/:insurerId/contacts	list	🔒 Restricted	InsurerContactRead	Schema →
POST	/api/v1/insurers/:insurerId/contacts	create	🔒 Restricted	InsurerContactWrite	Schema →
PATCH	/api/v1/insurers/:insurerId/contacts/:id	update	🔒 Restricted	InsurerContactWrite	Schema →
DELETE	/api/v1/insurers/:insurerId/contacts/:id	delete	🔒 Restricted	InsurerContactWrite	Schema →

InsurerInboundWebhook1 endpoint

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/webhooks/insurers/:insurerCode	ingest	🌐 Public	—	Schema →

InsurerIntegrationSettings3 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/insurers/:insurerId/integration-settings	list	🔒 Restricted	InsurerIntegrationRead	Schema →
POST	/api/v1/insurers/:insurerId/integration-settings	upsert	🔒 Restricted	InsurerIntegrationWrite	Schema →
DELETE	/api/v1/insurers/:insurerId/integration-settings/:key	delete	🔒 Restricted	InsurerIntegrationWrite	Schema →

InsurerProducts10 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/insurer-products	list	🔒 Restricted	ProductRead	Schema →
POST	/api/v1/insurer-products	create	🔒 Restricted	ProductWrite	Schema →
GET	/api/v1/insurer-products/:id	find	🔒 Restricted	ProductRead	Schema →
PATCH	/api/v1/insurer-products/:id	update	🔒 Restricted	ProductWrite	Schema →
POST	/api/v1/insurer-products/:id/activate	activate	🔒 Restricted	ProductActivate	Schema →
GET	/api/v1/insurer-products/:id/commission-rules	commissionRules	🔒 Restricted	CommissionRuleRead	Schema →
POST	/api/v1/insurer-products/:id/deactivate	deactivate	🔒 Restricted	ProductActivate	Schema →
GET	/api/v1/insurer-products/:id/plans	plans	🔒 Restricted	ProductPlanRead	Schema →
GET	/api/v1/insurer-products/:id/required-documents	requiredDocs	🔒 Restricted	ProductRead	Schema →
POST	/api/v1/insurer-products/bulk-import	bulkImport	🔒 Restricted	ProductWrite	Schema →

Insurers9 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/insurers	list	🔒 Restricted	InsurerRead (any)InsurerReadOwn (any)	Schema →
POST	/api/v1/insurers	create	🔒 Restricted	InsurerWrite	Schema →
GET	/api/v1/insurers/:id	find	🔒 Restricted	InsurerRead (any)InsurerReadOwn (any)	Schema →
PATCH	/api/v1/insurers/:id	update	🔒 Restricted	InsurerWrite	Schema →
POST	/api/v1/insurers/:id/activate	activate	🔒 Restricted	InsurerActivate	Schema →
GET	/api/v1/insurers/:id/performance	performance	🔒 Restricted	InsurerPerformanceRead	Schema →
GET	/api/v1/insurers/:id/products	products	🔒 Restricted	ProductRead	Schema →
GET	/api/v1/insurers/:id/referrals	referrals	🔒 Restricted	ReferralRead	Schema →
POST	/api/v1/insurers/:id/suspend	suspend	🔒 Restricted	InsurerSuspend	Schema →

InsurerWebhooks3 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/insurer-webhooks	list	🔒 Restricted	InsurerWebhookRead	Schema →
GET	/api/v1/insurer-webhooks/:id	find	🔒 Restricted	InsurerWebhookRead	Schema →
POST	/api/v1/insurer-webhooks/:id/replay	replay	🔒 Restricted	InsurerWebhookReplay	Schema →

InvestmentProducts4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/investment-products	list	🔒 Restricted	InvestmentProductRead	Schema →
POST	/api/v1/investment-products	create	🔒 Restricted	InvestmentProductWrite	Schema →
GET	/api/v1/investment-products/:id	find	🔒 Restricted	InvestmentProductRead	Schema →
PATCH	/api/v1/investment-products/:id	update	🔒 Restricted	InvestmentProductWrite	Schema →

Investments5 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/investments	list	🔒 Restricted	InvestmentReadOwn (any)InvestmentRead (any)	Schema →
POST	/api/v1/investments	open	🔒 Restricted	InvestmentCreate	Schema →
GET	/api/v1/investments/:id	find	🔒 Restricted	InvestmentReadOwn (any)InvestmentRead (any)	Schema →
POST	/api/v1/investments/:id/redeem	redeem	🔒 Restricted	InvestmentRedeem	Schema →
POST	/api/v1/investments/accrual/run	accrue	🔒 Restricted	InvestmentAdmin	Schema →

Invoices7 endpoints

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/billing/dunning/run	dunning	🔒 Restricted	InvoiceIssue	Schema →
GET	/api/v1/billing/invoices	list	🔒 Restricted	InvoiceReadOwn (any)InvoiceRead (any)	Schema →
POST	/api/v1/billing/invoices	issue	🔒 Restricted	InvoiceIssue	Schema →
GET	/api/v1/billing/invoices/:id	find	🔒 Restricted	InvoiceReadOwn (any)InvoiceRead (any)	Schema →
POST	/api/v1/billing/invoices/:id/cancel	cancel	🔒 Restricted	InvoiceCancel	Schema →
POST	/api/v1/billing/invoices/:id/payments	recordPayment	🔒 Restricted	InvoiceRecordPayment	Schema →
POST	/api/v1/billing/invoices/:id/write-off	writeOff	🔒 Restricted	InvoiceWriteOff	Schema →

IraRegistry3 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/ira-registry	list	🔒 Restricted	IraRegistryRead	Schema →
GET	/api/v1/ira-registry/:iraNumber	find	🔒 Restricted	IraRegistryRead	Schema →
GET	/api/v1/ira-registry/summary/by-company	summary	🔒 Restricted	IraRegistryRead	Schema →

Leads6 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/leads	list	🔒 Restricted	LeadReadOwn (any)LeadRead (any)	Schema →
GET	/api/v1/leads/:id	find	🔒 Restricted	LeadReadOwn (any)LeadRead (any)	Schema →
POST	/api/v1/leads/:id/assign	assign	🔒 Restricted	LeadAssign	Schema →
POST	/api/v1/leads/:id/contacted	contacted	🔒 Restricted	LeadConvert	Schema →
POST	/api/v1/leads/:id/convert	convert	🔒 Restricted	LeadConvert	Schema →
POST	/api/v1/leads/:id/dismiss	dismiss	🔒 Restricted	LeadDismiss	Schema →

NotificationPreferences2 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/notification-preferences/me	mine	🔒 Restricted	NotificationPreferencesRead	Schema →
POST	/api/v1/notification-preferences/me	update	🔒 Restricted	NotificationPreferencesWrite	Schema →

Notifications4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/notifications	list	🔒 Restricted	NotificationRead	Schema →
GET	/api/v1/notifications/:id	find	🔒 Restricted	NotificationRead	Schema →
POST	/api/v1/notifications/:id/read	read	🔒 Restricted	NotificationRead	Schema →
POST	/api/v1/notifications/read-all	readAll	🔒 Restricted	NotificationRead	Schema →

NotificationTemplates3 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/notification-templates	list	🔒 Restricted	NotificationTemplateRead	Schema →
POST	/api/v1/notification-templates	create	🔒 Restricted	NotificationTemplateWrite	Schema →
PATCH	/api/v1/notification-templates/:id	update	🔒 Restricted	NotificationTemplateWrite	Schema →

OperationalPolicies4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/operational-policies	list	🔒 Restricted	OperationalPolicyRead	Schema →
POST	/api/v1/operational-policies	create	🔒 Restricted	OperationalPolicyWrite	Schema →
GET	/api/v1/operational-policies/:id	find	🔒 Restricted	OperationalPolicyRead	Schema →
PATCH	/api/v1/operational-policies/:id	update	🔒 Restricted	OperationalPolicyWrite	Schema →

Organizations6 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/organizations	list	🔒 Restricted	OrganizationRead	Schema →
POST	/api/v1/organizations	create	🔒 Restricted	OrganizationWrite	Schema →
GET	/api/v1/organizations/:id	find	🔒 Restricted	OrganizationRead	Schema →
PATCH	/api/v1/organizations/:id	update	🔒 Restricted	OrganizationWrite	Schema →
POST	/api/v1/organizations/:id/reinstate	reinstate	🔒 Restricted	OrganizationSuspend	Schema →
POST	/api/v1/organizations/:id/suspend	suspend	🔒 Restricted	OrganizationSuspend	Schema →

Passkeys4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/passkeys	list	🔒 Restricted	SelfPasskeyManage	Schema →
DELETE	/api/v1/passkeys/:id	remove	🔒 Restricted	SelfPasskeyManage	Schema →
POST	/api/v1/passkeys/registration/options	registrationOptions	🔒 Restricted	SelfPasskeyManage	Schema →
POST	/api/v1/passkeys/registration/verify	verifyRegistration	🔒 Restricted	SelfPasskeyManage	Schema →

PaymentBatches6 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/payment-batches	list	🔒 Restricted	PaymentBatchRead	Schema →
POST	/api/v1/payment-batches	create	🔒 Restricted	PaymentBatchWrite	Schema →
GET	/api/v1/payment-batches/:id	find	🔒 Restricted	PaymentBatchRead	Schema →
POST	/api/v1/payment-batches/:id/approve	approve	🔒 Restricted	PaymentBatchApprove	Schema →
POST	/api/v1/payment-batches/:id/cancel	cancel	🔒 Restricted	PaymentBatchCancel	Schema →
POST	/api/v1/payment-batches/:id/submit	submit	🔒 Restricted	PaymentBatchSubmit	Schema →

Payments5 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/payments	list	🔒 Restricted	PaymentRead	Schema →
GET	/api/v1/payments/:id	find	🔒 Restricted	PaymentRead	Schema →
POST	/api/v1/payments/:id/reconcile	reconcile	🔒 Restricted	PaymentReconcile	Schema →
POST	/api/v1/payments/:id/retry	retry	🔒 Restricted	PaymentRetry	Schema →
POST	/api/v1/payments/reconcile/import	importReconciliation	🔒 Restricted	PaymentReconcile	Schema →

PaymentWebhook1 endpoint

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/payment-webhooks/:provider	ingest	🌐 Public	—	Schema →

PayoutAccounts5 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/payout-accounts	list	🔒 Restricted	PayoutAccountRead	Schema →
POST	/api/v1/payout-accounts	create	🔒 Restricted	PayoutAccountWrite	Schema →
GET	/api/v1/payout-accounts/:id	find	🔒 Restricted	PayoutAccountRead	Schema →
PATCH	/api/v1/payout-accounts/:id	update	🔒 Restricted	PayoutAccountWrite	Schema →
POST	/api/v1/payout-accounts/:id/verify	verify	🔒 Restricted	PayoutAccountVerify	Schema →

Policies7 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/policies	list	🔒 Restricted	PolicyReadOwn (any)PolicyRead (any)	Schema →
GET	/api/v1/policies/:id	find	🔒 Restricted	PolicyReadOwn (any)PolicyRead (any)	Schema →
POST	/api/v1/policies/:id/cancel	cancel	🔒 Restricted	PolicyCancel	Schema →
POST	/api/v1/policies/:id/endorsements	createEndorsement	🔒 Restricted	PolicyEndorse	Schema →
POST	/api/v1/policies/:id/endorsements/:endorsementId/approve	approveEndorsement	🔒 Restricted	PolicyEndorseApprove	Schema →
POST	/api/v1/policies/:id/reinstate	reinstate	🔒 Restricted	PolicyReinstate	Schema →
GET	/api/v1/policies/:id/timeline	timeline	🔒 Restricted	PolicyReadOwn (any)PolicyRead (any)	Schema →

PortalAdmin1 endpoint

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/admin/client-portal/sessions/:sessionId/revoke	revoke	🔒 Restricted	ClientPortalSessionRevoke	Schema →

Portal4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/client-portal/me/claims	myClaims	🎟️ Client session	ClientPortalSession	Schema →
GET	/api/v1/client-portal/me/policies	myPolicies	🎟️ Client session	ClientPortalSession	Schema →
POST	/api/v1/client-portal/otp/request	requestOtp	🌐 Public	—	Schema →
POST	/api/v1/client-portal/otp/verify	verifyOtp	🌐 Public	—	Schema →

ProductCategories5 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/product-categories	list	🔒 Restricted	ProductCategoryRead	Schema →
POST	/api/v1/product-categories	create	🔒 Restricted	ProductCategoryWrite	Schema →
GET	/api/v1/product-categories/:id	find	🔒 Restricted	ProductCategoryRead	Schema →
PATCH	/api/v1/product-categories/:id	update	🔒 Restricted	ProductCategoryWrite	Schema →
DELETE	/api/v1/product-categories/:id	delete	🔒 Restricted	ProductCategoryWrite	Schema →

ProductPlans10 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/product-plans	list	🔒 Restricted	ProductPlanRead	Schema →
POST	/api/v1/product-plans	create	🔒 Restricted	ProductPlanWrite	Schema →
GET	/api/v1/product-plans/:id	find	🔒 Restricted	ProductPlanRead	Schema →
PATCH	/api/v1/product-plans/:id	update	🔒 Restricted	ProductPlanWrite	Schema →
POST	/api/v1/product-plans/:id/activate	activate	🔒 Restricted	ProductPlanWrite	Schema →
POST	/api/v1/product-plans/:id/deactivate	deactivate	🔒 Restricted	ProductPlanWrite	Schema →
GET	/api/v1/product-plans/:id/effective-required-documents	effectiveDocs	🔒 Restricted	ProductPlanRead	Schema →
GET	/api/v1/product-plans/:id/required-documents	listDocs	🔒 Restricted	ProductPlanRead	Schema →
POST	/api/v1/product-plans/:id/required-documents	upsertDoc	🔒 Restricted	ProductPlanWrite	Schema →
DELETE	/api/v1/product-plans/:id/required-documents/:code	deleteDoc	🔒 Restricted	ProductPlanWrite	Schema →

PublicContent1 endpoint

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/public/content/:code/in-force	inForce	🌐 Public	—	Schema →

PublicIraRegistry1 endpoint

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/public/ira-registry/:iraNumber	find	🌐 Public	—	Schema →

PublicLeads1 endpoint

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/public/leads	submit	🌐 Public	—	Schema →

PublicPasskeys2 endpoints

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/passkeys/authentication/options	authenticationOptions	🌐 Public	—	Schema →
POST	/api/v1/passkeys/authentication/verify	verifyAuthentication	🌐 Public	—	Schema →

Quotations6 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/quotations	list	🔒 Restricted	QuotationReadOwn (any)QuotationRead (any)	Schema →
GET	/api/v1/quotations/:id	find	🔒 Restricted	QuotationReadOwn (any)QuotationRead (any)	Schema →
POST	/api/v1/quotations/:id/accept	accept	🔒 Restricted	QuotationAcceptDecline	Schema →
POST	/api/v1/quotations/:id/decline	decline	🔒 Restricted	QuotationAcceptDecline	Schema →
GET	/api/v1/quotations/referrals/:referralId/compare	compare	🔒 Restricted	QuotationReadOwn (any)QuotationRead (any)	Schema →
POST	/api/v1/quotations/sweep/expire	expire	🔒 Restricted	QuotationExpire	Schema →

Ratings4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/ratings	list	🔒 Restricted	RatingRead	Schema →
POST	/api/v1/ratings	create	🔒 Restricted	RatingWrite	Schema →
DELETE	/api/v1/ratings/:id	remove	🔒 Restricted	RatingModerate	Schema →
GET	/api/v1/ratings/summary/:subjectType/:subjectId	summary	🔒 Restricted	RatingRead	Schema →

Referrals22 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/referrals	list	🔒 Restricted	ReferralRead (any)ReferralReadOwn (any)	Schema →
POST	/api/v1/referrals	create	🔒 Restricted	ReferralWrite	Schema →
GET	/api/v1/referrals/:id	find	🔒 Restricted	ReferralRead (any)ReferralReadOwn (any)	Schema →
PATCH	/api/v1/referrals/:id	update	🔒 Restricted	ReferralWrite	Schema →
POST	/api/v1/referrals/:id/assign	assign	🔒 Restricted	ReferralAssign	Schema →
POST	/api/v1/referrals/:id/cancel	cancel	🔒 Restricted	ReferralCancel	Schema →
POST	/api/v1/referrals/:id/client-acceptance	acceptance	🔒 Restricted	ReferralClientAcceptance	Schema →
GET	/api/v1/referrals/:id/commissions	commissions	🔒 Restricted	CommissionRead	Schema →
POST	/api/v1/referrals/:id/confirm-premium-payment	confirmPremium	🔒 Restricted	ReferralPremiumConfirm	Schema →
POST	/api/v1/referrals/:id/dispute	dispute	🔒 Restricted	ReferralDispute	Schema →
GET	/api/v1/referrals/:id/documents	documents	🔒 Restricted	DocumentRead	Schema →
POST	/api/v1/referrals/:id/documents	attachDoc	🔒 Restricted	DocumentWrite	Schema →
POST	/api/v1/referrals/:id/issue-policy	issuePolicy	🔒 Restricted	ReferralPolicyIssue	Schema →
POST	/api/v1/referrals/:id/notes	addNote	🔒 Restricted	ReferralWrite	Schema →
POST	/api/v1/referrals/:id/record-quotation	recordQuotation	🔒 Restricted	ReferralQuotationRecord	Schema →
POST	/api/v1/referrals/:id/reject	reject	🔒 Restricted	ReferralReject	Schema →
POST	/api/v1/referrals/:id/request-info	requestInfo	🔒 Restricted	ReferralReview	Schema →
POST	/api/v1/referrals/:id/reverse	reverse	🔒 Restricted	ReferralReverse	Schema →
POST	/api/v1/referrals/:id/send-to-insurer	sendToInsurer	🔒 Restricted	ReferralSendToInsurer	Schema →
POST	/api/v1/referrals/:id/share-quotation	shareQuotation	🔒 Restricted	ReferralQuotationShare	Schema →
POST	/api/v1/referrals/:id/submit	submit	🔒 Restricted	ReferralSubmit	Schema →
GET	/api/v1/referrals/:id/timeline	timeline	🔒 Restricted	ReferralTimelineRead	Schema →

RegulatorReports4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/reports/regulator/compliance-export	complianceExport	🔒 Restricted	RegulatorComplianceExport	Schema →
GET	/api/v1/reports/regulator/insurer-summary	insurerSummary	🔒 Restricted	RegulatorInsurerSummaryRead	Schema →
GET	/api/v1/reports/regulator/platform-summary	platformSummary	🔒 Restricted	RegulatorAggregateRead	Schema →
GET	/api/v1/reports/regulator/product-mix	productMix	🔒 Restricted	RegulatorProductMixRead	Schema →

RegulatorRequests6 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/compliance/regulator-requests	list	🔒 Restricted	RegulatorRecordRequestRead	Schema →
POST	/api/v1/compliance/regulator-requests	create	🔒 Restricted	RegulatorRecordRequestCreate	Schema →
GET	/api/v1/compliance/regulator-requests/:id	find	🔒 Restricted	RegulatorRecordRequestRead	Schema →
POST	/api/v1/compliance/regulator-requests/:id/approve	approve	🔒 Restricted	RegulatorRecordRequestFulfil	Schema →
POST	/api/v1/compliance/regulator-requests/:id/deny	deny	🔒 Restricted	RegulatorRecordRequestFulfil	Schema →
POST	/api/v1/compliance/regulator-requests/:id/fulfil	fulfil	🔒 Restricted	RegulatorRecordRequestFulfil	Schema →

Renewals6 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/renewals	list	🔒 Restricted	RenewalRead	Schema →
GET	/api/v1/renewals/:id	find	🔒 Restricted	RenewalRead	Schema →
POST	/api/v1/renewals/:id/convert	convert	🔒 Restricted	RenewalConvert	Schema →
POST	/api/v1/renewals/:id/decline	decline	🔒 Restricted	RenewalOffer	Schema →
POST	/api/v1/renewals/:id/offer	offer	🔒 Restricted	RenewalOffer	Schema →
POST	/api/v1/renewals/policies/:policyId/generate	generate	🔒 Restricted	RenewalGenerate	Schema →

Reports8 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/reports/agent-performance	agentPerformance	🔒 Restricted	ReportAgent	Schema →
GET	/api/v1/reports/audit-events	auditEvents	🔒 Restricted	ReportAuditEvents	Schema →
GET	/api/v1/reports/commission-summary	commissionSummary	🔒 Restricted	ReportCommission	Schema →
GET	/api/v1/reports/export	export	🔒 Restricted	ReportExport	Schema →
GET	/api/v1/reports/insurer-performance	insurerPerformance	🔒 Restricted	ReportInsurerPerformance	Schema →
GET	/api/v1/reports/payment-reconciliation	paymentReconciliation	🔒 Restricted	ReportPaymentReconciliation	Schema →
GET	/api/v1/reports/product-performance	productPerformance	🔒 Restricted	ReportProductPerformance	Schema →
GET	/api/v1/reports/referral-pipeline	referralPipeline	🔒 Restricted	ReportReferralPipeline	Schema →

Roles7 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/permissions	permissions	🔒 Restricted	PermissionRead	Schema →
GET	/api/v1/roles	list	🔒 Restricted	RoleRead	Schema →
POST	/api/v1/roles	create	🔒 Restricted	RoleManage	Schema →
GET	/api/v1/roles/:id	find	🔒 Restricted	RoleRead	Schema →
PATCH	/api/v1/roles/:id	update	🔒 Restricted	RoleManage	Schema →
DELETE	/api/v1/roles/:id	delete	🔒 Restricted	RoleManage	Schema →
PUT	/api/v1/roles/:id/permissions	setPermissions	🔒 Restricted	RoleManage	Schema →

Sanctions4 endpoints

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/sanctions/screen	screen	🔒 Restricted	SanctionsScreen	Schema →
GET	/api/v1/sanctions/screenings	list	🔒 Restricted	SanctionsRead	Schema →
GET	/api/v1/sanctions/screenings/:id	find	🔒 Restricted	SanctionsRead	Schema →
POST	/api/v1/sanctions/screenings/:id/review	review	🔒 Restricted	SanctionsReview	Schema →

Search1 endpoint

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/search	search	🔒 Restricted	SearchRead	Schema →

SiemExport2 endpoints

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/siem/export/push	push	🔒 Restricted	SiemExportTrigger	Schema →
GET	/api/v1/siem/export/status	status	🔒 Restricted	SiemExportRead	Schema →

SubscriptionPlans3 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/subscription-plans	list	🔒 Restricted	SubscriptionPlanRead	Schema →
POST	/api/v1/subscription-plans	create	🔒 Restricted	SubscriptionPlanWrite	Schema →
PATCH	/api/v1/subscription-plans/:id	update	🔒 Restricted	SubscriptionPlanWrite	Schema →

SupportTickets7 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/support/tickets	list	🔒 Restricted	SupportTicketReadOwn (any)SupportTicketRead (any)	Schema →
POST	/api/v1/support/tickets	create	🔒 Restricted	SupportTicketCreate	Schema →
GET	/api/v1/support/tickets/:id	find	🔒 Restricted	SupportTicketReadOwn (any)SupportTicketRead (any)	Schema →
POST	/api/v1/support/tickets/:id/assign	assign	🔒 Restricted	SupportTicketAssign	Schema →
POST	/api/v1/support/tickets/:id/close	close	🔒 Restricted	SupportTicketResolve	Schema →
POST	/api/v1/support/tickets/:id/reply	reply	🔒 Restricted	SupportTicketReply	Schema →
POST	/api/v1/support/tickets/:id/resolve	resolve	🔒 Restricted	SupportTicketResolve	Schema →

System1 endpoint

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/system/info	info	🔒 Restricted	SuperAdminOperationsOfficer	Schema →

Underwriting5 endpoints

Method	Path	Handler	Access	Requires	Fields
POST	/api/v1/underwriting/evaluate	evaluate	🔒 Restricted	UnderwritingEvaluate	Schema →
GET	/api/v1/underwriting/rules	list	🔒 Restricted	UnderwritingRuleRead	Schema →
POST	/api/v1/underwriting/rules	create	🔒 Restricted	UnderwritingRuleWrite	Schema →
GET	/api/v1/underwriting/rules/:id	find	🔒 Restricted	UnderwritingRuleRead	Schema →
PATCH	/api/v1/underwriting/rules/:id	update	🔒 Restricted	UnderwritingRuleWrite	Schema →

Users8 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/users	list	🔒 Restricted	UserRead	Schema →
POST	/api/v1/users	create	🔒 Restricted	UserWrite	Schema →
GET	/api/v1/users/:id	find	🔒 Restricted	UserRead	Schema →
PATCH	/api/v1/users/:id	update	🔒 Restricted	UserWrite	Schema →
POST	/api/v1/users/:id/activate	activate	🔒 Restricted	UserWrite	Schema →
POST	/api/v1/users/:id/roles	assignRole	🔒 Restricted	RoleManage	Schema →
DELETE	/api/v1/users/:id/roles/:roleId	removeRole	🔒 Restricted	RoleManage	Schema →
POST	/api/v1/users/:id/suspend	suspend	🔒 Restricted	UserWrite	Schema →

WalletsAdmin3 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/wallets/:agentId	read	🔒 Restricted	WalletRead	Schema →
POST	/api/v1/wallets/:agentId/adjustments	adjust	🔒 Restricted	WalletAdjust	Schema →
GET	/api/v1/wallets/:agentId/ledger	ledger	🔒 Restricted	WalletRead	Schema →

Wallets4 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/wallet	mine	🔒 Restricted	WalletReadOwn (any)WalletRead (any)	Schema →
POST	/api/v1/wallet/convert	convert	🔒 Restricted	WalletConvert	Schema →
GET	/api/v1/wallet/ledger	myLedger	🔒 Restricted	WalletReadOwn (any)WalletRead (any)	Schema →
POST	/api/v1/wallet/withdraw	withdraw	🔒 Restricted	WalletWithdraw	Schema →

WarehouseExport3 endpoints

Method	Path	Handler	Access	Requires	Fields
GET	/api/v1/warehouse-export	list	🔒 Restricted	WarehouseExportRead	Schema →
GET	/api/v1/warehouse-export/:id	find	🔒 Restricted	WarehouseExportRead	Schema →
POST	/api/v1/warehouse-export/run	run	🔒 Restricted	WarehouseExportTrigger	Schema →