Essence Notification Service API

Version v1 · OpenAPI 3.0.1 · 120 operations · Download the JSON document

EPIC 66: Centralised notification & messaging engine

Generated from the Notifications service's code at build time (api-specs/generated/Notifications/Essence.Platform.Notifications.Api.json) and drift-checked in CI. It describes what the code registers, which is not the same as what any one deployment has routed.

AdminChannelProviderConfig

GET/api/v1/admin/notifications/instances/{instanceId}/providers

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`instanceId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — ChannelProviderConfigSummary[]

GET/api/v1/admin/notifications/instances/{instanceId}/providers/{channel}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`instanceId`	path	`string (uuid)`	yes	—
`channel`	path	`NotificationChannel`	yes	—

Request body

No request body.

Responses

200Success — ChannelProviderConfigSummary

404Not Found — ProblemDetails

PUT/api/v1/admin/notifications/instances/{instanceId}/providers/{channel}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`instanceId`	path	`string (uuid)`	yes	—
`channel`	path	`NotificationChannel`	yes	—

Request body

Not marked as required in the document.

UpsertChannelProviderConfigBody as application/*+json, application/json, text/json

Responses

200Success — ChannelProviderConfigSummary

POST/api/v1/admin/notifications/instances/{instanceId}/providers/{channel}/activate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`instanceId`	path	`string (uuid)`	yes	—
`channel`	path	`NotificationChannel`	yes	—

Request body

No request body.

Responses

204No Content

404Not Found — ProblemDetails

POST/api/v1/admin/notifications/instances/{instanceId}/providers/{channel}/deactivate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`instanceId`	path	`string (uuid)`	yes	—
`channel`	path	`NotificationChannel`	yes	—

Request body

No request body.

Responses

204No Content

404Not Found — ProblemDetails

AdminChannelProviders

GET/api/v1/admin/notifications/providers

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success

PUT/api/v1/admin/notifications/providers/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

UpdateChannelProviderBody as application/*+json, application/json, text/json

Responses

200Success — ChannelProviderConfigSummary

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

AdminDashboard

GET/api/v1/admin/notifications/dashboard

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success

GET/api/v1/admin/notifications/dlq

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`page`	query	`integer (int32)`	no	—
`pageSize`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200Success

DELETE/api/v1/admin/notifications/dlq/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

POST/api/v1/admin/notifications/dlq/{id}/retry

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

AdminDeadLetterBulkRetry

POST/api/v1/admin/notifications/dlq/bulk-retry

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

BulkRetryRequest as application/*+json, application/json, text/json

Responses

200Success

CardCaptureNotice

POST/api/v1/notifications/card-capture/{captureId}/notice

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`captureId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

