---
title: "GET /document/events"
method: GET
path: "/document/events"
---

# GET /document/events

`GET /document/events`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/document/events`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/document/events/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

OK

- DocumentServiceEventTypeDefinitions
  - `documentEvents` DocumentEvents, required
    - `document.copyOnIssue.ready` DocumentCopyOnIssueReadyPayload
      - `quoteReferenceLocator` string, ulid, required
    - `document.ready` DocumentGenerationEventsPayload
      - `documentLocator` string, ulid, required
      - `referenceType` 'quote' | 'policy' | 'invoice' | 'transaction' | 'segment' | 'term' | 'quoteGroup', required
      - `referenceLocator` string, ulid, required
    - `document.failed` DocumentGenerationEventsPayload
      - `documentLocator` string, ulid, required
      - `referenceType` 'quote' | 'policy' | 'invoice' | 'transaction' | 'segment' | 'term' | 'quoteGroup', required
      - `referenceLocator` string, ulid, required
    - `document.plugin.failed` DocumentPluginFailedPayload
      - `pluginType` 'rating' | 'underwriting' | 'validation' | 'documentSelection' | 'documentDataSnapshot' | 'preCommit' | 'renewal' | 'delinquencyEvent' | 'documentConsolidationSnapshot' | 'installments' | 'autopay' | 'paymentPostProcessing' | 'cancellation' | 'continuation' | 'automationHttp' | 'automationWebhook' | 'documentConsolidationSelection' | 'workplanSelection' | 'workplanExecution' | 'deserialization' | 'configMigration' | 'integrations', 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/77ee7d8172b9?raw)