transaction.documentReceived

Event Detail

Triggered when a supporting document is received during transaction processing.

Back to Catalog

type: transaction.documentReceived

family: Document

LOB: Life, Annuity

Standard Metadata

Common fields across all events.

Field	Type	Description	Example
`id`	GUID	Unique identifier for the event	`123e4567-e89b-12d3-a456-426614174000`
`carrier`	String	Insurance carrier code	`EVGL`
`correlationId`	GUID	Trace ID across systems	`223e4567-e89b-12d3-a456-426614174111`
`source`	String	Source system	`Zinnia.DocumentManagement`
`type`	String	Standard event type	`documentReceived`
`dataContentType`	String	Payload format	`application/json`
`specVersion`	String	Event spec version	`v1`
`time`	ISO Timestamp	Event occurrence time	`2024-02-14T03:23:09.496Z`

Business Data

Event-specific payload fields.

Field	Type	Description
`id`	String	Case / admin ID
`status`	String	Lifecycle status of the event subject
`createdAt`	ISO Date	Created timestamp
`updatedAt`	ISO Date	Updated timestamp
`process`	String	Business process / transaction type
`processSubType`	String	Sub type of the business process
`lob`	String	Line of business
`transactionType`	String	High-level commercial transaction category
`applicationSource`	String	Channel that originated the transaction
`associatedEntities`	Array	Related domain entities (policy, case, document)
`requestContext`	Object	Additional context (product name, distribution, etc.)
`documentId`	GUID	Unique identifier of the received document
`documentType`	String	Type or classification of the document
`documentFormat`	String	Format of the document file

Identifiers

Field	Type	Description	Example
`policyNumber`	String	Policy number	`FXXXXXXX`
`eAppID`	GUID	Application ID (New Business only)	`323e4567-e89b-12d3-a456-426614174222`
`planCode`	String	Plan code	`EVGLTL0101`
`zlCase`	String	Zinnia case ID	`CAXXXX121214`

Enum Values

status:
INPROGRESS
documentType:
Application
ID Verification
Medical Records
Beneficiary Form
Replacement Form
documentFormat:
PDF
TIFF
PNG
transactionType:
NEW_BUSINESS
FINANCIAL
NON_FINANCIAL
CLAIM
lob:
Life
Annuity

Try It

Send a sample transaction.documentReceived event to your own endpoint. Pick a transaction category, edit the payload, then fire a live request and inspect the response.

Built for the Zinnia developer portal. | specVersion: v1 · contentType: application/json