CardCaptureNoticeRequestDto as application/*+json, application/json, text/json

Responses

202Accepted — CardCaptureNoticeResultDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

POST/api/v1/notifications/card-capture/{captureId}/outcome

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`captureId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

CardCaptureOutcomeRequestDto as application/*+json, application/json, text/json

Responses

202Accepted — CardCaptureNoticeResultDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

ConfirmationGates

GET/api/v1/admin/notifications/confirmation-gates/pending

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`page`	query	`integer (int32)`	no	—
`pageSize`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200Success

PATCH/api/v1/admin/notifications/confirmation-gates/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

DecideGateRequest as application/*+json, application/json, text/json

Responses

200Success

ConsentRevocations

GET/api/v1/notifications/consent-revocations/{revocationBatchId}/status

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`revocationBatchId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — ConsentRevocationBatchStatusDto

ContactUpdatedNotice

GET/api/v1/notifications/contact-updated/delivery-record/{deliveryRecordId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`deliveryRecordId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — ContactUpdatedDeliveryRecord

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/notifications/contact-updated/delivery-record/{deliveryRecordId}/export

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`deliveryRecordId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/notifications/contact-updated/{notificationId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`notificationId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — ContactUpdatedNoticeDetail

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

ContactUpdatedNoticeDispatch

POST/api/v1/notifications/contact-updated

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

ContactUpdatedDispatchRequest as application/*+json, application/json, text/json

Responses

202Accepted — ContactUpdatedDispatchResult

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

CredentialCompromise

GET/api/v1/credential-compromise-notifications

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`correlationId`	query	`string (uuid)`	no	—

Request body

No request body.

Responses

200Success — CredentialCompromiseNotificationDto

404Not Found — ProblemDetails

GET/api/v1/credential-compromise-notifications/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — CredentialCompromiseNotificationDto

404Not Found — ProblemDetails

CrossInstanceAggregation

GET/api/v1/notifications/cross-instance/delivery-log

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`cursor`	query	`string`	no	—
`pageSize`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200Success

GET/api/v1/notifications/cross-instance/delivery-log/export

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`maxRows`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200Success

Devices

GET/api/v1/notifications/devices

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success

POST/api/v1/notifications/devices

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

RegisterDeviceRequestDto as application/*+json, application/json, text/json

Responses

200Success

DELETE/api/v1/notifications/devices/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

Erasure

GET/api/v1/erasure-probe/{subjectId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`subjectId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

Inbox

GET/api/v1/notifications

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`cursor`	query	`string`	no	—
`pageSize`	query	`integer (int32)`	no	—
`status`	query	`string`	no	—
`instance`	query	`string`	no	—
`module`	query	`string`	no	—

Request body

No request body.

Responses

200Success

GET/api/v1/notifications/inbox

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`cursor`	query	`string`	no	—
`pageSize`	query	`integer (int32)`	no	—
`status`	query	`string`	no	—
`instance`	query	`string`	no	—
`module`	query	`string`	no	—

Request body

No request body.

Responses

200Success

POST/api/v1/notifications/read-all

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

ReadAllRequest as application/*+json, application/json, text/json

Responses

200Success

DELETE/api/v1/notifications/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

PATCH/api/v1/notifications/{id}/read

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

PATCH/api/v1/notifications/{id}/unread

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

InstitutionalEndpoints

GET/api/v1/org/{orgId}/notifications/institutional/endpoints

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

POST/api/v1/org/{orgId}/notifications/institutional/endpoints

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

RegisterInstitutionalEndpointRequest as application/*+json, application/json, text/json

Responses

200Success

PUT/api/v1/org/{orgId}/notifications/institutional/endpoints/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

UpdateInstitutionalEndpointRequest as application/*+json, application/json, text/json

Responses

200Success

DELETE/api/v1/org/{orgId}/notifications/institutional/endpoints/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

POST/api/v1/org/{orgId}/notifications/institutional/endpoints/{id}/test

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

InstitutionalPull

GET/api/v1/institutional/notifications/pending

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`eventType`	query	`string`	no	—
`since`	query	`string (date-time)`	no	—
`page`	query	`integer (int32)`	no	—
`pageSize`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200Success

POST/api/v1/institutional/notifications/{id}/acknowledge

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

AcknowledgeRequest as application/*+json, application/json, text/json

Responses

200Success

InternalSend

POST/api/v1/internal/notifications/direct-send

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

InternalDirectSendRequest as application/*+json, application/json, text/json

Responses

200Success — DirectSendOutcome

POST/api/v1/internal/notifications/send

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

InternalSendRequest as application/*+json, application/json, text/json

Responses

202Accepted

Invitations

POST/api/v1/notifications/invitations/delegate-assist

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

DelegateAssistInvitationRequestDto as application/*+json, application/json, text/json

Responses

202Accepted — DelegateAssistInvitationAcceptedDto

400Bad Request — ProblemDetails

422Client Error — ProblemDetails

MarketingUnsubscribe

GET/api/v1/notifications/marketing/unsubscribe

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`token`	query	`string`	no	—

Request body

No request body.

Responses

200Success

400Bad Request — ProblemDetails

503Server Error

POST/api/v1/notifications/marketing/unsubscribe

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`token`	query	`string`	no	—

Request body

No request body.

Responses

204No Content

400Bad Request — ProblemDetails

503Server Error

POST/api/v1/notifications/marketing/whatsapp-optout

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

WhatsAppOptOutRequest as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — ProblemDetails

503Server Error

MutedSenders

GET/api/v1/notifications/muted-senders

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success

POST/api/v1/notifications/muted-senders

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

MuteSenderRequest as application/*+json, application/json, text/json

Responses

200Success

DELETE/api/v1/notifications/muted-senders/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

NameChangeBroadcast

POST/api/v1/notifications/name-change/broadcast/{broadcastId}/undo

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`broadcastId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — NameChangeUndoResultDto

POST/api/v1/notifications/name-change/{changeId}/broadcast

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`changeId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

202Accepted — NameChangeBroadcastResultDto

GET/api/v1/notifications/name-change/{changeId}/broadcast/preview

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`changeId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — NameChangeBroadcastPreviewDto

NonSuppressibleRegister

GET/api/v1/notifications/non-suppressible-register

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — NonSuppressibleRegisterDto

NotificationsReattestationRemind

POST/api/v1/notifications/contact-card/reattestation/{broadcastId}/remind

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`broadcastId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

ReattestationRemindRequestDto as application/*+json, application/json, text/json

Responses

200Success — ReattestationRemindResponseDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

ObligationEscalationPolicies

GET/api/v1/notifications/escalation-policies/{obligationRef}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`obligationRef`	path	`string`	yes	—

Request body

No request body.

Responses

200Success — EscalationPolicyDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

PUT/api/v1/notifications/escalation-policies/{obligationRef}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`obligationRef`	path	`string`	yes	—

Request body

Not marked as required in the document.

EscalationPolicyDto as application/*+json, application/json, text/json

Responses

200Success — EscalationPolicyDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

422Client Error — ProblemDetails

POST/api/v1/notifications/escalation-policies/{obligationRef}/decisions

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`obligationRef`	path	`string`	yes	—

Request body

Not marked as required in the document.

EscalationDecisionRequest as application/*+json, application/json, text/json

Responses

200Success — EscalationDecisionDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

OrgNotifications

POST/api/v1/org/{orgId}/notifications/broadcast

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

OrgBroadcastRequest as application/*+json, application/json, text/json

Responses

200Success

GET/api/v1/org/{orgId}/notifications/broadcasts/{broadcastId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—
`broadcastId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

GET/api/v1/org/{orgId}/notifications/category-governance

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

PUT/api/v1/org/{orgId}/notifications/category-governance

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

UpdateCategoryGovernanceRequest as application/*+json, application/json, text/json

Responses

200Success

GET/api/v1/org/{orgId}/notifications/digest-floor

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

PUT/api/v1/org/{orgId}/notifications/digest-floor

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

SetDigestFloorRequest as application/*+json, application/json, text/json

Responses

200Success

GET/api/v1/org/{orgId}/notifications/history

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—
`page`	query	`integer (int32)`	no	—
`pageSize`	query	`integer (int32)`	no	—
`channel`	query	`string`	no	—
`eventType`	query	`string`	no	—
`userId`	query	`string (uuid)`	no	—

Request body

No request body.

Responses

200Success

GET/api/v1/org/{orgId}/notifications/reattestation-cadence

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

PUT/api/v1/org/{orgId}/notifications/reattestation-cadence

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

UpdateReattestationCadenceRequest as application/*+json, application/json, text/json

Responses

200Success

GET/api/v1/org/{orgId}/notifications/settings

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

PUT/api/v1/org/{orgId}/notifications/settings

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

UpdateOrgSettingsRequest as application/*+json, application/json, text/json

Responses

200Success

OrgSubscriptions

GET/api/v1/notifications/org-subscriptions

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success

POST/api/v1/notifications/org-subscriptions

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateOrgSubscriptionRequest as application/*+json, application/json, text/json

Responses

200Success

DELETE/api/v1/notifications/org-subscriptions/by-org/{orgId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`orgId`	path	`string (uuid)`	yes	—
`moduleId`	query	`string`	no	—

Request body

No request body.

Responses

200Success

DELETE/api/v1/notifications/org-subscriptions/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

PortfolioTransferServiceEvidence

GET/api/v1/notifications/portfolio-transfers/{corporateEventId}/evidence-of-service

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`corporateEventId`	path	`string (uuid)`	yes	—
`policyholdersInBook`	query	`integer (int32)`	no	—

Request body

No request body.

Responses

200Success — PortfolioTransferServiceEvidenceDto

400Bad Request — ProblemDetails

Preferences

GET/api/v1/notifications/preferences

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success

PUT/api/v1/notifications/preferences

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

UpdatePreferenceRequest as application/*+json, application/json, text/json

Responses

200Success

GET/api/v1/notifications/preferences/digest

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success

PUT/api/v1/notifications/preferences/digest

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

UpdateDigestRequest as application/*+json, application/json, text/json

Responses

200Success

PUT/api/v1/notifications/preferences/privacy-mode

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

PrivacyModeRequest as application/*+json, application/json, text/json

Responses

200Success

ProviderWebhook

POST/api/v1/webhooks/notifications/providers/{provider}/delivery-status

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`provider`	path	`string`	yes	—

Request body

No request body.

Responses

200Success

401Unauthorized — ProblemDetails

QuietHours

GET/api/v1/notifications/preferences/quiet-hours

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success

PUT/api/v1/notifications/preferences/quiet-hours

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

UpdateQuietHoursRequest as application/*+json, application/json, text/json

Responses

200Success

ReattestationReminder

POST/api/v1/contact-cards/{cardId}/reattestation/remind

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`cardId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — ReattestationRemindResponseDto

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

Reengagement

POST/api/v1/notifications/reengagement/opt-out

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

ReengagementOptOutRequestDto as application/*+json, application/json, text/json

Responses

204No Content

400Bad Request — ProblemDetails

503Server Error

GET/api/v1/notifications/reengagement/preference

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`token`	query	`string`	no	—

Request body

No request body.

Responses

200Success — ReengagementPreferenceDto

400Bad Request — ProblemDetails

503Server Error

POST/api/v1/notifications/reengagement/snooze

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

ReengagementSnoozeRequestDto as application/*+json, application/json, text/json

Responses

200Success — ReengagementPreferenceDto

400Bad Request — ProblemDetails

503Server Error

SafeguardingScopes

GET/api/v1/notifications/safeguarding-scopes

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — SafeguardingScopeListDto

GET/api/v1/notifications/safeguarding-scopes/{consentGrantId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`consentGrantId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — SafeguardingScopeDto

404Not Found — ProblemDetails

PUT/api/v1/notifications/safeguarding-scopes/{consentGrantId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`consentGrantId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

PutSafeguardingScopeRequest as application/*+json, application/json, text/json

Responses

200Success — SafeguardingScopeDto

400Bad Request — ProblemDetails

422Client Error — ProblemDetails

DELETE/api/v1/notifications/safeguarding-scopes/{consentGrantId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`consentGrantId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

204No Content

SecurityAdvisories

GET/api/v1/security-advisories

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`status`	query	`string`	no	—

Request body

No request body.

Responses

200Success — SecurityAdvisoryDto[]

POST/api/v1/security-advisories

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateSecurityAdvisoryRequest as application/*+json, application/json, text/json

Responses

201Created — SecurityAdvisoryDto

400Bad Request — ProblemDetails

GET/api/v1/security-advisories/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — SecurityAdvisoryDto

404Not Found — ProblemDetails

POST/api/v1/security-advisories/{id}/send

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — SecurityAdvisoryDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

SecurityAdvisoryInbox

GET/api/v1/notifications/security-advisories

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — TenantSecurityAdvisoryDto[]

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/notifications/security-advisories/{advisoryId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`advisoryId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — TenantSecurityAdvisoryDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/notifications/security-advisories/{advisoryId}/acknowledge

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`advisoryId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

AcknowledgeAdvisoryRequest as application/*+json, application/json, text/json

Responses

200Success — TenantSecurityAdvisoryDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

SharedContactConsent

POST/api/v1/notifications/shared-contact-consent/{designationId}/acceptance

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`designationId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

SharedContactAcceptanceRequestDto as application/*+json, application/json, text/json

Responses

202Accepted — SharedContactConsentResultDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

POST/api/v1/notifications/shared-contact-consent/{designationId}/invitation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`designationId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

SharedContactInvitationRequestDto as application/*+json, application/json, text/json

Responses

202Accepted — SharedContactConsentResultDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

POST/api/v1/notifications/shared-contact-consent/{designationId}/revocation

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`designationId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

SharedContactRevocationRequestDto as application/*+json, application/json, text/json

Responses

202Accepted — SharedContactConsentResultDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

StatutoryServices

GET/api/v1/notifications/statutory-services/{serviceId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`serviceId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — StatutoryServiceEvidenceDto

404Not Found — ProblemDetails

POST/api/v1/notifications/statutory-services/{serviceId}/attempts

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`serviceId`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

StatutoryServiceAttemptRequest as application/*+json, application/json, text/json

Responses

201Created — StatutoryServiceAttemptResultDto

400Bad Request — ProblemDetails

422Client Error — ProblemDetails

Templates

GET/api/v1/admin/notifications/templates

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`governanceStatus`	query	`string`	no	—
`channel`	query	`string`	no	—
`language`	query	`string`	no	—

Request body

No request body.

Responses

200Success

POST/api/v1/admin/notifications/templates

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

CreateTemplateRequest as application/*+json, application/json, text/json

Responses

200Success

PUT/api/v1/admin/notifications/templates/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

UpdateTemplateRequest as application/*+json, application/json, text/json

Responses

200Success

PATCH/api/v1/admin/notifications/templates/{id}/governance

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

TemplateGovernanceRequest as application/*+json, application/json, text/json

Responses

200Success

POST/api/v1/admin/notifications/templates/{id}/preview

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

PreviewRequest as application/*+json, application/json, text/json

Responses

200Success

POST/api/v1/admin/notifications/templates/{id}/test

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

Not marked as required in the document.

TemplateTestSendRequest as application/*+json, application/json, text/json

Responses

200Success

TrustedContactConsent

POST/api/v1/notifications/trusted-contact-consent/respond

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`user`	query	`string (uuid)`	no	—
`action`	query	`string`	no	—
`exp`	query	`integer (int64)`	no	—
`sig`	query	`string`	no	—

Request body

No request body.

Responses

200Success — TrustedContactConsentStatusResponse

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

VerifiedChangeBroadcast

POST/api/v1/notifications/verified-change/broadcast/{broadcastId}/undo

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`broadcastId`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — VerifiedChangeUndoResultDto

401Unauthorized — ProblemDetails

GET/api/v1/notifications/verified-change/delivery-record/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success — VerifiedChangeDeliveryRecordDto

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/notifications/verified-change/delivery-record/{id}/export

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`id`	path	`string (uuid)`	yes	—

Request body

No request body.

Responses

200Success

401Unauthorized — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/notifications/verified-change/{changeId}/broadcast

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
`changeId`	path	`string (uuid)`	yes	—
`signatureRef`	query	`string`	no	—
`reconciliationId`	query	`string (uuid)`	no	—

Request body

No request body.

Responses

200Success — VerifiedChangeBroadcastResultDto

202Accepted — VerifiedChangeBroadcastResultDto

401Unauthorized — ProblemDetails

Schemas

AcknowledgeAdvisoryRequest

Property	Type	Required	Description
`disposition`	`string \| null`	no	—

AcknowledgeRequest

Property	Type	Required	Description
`referenceNumber`	`string \| null`	no	—

ArmTrustedContactRequest

Property	Type	Required	Description
`contact`	`string \| null`	no	—

BulkRetryRequest

Property	Type	Required	Description
`ids`	`(string (uuid))[] \| null`	no	—

CardCaptureNoticeRequestDto

Property	Type	Required	Description
`reviewUrl`	`string \| null`	no	—
`subjectRecipientId`	`string (uuid)`	no	—

CardCaptureNoticeResultDto

Property	Type	Required	Description
`dispatchedCount`	`integer (int32)`	no	—
`statusMessage`	`string \| null`	no	—

CardCaptureOutcomeRequestDto

Property	Type	Required	Description
`capturerOutcomeUrl`	`string \| null`	no	—
`capturerRecipientId`	`string (uuid)`	no	—
`released`	`boolean`	no	—
`subjectOutcomeUrl`	`string \| null`	no	—

ChannelPreferences

Property	Type	Required	Description
`email`	`boolean`	no	—
`inApp`	`boolean`	no	—
`push`	`boolean`	no	—
`sms`	`boolean`	no	—
`teams`	`boolean`	no	—
`whatsApp`	`boolean`	no	—

ChannelProviderConfigSummary

Property	Type	Required	Description
`channel`	`NotificationChannel`	no	—
`circuitBreakerState`	`string \| null`	no	—
`id`	`string (uuid)`	no	—
`instanceId`	`string (uuid)`	no	—
`isActive`	`boolean`	no	—
`lastHealthCheckAt`	`string (date-time) \| null`	no	—
`providerType`	`string \| null`	no	—
`rateLimitPerMinute`	`integer (int32)`	no	—
`senderIdentity`	`string \| null`	no	—

ConsentRevocationBatchStatusDto

Property	Type	Required	Description
`deliveredCount`	`integer (int32)`	no	—
`failedCount`	`integer (int32)`	no	—
`queuedCount`	`integer (int32)`	no	—
`recipientCount`	`integer (int32)`	no	—
`recipients`	`ConsentRevocationRecipientStatusDto[] \| null`	no	—
`revocationBatchId`	`string (uuid)`	no	—

ConsentRevocationRecipientStatusDto

Property	Type	Required	Description
`recipientId`	`string (uuid)`	no	—
`status`	`string \| null`	no	—

ContactUpdatedDeliveryLine

Property	Type	Required	Description
`channel`	`string \| null`	no	—
`createdAtIso`	`string \| null`	no	—
`deliveredAtIso`	`string \| null`	no	—
`disclosureLevel`	`string \| null`	no	—
`notificationId`	`string (uuid)`	no	—
`openedAtIso`	`string \| null`	no	—
`sentAtIso`	`string \| null`	no	—
`status`	`string \| null`	no	—

ContactUpdatedDeliveryRecord

Property	Type	Required	Description
`changedFieldLabels`	`string[] \| null`	no	—
`deliveries`	`ContactUpdatedDeliveryLine[] \| null`	no	—
`deliveryRecordId`	`string (uuid)`	no	—
`occurredAtIso`	`string \| null`	no	—
`senderDisplayName`	`string \| null`	no	—

ContactUpdatedDispatchedNotice

Property	Type	Required	Description
`channel`	`string \| null`	no	—
`disclosureLevel`	`string \| null`	no	—
`notificationId`	`string (uuid)`	no	—
`recipientId`	`string (uuid)`	no	—

ContactUpdatedDispatchRequest

Property	Type	Required	Description
`changedFieldLabels`	`string[] \| null`	no	—
`instanceId`	`string (uuid)`	no	—
`pushId`	`string (uuid)`	no	—
`recipients`	`ContactUpdatedRecipient[] \| null`	no	—
`subjectDisplayName`	`string \| null`	no	—
`subjectUserId`	`string (uuid)`	no	—

ContactUpdatedDispatchResult

Property	Type	Required	Description
`deliveryRecordId`	`string (uuid)`	no	—
`dispatched`	`ContactUpdatedDispatchedNotice[] \| null`	no	—
`rejectedDetail`	`string \| null`	no	—
`skipped`	`ContactUpdatedSkippedRecipient[] \| null`	no	—

ContactUpdatedFieldDiff

Property	Type	Required	Description
`granularity`	`string \| null`	no	—
`label`	`string \| null`	no	—
`newValue`	`string \| null`	no	—
`previousValue`	`string \| null`	no	—

ContactUpdatedNoticeDetail

Property	Type	Required	Description
`deliveryRecordId`	`string (uuid)`	no	—
`diff`	`ContactUpdatedFieldDiff[] \| null`	no	—
`disclosureLevel`	`string \| null`	no	—
`notificationId`	`string (uuid)`	no	—
`occurredAtIso`	`string \| null`	no	—
`readAtIso`	`string \| null`	no	—
`senderDisplayName`	`string \| null`	no	—

ContactUpdatedRecipient

Property	Type	Required	Description
`channel`	`string \| null`	no	—
`recipientId`	`string (uuid)`	no	—

ContactUpdatedSkippedRecipient

Property	Type	Required	Description
`channel`	`string \| null`	no	—
`reason`	`string \| null`	no	—
`recipientId`	`string (uuid)`	no	—

CreateAdvisoryRecipientDto

Property	Type	Required	Description
`channel`	`string \| null`	no	—
`noActionNeeded`	`boolean`	no	—
`organizationId`	`string (uuid)`	no	—
`tenantImpactSummary`	`string \| null`	no	—

CreateOrgSubscriptionRequest

Property	Type	Required	Description
`moduleId`	`string \| null`	no	—
`organisationId`	`string (uuid)`	no	—
`scope`	`string \| null`	no	—

CreateSecurityAdvisoryRequest

Property	Type	Required	Description
`exposureWindowEnd`	`string (date-time)`	no	—
`exposureWindowStart`	`string (date-time)`	no	—
`incidentReference`	`string \| null`	no	—
`recipients`	`CreateAdvisoryRecipientDto[] \| null`	no	—
`requiredActions`	`string[] \| null`	no	—
`severity`	`string \| null`	no	—
`whatHappened`	`string \| null`	no	—

CreateTemplateRequest

Property	Type	Required	Description
`bodyTemplate`	`string \| null`	no	—
`channel`	`string \| null`	no	—
`contributingModule`	`string \| null`	no	—
`eventType`	`string \| null`	no	—
`language`	`string \| null`	no	—
`ownerOrgId`	`string (uuid) \| null`	no	—
`privacyLevel`	`string \| null`	no	—
`subject`	`string \| null`	no	—

CredentialCompromiseNotificationDto

Property	Type	Required	Description
`completedAt`	`string (date-time) \| null`	no	—
`compromiseReason`	`string \| null`	no	—
`correlationId`	`string (uuid)`	no	—
`id`	`string (uuid)`	no	—
`instanceId`	`string (uuid)`	no	—
`notifiedCount`	`integer (int32)`	no	—
`parties`	`RelyingPartyDeliveryDto[] \| null`	no	—
`status`	`string \| null`	no	—
`subjectUserId`	`string (uuid)`	no	—
`totalParties`	`integer (int32)`	no	—
`unreachableCount`	`integer (int32)`	no	—

DecideGateRequest

Property	Type	Required	Description
`decision`	`string \| null`	no	—
`reason`	`string \| null`	no	—

DelegateAssistInvitationAcceptedDto

Property	Type	Required	Description
`expiresAt`	`string (date-time)`	no	—
`status`	`string \| null`	no	—

DelegateAssistInvitationRequestDto

Property	Type	Required	Description
`eventType`	`string \| null`	no	—
`inviteeUserId`	`string (uuid) \| null`	no	—
`inviterDisplayName`	`string \| null`	no	—
`recipient`	`string \| null`	no	—
`sessionId`	`string \| null`	no	—

DeliveryStatus

0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 with no declared properties.

DirectSendOutcome

Property	Type	Required	Description
`delivered`	`boolean`	no	—
`error`	`string \| null`	no	—
`externalMessageId`	`string \| null`	no	—
`notificationId`	`string (uuid)`	no	—
`status`	`DeliveryStatus`	no	—

EscalationDecisionDto

Property	Type	Required	Description
`channels`	`string[] \| null`	no	—
`escalationTarget`	`string \| null`	no	—
`graceEndsAt`	`string (date-time)`	no	—
`missPosture`	`string \| null`	no	—
`reason`	`string \| null`	no	—
`verdict`	`string \| null`	no	—

EscalationDecisionRequest

Property	Type	Required	Description
`dueAt`	`string (date-time) \| null`	no	—
`outcome`	`string \| null`	no	—

EscalationPolicyDto

Property	Type	Required	Description
`channelOrder`	`string[] \| null`	no	—
`conditionId`	`string \| null`	no	—
`escalationTarget`	`string \| null`	no	—
`graceHours`	`integer (int32)`	no	—
`missPosture`	`string \| null`	no	—
`reminderLeadHours`	`(integer (int32))[] \| null`	no	—

InternalDirectSendRequest

Property	Type	Required	Description
`body`	`string \| null`	no	—
`channel`	`string \| null`	no	—
`correlationId`	`string \| null`	no	—
`data`	`map<string, string> \| null`	no	—
`emailAddress`	`string \| null`	no	—
`eventType`	`string \| null`	no	—
`instanceId`	`string (uuid) \| null`	no	—
`orgId`	`string (uuid) \| null`	no	—
`phoneNumber`	`string \| null`	no	—
`priority`	`string \| null`	no	—
`recipientId`	`string (uuid)`	no	—
`sourceEpic`	`string \| null`	no	—
`title`	`string \| null`	no	—

InternalSendRequest

Property	Type	Required	Description
`correlationId`	`string \| null`	no	—
`data`	`map<string, string> \| null`	no	—
`deliveryMode`	`string \| null`	no	—
`eventType`	`string \| null`	no	—
`instanceId`	`string (uuid) \| null`	no	—
`orgId`	`string (uuid) \| null`	no	—
`priority`	`string \| null`	no	—
`recipientId`	`string (uuid) \| null`	no	—
`recipientIds`	`(string (uuid))[] \| null`	no	—
`recipientType`	`string \| null`	no	—
`segmentFilter`	`string \| null`	no	—
`sourceEpic`	`string \| null`	no	—
`templateOverrides`	`map<string, string> \| null`	no	—

MuteSenderRequest

Property	Type	Required	Description
`moduleId`	`string \| null`	no	—
`muteType`	`string \| null`	no	—
`muteUntil`	`string (date-time) \| null`	no	—
`organisationId`	`string (uuid) \| null`	no	—

NameChangeBroadcastPreviewDto

Property	Type	Required	Description
`changeId`	`string (uuid)`	no	—
`notifiedCount`	`integer (int32)`	no	—
`withheld`	`WithheldContactDto[] \| null`	no	—
`withheldCount`	`integer (int32)`	no	—

NameChangeBroadcastResultDto

Property	Type	Required	Description
`broadcastId`	`string (uuid)`	no	—
`notifiedCount`	`integer (int32)`	no	—
`withheldCount`	`integer (int32)`	no	—

NameChangeUndoResultDto

Property	Type	Required	Description
`broadcastId`	`string (uuid)`	no	—
`retracted`	`boolean`	no	—
`suppressedCount`	`integer (int32)`	no	—
`windowExpired`	`boolean`	no	—

NonSuppressibleCategoryDto

Property	Type	Required	Description
`code`	`string \| null`	no	—
`displayName`	`string \| null`	no	—
`lawfulBasis`	`string \| null`	no	—
`reason`	`string \| null`	no	—
`sourceEpic`	`string \| null`	no	—

NonSuppressibleRegisterDto

Property	Type	Required	Description
`categories`	`NonSuppressibleCategoryDto[] \| null`	no	—
`version`	`string \| null`	no	—

NotificationChannel

0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 with no declared properties.

OrgBroadcastRequest

Property	Type	Required	Description
`data`	`map<string, string> \| null`	no	—
`deliveryMode`	`string \| null`	no	—
`eventType`	`string \| null`	no	—
`instanceId`	`string (uuid)`	no	—
`recipientIds`	`(string (uuid))[] \| null`	no	—
`segmentFilter`	`string \| null`	no	—

PerTypePreferenceRow

Property	Type	Required	Description
`email`	`boolean`	no	—
`eventType`	`string \| null`	no	—
`inApp`	`boolean`	no	—
`push`	`boolean`	no	—
`sms`	`boolean`	no	—
`teams`	`boolean`	no	—
`whatsApp`	`boolean`	no	—

PortfolioTransferRecipientServiceDto

Property	Type	Required	Description
`acknowledgedAt`	`string (date-time) \| null`	no	—
`channels`	`string[] \| null`	no	—
`lastFailedAt`	`string (date-time) \| null`	no	—
`letterEscalationRequired`	`boolean`	no	—
`recipientId`	`string (uuid)`	no	—
`servedAt`	`string (date-time) \| null`	no	—
`statutoryServiceStatus`	`string \| null`	no	—

PortfolioTransferServiceEvidenceDto

Property	Type	Required	Description
`acknowledged`	`integer (int32)`	no	—
`asOfUtc`	`string (date-time)`	no	—
`attemptedUndelivered`	`integer (int32)`	no	—
`corporateEventId`	`string (uuid)`	no	—
`letterEscalationRequired`	`integer (int32)`	no	—
`notYetServed`	`integer (int32)`	no	—
`policyholdersInBook`	`integer (int32) \| null`	no	—
`recipientLines`	`PortfolioTransferRecipientServiceDto[] \| null`	no	—
`recipients`	`integer (int32)`	no	—
`reconciles`	`boolean \| null`	no	—
`reconciliationNote`	`string \| null`	no	—
`served`	`integer (int32)`	no	—

PreviewRequest

Property	Type	Required	Description
`sampleData`	`map<string, string> \| null`	no	—

PrivacyModeRequest

Property	Type	Required	Description
`enabled`	`boolean`	no	—

ProblemDetails

Property	Type	Required	Description
`detail`	`string \| null`	no	—
`instance`	`string \| null`	no	—
`status`	`integer (int32) \| null`	no	—
`title`	`string \| null`	no	—
`type`	`string \| null`	no	—

PutSafeguardingScopeRequest

Property	Type	Required	Description
`safeChannels`	`string[] \| null`	no	—

ReadAllRequest

Property	Type	Required	Description
`before`	`string (date-time) \| null`	no	—
`instance`	`string (uuid) \| null`	no	—
`module`	`string \| null`	no	—

ReattestationRemindRequestDto

Property	Type	Required	Description
`pendingPartyRefs`	`string[] \| null`	no	—

ReattestationRemindResponseDto

Property	Type	Required	Description
`broadcastId`	`string (uuid)`	no	—
`remindedAt`	`string (date-time)`	no	—
`remindedCount`	`integer (int32)`	no	—
`targetedPartyCount`	`integer (int32)`	no	—

ReengagementOptOutRequestDto

Property	Type	Required	Description
`token`	`string \| null`	no	—

ReengagementPreferenceDto

Property	Type	Required	Description
`status`	`string \| null`	no	—
`suppressedUntil`	`string (date-time) \| null`	no	—

ReengagementSnoozeRequestDto

Property	Type	Required	Description
`days`	`integer (int32) \| null`	no	—
`token`	`string \| null`	no	—

RegisterDeviceRequestDto

Property	Type	Required	Description
`deviceFingerprint`	`string \| null`	no	—
`deviceName`	`string \| null`	no	—
`deviceType`	`string \| null`	no	—
`platform`	`string \| null`	no	—
`pushPlatform`	`string \| null`	no	—
`pushToken`	`string \| null`	no	—

RegisterInstitutionalEndpointRequest

Property	Type	Required	Description
`ackWindowHours`	`integer (int32) \| null`	no	—
`apiKey`	`string \| null`	no	—
`deliveryMethod`	`string \| null`	no	—
`emailAddress`	`string \| null`	no	—
`institutionName`	`string \| null`	no	—
`requiresConfirmationGate`	`boolean[] \| null`	no	—
`subscribedEventTypes`	`string[] \| null`	no	—
`webhookSecret`	`string \| null`	no	—
`webhookUrl`	`string \| null`	no	—

RelyingPartyDeliveryDto

Property	Type	Required	Description
`displayName`	`string \| null`	no	—
`failureReason`	`string \| null`	no	—
`fallback`	`string \| null`	no	—
`notifiedAt`	`string (date-time) \| null`	no	—
`relyingPartyId`	`string \| null`	no	—
`status`	`string \| null`	no	—

SafeguardingScopeDto

Property	Type	Required	Description
`consentGrantId`	`string (uuid)`	no	—
`createdAt`	`string (date-time)`	no	—
`criticalNoticesReach`	`string[] \| null`	no	—
`safeChannels`	`string[] \| null`	no	—

SafeguardingScopeListDto

Property	Type	Required	Description
`scopes`	`SafeguardingScopeDto[] \| null`	no	—

SecurityAdvisoryDto

Property	Type	Required	Description
`composedByOperator`	`string \| null`	no	—
`exposureWindowEnd`	`string (date-time)`	no	—
`exposureWindowStart`	`string (date-time)`	no	—
`id`	`string (uuid)`	no	—
`incidentReference`	`string \| null`	no	—
`kind`	`string \| null`	no	—
`recipients`	`SecurityAdvisoryRecipientDto[] \| null`	no	—
`requiredActions`	`string[] \| null`	no	—
`sentAt`	`string (date-time) \| null`	no	—
`severity`	`string \| null`	no	—
`status`	`string \| null`	no	—
`whatHappened`	`string \| null`	no	—

SecurityAdvisoryRecipientDto

Property	Type	Required	Description
`ackActor`	`string \| null`	no	—
`ackDisposition`	`string \| null`	no	—
`acknowledgedAt`	`string (date-time) \| null`	no	—
`channel`	`string \| null`	no	—
`deliveredAt`	`string (date-time) \| null`	no	—
`noActionNeeded`	`boolean`	no	—
`organizationId`	`string (uuid)`	no	—
`sentAt`	`string (date-time) \| null`	no	—

SetCrossInstanceConsentRequest

Property	Type	Required	Description
`granted`	`boolean`	no	—

SetDigestFloorRequest

Property	Type	Required	Description
`mandatoryPrivacyFloor`	`string \| null`	no	—

SharedContactAcceptanceRequestDto

Property	Type	Required	Description
`manageShareUrl`	`string \| null`	no	—
`organisationName`	`string \| null`	no	—
`purposeLabel`	`string \| null`	no	—
`recipientEmail`	`string \| null`	no	—
`sharedFieldLabels`	`string[] \| null`	no	—

SharedContactConsentResultDto

Property	Type	Required	Description
`dispatchedCount`	`integer (int32)`	no	—
`statusMessage`	`string \| null`	no	—

SharedContactInvitationRequestDto

Property	Type	Required	Description
`acceptUrl`	`string \| null`	no	—
`designatorDisplayName`	`string \| null`	no	—
`expiryDays`	`integer (int32)`	no	—
`organisationName`	`string \| null`	no	—
`privacyNoticeUrl`	`string \| null`	no	—
`purposeLabel`	`string \| null`	no	—
`recipientEmail`	`string \| null`	no	—
`requestedFieldLabels`	`string[] \| null`	no	—
`retentionSummary`	`string \| null`	no	—
`tokenReference`	`string \| null`	no	—

SharedContactRevocationRequestDto

Property	Type	Required	Description
`addAnotherUrl`	`string \| null`	no	—
`designatorDisplayName`	`string \| null`	no	—
`designatorRecipientId`	`string (uuid)`	no	—
`recipientEmail`	`string \| null`	no	—

StatutoryServiceAttemptDto

Property	Type	Required	Description
`attemptId`	`string (uuid)`	no	—
`attemptedAt`	`string (date-time)`	no	—
`channel`	`string \| null`	no	—
`citation`	`string \| null`	no	—
`documentId`	`string (uuid)`	no	—
`evidenced`	`boolean`	no	—
`failureReason`	`string \| null`	no	—
`notificationId`	`string (uuid) \| null`	no	—
`outcome`	`string \| null`	no	—
`propertyId`	`string (uuid) \| null`	no	—
`receiptRef`	`string \| null`	no	—
`recipientUserId`	`string (uuid)`	no	—
`retainUntil`	`string (date-time)`	no	—
`serviceDueBy`	`string (date-time)`	no	—

StatutoryServiceAttemptRequest

Property	Type	Required	Description
`channel`	`string \| null`	no	—
`citation`	`string \| null`	no	—
`documentId`	`string (uuid)`	no	—
`failureReason`	`string \| null`	no	—
`propertyId`	`string (uuid) \| null`	no	—
`receiptRef`	`string \| null`	no	—
`recipientEmail`	`string \| null`	no	—
`recipientUserId`	`string (uuid)`	no	—
`serviceDueBy`	`string (date-time)`	no	—

StatutoryServiceAttemptResultDto

Property	Type	Required	Description
`attempt`	`StatutoryServiceAttemptDto`	no	—
`service`	`StatutoryServiceEvidenceDto`	no	—

StatutoryServiceEvidenceDto

Property	Type	Required	Description
`attempts`	`StatutoryServiceAttemptDto[] \| null`	no	—
`escalationNote`	`string \| null`	no	—
`evidencedByAttemptId`	`string (uuid) \| null`	no	—
`nextChannel`	`string \| null`	no	—
`servedAt`	`string (date-time) \| null`	no	—
`serviceDueBy`	`string (date-time) \| null`	no	—
`serviceId`	`string (uuid)`	no	—
`statutoryServiceStatus`	`string \| null`	no	—
`withinStatutoryWindow`	`boolean \| null`	no	—

TemplateGovernanceRequest

Property	Type	Required	Description
`reviewNotes`	`string \| null`	no	—
`status`	`string \| null`	no	—

TemplateTestSendRequest

Property	Type	Required	Description
`channel`	`string \| null`	no	—
`recipientUserId`	`string (uuid)`	no	—
`sampleData`	`map<string, string> \| null`	no	—

TenantSecurityAdvisoryDto

Property	Type	Required	Description
`accessibleContent`	`map<string, string> \| null`	no	—
`ackDisposition`	`string \| null`	no	—
`acknowledgedAt`	`string (date-time) \| null`	no	—
`exposureWindowEnd`	`string (date-time)`	no	—
`exposureWindowStart`	`string (date-time)`	no	—
`id`	`string (uuid)`	no	—
`incidentReference`	`string \| null`	no	—
`noActionNeeded`	`boolean`	no	—
`requiredActions`	`string[] \| null`	no	—
`sentAt`	`string (date-time) \| null`	no	—
`severity`	`string \| null`	no	—
`tenantImpactSummary`	`string \| null`	no	—
`whatHappened`	`string \| null`	no	—

TrustedContactArmResponse

Property	Type	Required	Description
`acceptUrl`	`string \| null`	no	—
`status`	`TrustedContactConsentStatusResponse`	no	—
`withdrawUrl`	`string \| null`	no	—

TrustedContactConsentStatusResponse

Property	Type	Required	Description
`changed`	`boolean`	no	—
`lifecycle`	`string \| null`	no	—
`maskedContact`	`string \| null`	no	—
`since`	`string (date-time)`	no	—

UpdateCategoryGovernanceRequest

Property	Type	Required	Description
`categoryAggregationOptIn`	`map<string, boolean> \| null`	no	—
`categoryPrivacyFloors`	`map<string, string> \| null`	no	—
`instanceId`	`string (uuid)`	no	—

UpdateChannelProviderBody

Property	Type	Required	Description
`config`	`map<string, string> \| null`	no	—
`isActive`	`boolean \| null`	no	—
`providerType`	`string \| null`	no	—
`rateLimitPerMinute`	`integer (int32) \| null`	no	—
`senderIdentity`	`string \| null`	no	—

UpdateDigestRequest

Property	Type	Required	Description
`deliveryEmail`	`string \| null`	no	—
`deliveryTime`	`string \| null`	no	—
`mode`	`string \| null`	no	—
`privacyMode`	`boolean \| null`	no	—
`timeZone`	`string \| null`	no	—

UpdateInstitutionalEndpointRequest

Property	Type	Required	Description
`isActive`	`boolean \| null`	no	—
`requiresConfirmationGate`	`boolean[] \| null`	no	—
`subscribedEventTypes`	`string[] \| null`	no	—

UpdateOrgSettingsRequest

Property	Type	Required	Description
`broadcastEnabled`	`boolean \| null`	no	—
`broadcastRatePerSecond`	`integer (int32) \| null`	no	—
`instanceId`	`string (uuid)`	no	—
`mandatoryChannels`	`string[] \| null`	no	—
`mandatoryEventTypes`	`string[] \| null`	no	—
`mandatoryPrivacyFloor`	`string \| null`	no	—
`segmentEnabled`	`boolean \| null`	no	—

UpdatePreferenceRequest

Property	Type	Required	Description
`channels`	`ChannelPreferences`	no	—
`eventType`	`string \| null`	no	—
`perType`	`PerTypePreferenceRow[] \| null`	no	—

UpdateQuietHoursRequest

Property	Type	Required	Description
`channels`	`string[] \| null`	no	—
`enabled`	`boolean \| null`	no	—
`end`	`string \| null`	no	—
`start`	`string \| null`	no	—
`timeZone`	`string \| null`	no	—

UpdateReattestationCadenceRequest

Property	Type	Required	Description
`channels`	`string[] \| null`	no	—
`instanceId`	`string (uuid)`	no	—
`leadTimeDays`	`integer (int32) \| null`	no	—
`repeatEveryDays`	`integer (int32) \| null`	no	—

UpdateTemplateRequest

Property	Type	Required	Description
`actions`	`string \| null`	no	—
`bodyTemplate`	`string \| null`	no	—
`isActive`	`boolean \| null`	no	—
`subject`	`string \| null`	no	—
`variablesSchema`	`string \| null`	no	—

UpsertChannelProviderConfigBody

Property	Type	Required	Description
`providerType`	`string \| null`	no	—
`rateLimitPerMinute`	`integer (int32) \| null`	no	—
`senderIdentity`	`string \| null`	no	—
`settings`	`map<string, string> \| null`	no	—

VerifiedChangeBroadcastResultDto

Property	Type	Required	Description
`broadcastId`	`string (uuid)`	no	—
`contentHash`	`string \| null`	no	—
`deliveryRecordId`	`string (uuid)`	no	—
`excludedRevokedCount`	`integer (int32)`	no	—
`networkResolved`	`boolean`	no	—
`reachedCount`	`integer (int32)`	no	—
`reconciliationId`	`string (uuid) \| null`	no	—
`refusalCode`	`string \| null`	no	—
`sent`	`boolean`	no	—
`skippedCount`	`integer (int32)`	no	—
`statusMessage`	`string \| null`	no	—

VerifiedChangeDeliveryRecordDto

Property	Type	Required	Description
`broadcastId`	`string (uuid)`	no	—
`changeId`	`string (uuid)`	no	—
`completedAt`	`string (date-time)`	no	—
`contentHash`	`string \| null`	no	—
`deliveryRecordId`	`string (uuid)`	no	—
`excludedRevoked`	`string[] \| null`	no	—
`excludedRevokedCount`	`integer (int32)`	no	—
`integrityVerified`	`boolean`	no	—
`reached`	`string[] \| null`	no	—
`reachedCount`	`integer (int32)`	no	—
`reconciliationId`	`string (uuid) \| null`	no	—
`retracted`	`boolean`	no	—
`retractedAt`	`string (date-time) \| null`	no	—
`signatureRef`	`string \| null`	no	—
`skipped`	`VerifiedChangeSkippedDto[] \| null`	no	—
`skippedCount`	`integer (int32)`	no	—
`statusMessage`	`string \| null`	no	—

VerifiedChangeSkippedDto

Property	Type	Required	Description
`contactRef`	`string \| null`	no	—
`reasonCode`	`string \| null`	no	—

VerifiedChangeUndoResultDto

Property	Type	Required	Description
`broadcastId`	`string (uuid)`	no	—
`retracted`	`boolean`	no	—
`statusMessage`	`string \| null`	no	—
`suppressedCount`	`integer (int32)`	no	—
`windowExpired`	`boolean`	no	—

WhatsAppOptOutRequest

Property	Type	Required	Description
`token`	`string \| null`	no	—

WithheldContactDto

Property	Type	Required	Description
`contactRef`	`string \| null`	no	—
`reasonCode`	`string \| null`	no	—

Essence Notification Service API ​

AdminChannelProviderConfig

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

AdminChannelProviders

Parameters

Request body

Responses

Parameters

Request body

Responses

AdminDashboard

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

AdminDeadLetterBulkRetry

Parameters

Request body

Responses

CardCaptureNotice

Parameters

Request body

Responses

Parameters

Request body

Responses

ConfirmationGates

Parameters

Request body

Responses

Parameters

Request body

Responses

ConsentRevocations

Parameters

Request body

Responses

ContactUpdatedNotice

Parameters

Request body

Responses

Parameters

Request body

Responses

Parameters

Request body

Responses

ContactUpdatedNoticeDispatch

Parameters

Request body

Responses

CredentialCompromise

Parameters

Request body

Responses

Parameters

Request body

Responses

Essence Notification Service API