---
title: "GET /policy/{tenantLocator}/policies/{locator}/snapshot"
method: GET
path: "/policy/{tenantLocator}/policies/{locator}/snapshot"
---

# GET /policy/{tenantLocator}/policies/{locator}/snapshot

`GET /policy/{tenantLocator}/policies/{locator}/snapshot`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/policy/{tenantLocator}/policies/{locator}/snapshot`
- Auth: none declared

## Path parameters

- `tenantLocator` string, uuid, required
- `locator` string, ulid, required

## Query parameters

- `date` string, date-time, required
- `byIssuedTime` boolean

## Response `200`

OK

- PolicySnapshotResponse
  - `locator` string, ulid, required
  - `accountLocator` string, ulid, required
  - `productName` string, required
  - `timezone` string, required
  - `currency` string, required
  - `region` string, required
  - `transaction` TransactionSnapshotResponse, required
    - `locator` string, ulid, required
    - `transactionCategory` 'issuance' | 'change' | 'renewal' | 'cancellation' | 'continuation' | 'flatCancellation' | 'reinstatement' | 'reversal' | 'aggregate', required
    - `transactionType` string, required
    - `effectiveTime` string, date-time, required
    - `issuedTime` string, date-time, required
    - `preferences` Preferences, required
      - `installmentPreferences` InstallmentPreferences
        - `cadence` 'none' | 'fullPay' | 'weekly' | 'everyOtherWeek' | 'monthly' | 'quarterly' | 'semiannually' | 'annually' | 'thirtyDays' | 'everyNDays'
        - `anchorMode` 'generateDay' | 'termStartDay' | 'dueDay'
        - `generateLeadDays` integer
        - `dueLeadDays` integer
        - `installmentWeights` number[], required
        - `maxInstallmentsPerTerm` integer
        - `installmentPlanName` string
        - `anchorType` 'none' | 'dayOfMonth' | 'anchorTime' | 'dayOfWeek' | 'weekOfMonth'
        - `dayOfMonth` integer
        - `dayOfWeek` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
        - `weekOfMonth` 'none' | 'first' | 'second' | 'third' | 'fourth' | 'fifth'
        - `anchorTime` string, date-time
        - `autopayLeadDays` number
    - `segment` SegmentResponse, required
      - `locator` string, ulid, required
      - `transactionLocator` string, ulid, required
      - `segmentType` 'coverage' | 'gap', required
      - `startTime` string, date-time, required
      - `endTime` string, date-time, required
      - `element` ElementResponse, required
        - `type` string, required
        - `locator` string, ulid, required
        - `parentLocator` string, ulid, required
        - `elements` ElementResponse[]
        - `coverageTerms` object
        - `data` object
        - `staticLocator` string, ulid, required
        - `originalEffectiveTime` string, date-time, required: Indicates when the element was first added to the policy
        - `category` 'product' | 'coverage' | 'exposure' | 'exposureGroup' | 'policyLine'
      - `duration` number, required
      - `basedOn` string, ulid
      - `anonymizedAt` string, date-time
      - `producerInfo` ProducerInfo
        - `producerCode` string
        - `producerCodeOfRecord` string
      - `proxyPayerLocator` string, ulid
  - `delinquencyPlanName` string
  - `static` object, required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/6537d24b3693?raw)