---
title: "Event"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/Event"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# Event

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    CarrierType:
      type: string
      enum:
        - SB
    Identifier:
      type: object
      properties:
        identifier:
          type: string
          description: Attribute name storing the policy reference id generated by RDE
            system
          example: policyReferenceId
        value:
          type: string
          description: A unique policy reference id generated by RDE system
          example: 54c246a0-d690-43f1-9a94-5ec1bdc5de7c
    Event:
      type: object
      properties:
        id:
          type: string
          description: A unique ID generated by SOR system for the given event
          example: 81887a67-81ea-416f-87e6-db3dff9c60c6
        correlationid:
          type: string
          description: The unique ID to track each transaction request across all systems
          example: 79d75952-5aae-4430-bb00-97a8f7dbbc4c
        source:
          type: string
          description: SOR system name defaults to Zahara
          example: zahara
        carrier:
          $ref: "#/components/schemas/CarrierType"
        specversion:
          type: string
          description: Schema version of Event (object)
          example: "1"
        type:
          type: string
          example: policy.anniversary.completed
          format: "[Entity].[EventName].[Status]"
          description: Type of event represented by combining the different event name and
            the status Entity - policy EventName - activation - addresschange -
            anniversary - bankaccountchange - Beneficiarychange - claimpayout -
            costofinsurance - disbursement - emailchange - expensecharge -
            faceamountchange - freelookcancellation - freelookexpiration -
            fullsurrender - paymentInitialPremium - initialpremium -
            interestcredit - interestcreditloan - interestcreditmatch -
            interestloan - lapseassessment - loananniversarytrueUp - newloan -
            ownerchange - partialwithdrawalonetime - payeechange -
            paymentsystematicloanrepayment - payorchange - phonenumberchange -
            policydetailschange - policyissuance - preferredmailingaddresschange
            - subsequentpayment - subsequentpremium - systematicloanrepayment -
            systematicloanrepaymentsetup - systematicpartialwithdrawal -
            systematicpartialwithdrawalsetup - tpdchange - unitexpensecharge -
            paymentonetimepremium - onetimepremium Status - pending - completed
            - canceled - reversed - failed - pendingreversal
        datacontenttype:
          type: string
          enum:
            - application/json
            - application/xml
          description: Defines the content type of data field
        data:
          type: string
          description: Event data in one of the formats specified in datacontenttype field
          example: '{"policyNumber": "POLICY1234567890", "transactionId" : "25", "status":
            "Completed","version": "25"}'
        time:
          type: string
          description: Time of event in date time format (UTC)
          format: date-time
          example: 2023-11-27T07:40:51.487Z
        identifiers:
          description: Identifiers
          allOf:
            - $ref: "#/components/schemas/Identifier"
```