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

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

# Translations

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    TranslationCategory:
      type: object
      properties:
        categoryName:
          type: string
          enum:
            - RISKCLASS
            - TABLERATING
            - COVERAGEBAND
            - PAYMENTMETHOD
            - TRANSACTION
            - FEATURE
          description: The group or classification of values for which translation is
            being requested
        translations:
          type: array
          items:
            $ref: "#/components/schemas/TranslationBase"
    TranslationBase:
      type: object
      properties:
        systemOfRecordValue:
          type: string
          description: The value from the Source of Record (e.g., Zahara) that needs to be
            translated to the corresponding carrier value
        carrierValue:
          type: string
          description: The equivalent value used by the carrier system that corresponds to
            the given sorValue
        metadata:
          $ref: "#/components/schemas/Metadata"
    Metadata:
      type: object
      properties:
        isTobaccoUse:
          type: boolean
          description: Indicates the tobacco usage status, used to differentiate mappings
            for risk classes that depend on smoking status. (i.e if smoker or
            non-smoker)
    Translations:
      type: object
      properties:
        carrierId:
          type: string
          description: The Carrier ID is a unique identifier assigned to an insurance
            company (carrier) that issues and underwrites a policy. It helps
            track, manage, and differentiate insurance providers within industry
            databases, regulatory systems, and digital platforms
        planCode:
          type: string
          description: The Plan Code is a carrier-assigned unique identifier used to
            distinguish a specific product, rate structure, and version of a
            life insurance or annuity policy. It ensures accurate policy
            tracking, pricing, and administration
        categories:
          type: array
          items:
            $ref: "#/components/schemas/TranslationCategory"
```