---
title: "ActiveRestrictTransactionRequest"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/schemas/ActiveRestrictTransactionRequest"
---

> Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md

# ActiveRestrictTransactionRequest

Request body for active restrict (POST `/bpm/v1/policies/{planCode}/{policyNumber}/Restrict`). Extends the common transaction case request fields with restriction operations.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.8
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
components:
  schemas:
    ActiveRestrictSubmitInfo:
      type: object
      description: Submission metadata for active restrict requests
      properties:
        submittedBy:
          type: string
        source:
          type: string
        submittedByPartyId:
          type: string
    ActiveRestrictRestrictionItem:
      type: object
      description: Single restriction operation in the submit payload
      properties:
        restrictionType:
          type: string
        action:
          type: string
        restrictionSubType:
          type: string
    ActiveRestrictTransactionDocument:
      type: object
      description: Document reference in the submit request (common BPM document fields)
      properties:
        documentId:
          type: string
        documentDate:
          type: string
        documentType:
          type: string
        documentTypeDescription:
          type: string
        displayName:
          type: string
        policyNumber:
          type: string
        planCode:
          type: string
        caseId:
          type: string
    ActiveRestrictTransactionRequest:
      type: object
      description: >
        Request body for active restrict (POST
        `/bpm/v1/policies/{planCode}/{policyNumber}/Restrict`).

        Extends the common transaction case request fields with restriction
        operations.
      properties:
        planCode:
          type: string
        correlationId:
          type: string
        partyId:
          type: string
        policyNumber:
          type: string
        businessKey:
          type: string
        transactionName:
          type: string
        deleteRequest:
          type: boolean
        requestType:
          type: string
        submitInfo:
          $ref: "#/components/schemas/ActiveRestrictSubmitInfo"
        receivedDate:
          type: string
        carrierId:
          type: string
        restriction:
          type: array
          items:
            $ref: "#/components/schemas/ActiveRestrictRestrictionItem"
        effectiveDate:
          type: string
        caseId:
          type: string
        documents:
          type: array
          items:
            $ref: "#/components/schemas/ActiveRestrictTransactionDocument"
        policyFeatureData:
          type: object
          additionalProperties:
            type: boolean
```