Socotra Policy API

openapi: 3.0.1
info:
  title: Socotra Insurance Suite OpenAPI Definition Policy API
  description: Socotra Insurance Suite API
  termsOfService: https://www.socotra.com
  version: v0
servers:
- url: /
  description: Generated server url
tags:
- name: Policy
paths:
  /policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}:
    get:
      operationId: getTransactionSchedule
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: staticElementLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: lastSeenLocator
        in: query
        required: false
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleItemsResponse'
                deprecated: false
      x-securityGroup: transactions
      x-securityPermission:
      - read
      - schedule-read
      deprecated: false
      tags:
      - Policy
    post:
      operationId: uploadTransactionSchedule
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: staticElementLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              properties:
                file:
                  type: string
                  format: binary
                  deprecated: false
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
                deprecated: false
      x-securityGroup: transactions
      x-securityPermission:
      - write
      - schedule-add
      deprecated: false
      tags:
      - Policy
    put:
      operationId: addTransactionSchedule
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: staticElementLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                $ref: '#/components/schemas/AddScheduleItemRequest'
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
                deprecated: false
      x-securityGroup: transactions
      x-securityPermission:
      - write
      - schedule-add
      deprecated: false
      tags:
      - Policy
    patch:
      operationId: updateTransactionSchedule
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: staticElementLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                $ref: '#/components/schemas/PatchScheduleItemRequest'
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
                deprecated: false
      x-securityGroup: transactions
      x-securityPermission:
      - write
      - schedule-update
      deprecated: false
      tags:
      - Policy
    delete:
      operationId: deleteTransactionSchedule
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: staticElementLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                type: string
                format: ulid
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
      x-securityGroup: transactions
      x-securityPermission:
      - write
      - schedule-delete
      deprecated: false
      tags:
      - Policy
  /policy/{tenantLocator}/transactions/{locator}/elements:
    put:
      operationId: addElementsToPolicyWithTransaction
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                $ref: '#/components/schemas/ElementCreateRequest'
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/SegmentResponse'
                  deprecated: false
      x-securityGroup: transactions
      x-securityPermission:
      - write
      - elements-add
      deprecated: false
      tags:
      - Policy
    patch:
      operationId: updateElementsInPolicyWithTransaction
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ElementUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/SegmentResponse'
                  deprecated: false
      x-securityGroup: transactions
      x-securityPermission:
      - write
      - elements-update
      deprecated: false
      tags:
      - Policy
    delete:
      operationId: removeElementsFromPolicyWithTransaction
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                type: string
                format: ulid
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/SegmentResponse'
                  deprecated: false
      x-securityGroup: transactions
      x-securityPermission:
      - write
      - elements-delete
      deprecated: false
      tags:
      - Policy
  /policy/{tenantLocator}/transactions/{locator}/changeInstructions:
    put:
      operationId: createPolicyChangeInstruction
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/AddChangeInstructionCreateRequest'
                deprecated: false
              - $ref: '#/components/schemas/DeleteChangeInstructionCreateRequest'
                deprecated: false
              - $ref: '#/components/schemas/MigrateChangeInstructionCreateRequest'
                deprecated: false
              - $ref: '#/components/schemas/ModifyChangeInstructionCreateRequest'
                deprecated: false
              - $ref: '#/components/schemas/ParamsChangeInstructionCreateRequest'
                deprecated: false
              - $ref: '#/components/schemas/ProducersChangeInstructionCreateRequest'
                deprecated: false
              - $ref: '#/components/schemas/TransactionDataChangeInstructionCreateRequest'
                deprecated: false
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyTransactionResponse'
                deprecated: false
      x-securityGroup: transactions
      x-securityPermission:
      - write
      - change-instruction-add
      deprecated: false
      tags:
      - Policy
  /policy/{tenantLocator}/quotes/{locator}/static:
    get:
      operationId: fetchStaticDataForQuote
      description: Gets static data for a quote
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                deprecated: false
                additionalProperties:
                  type: object
                  deprecated: false
      x-securityGroup: quotes
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Policy
    post:
      operationId: addStaticDataForQuote
      description: Set the static extension data on a quote
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              deprecated: false
              additionalProperties:
                type: object
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuoteResponse'
                deprecated: false
      x-securityGroup: quotes
      x-securityPermission:
      - write
      - static-data-add
      deprecated: false
      tags:
      - Policy
    put:
      operationId: replaceAllStaticDataForQuote
      description: Replaces all of the static data on a quote
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              deprecated: false
              additionalProperties:
                type: object
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuoteResponse'
                deprecated: false
      x-securityGroup: quotes
      x-securityPermission:
      - write
      - static-data-add
      deprecated: false
      tags:
      - Policy
    patch:
      operationId: updateStaticDataForQuote
      description: Updates some of the static data on a quote
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StaticDataUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuoteResponse'
                deprecated: false
      x-securityGroup: quotes
      x-securityPermission:
      - write
      - static-data-update
      deprecated: false
      tags:
      - Policy
  /policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}:
    get:
      operationId: fetchScheduleItems
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: staticElementLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: lastSeenLocator
        in: query
        required: false
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleItemsResponse'
                deprecated: false
      x-securityGroup: quotes
      x-securityPermission:
      - read
      - schedule-read
      deprecated: false
      tags:
      - Policy
    post:
      operationId: uploadScheduleItems
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: staticElementLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              properties:
                file:
                  type: string
                  format: binary
                  deprecated: false
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
                deprecated: false
      x-securityGroup: quotes
      x-securityPermission:
      - write
      - schedule-add
      deprecated: false
      tags:
      - Policy
    put:
      operationId: addScheduleItems
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: staticElementLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                $ref: '#/components/schemas/AddScheduleItemRequest'
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
                deprecated: false
      x-securityGroup: quotes
      x-securityPermission:
      - write
      - schedule-add
      deprecated: false
      tags:
      - Policy
    patch:
      operationId: updateScheduleItems
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: staticElementLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                $ref: '#/components/schemas/PatchScheduleItemRequest'
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
                deprecated: false
      x-securityGroup: quotes
      x-securityPermission:
      - write
      - schedule-update
      deprecated: false
      tags:
      - Policy
    delete:
      operationId: deleteScheduleItems
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: staticElementLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                type: string
                format: ulid
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
      x-securityGroup: quotes
      x-securityPermission:
      - write
      - schedule-delete
      deprecated: false
      tags:
      - Policy
  /policy/{tenantLocator}/quotes/{locator}/elements:
    put:
      operationId: addElementsToQuote
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                $ref: '#/components/schemas/ElementCreateRequest'
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuoteResponse'
                deprecated: false
      x-securityGroup: quotes
      x-securityPermission:
      - write
      - elements-add
      deprecated: false
      tags:
      - Policy
    delete:
      operationId: removeElementsFromQuote
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                type: string
                format: ulid
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuoteResponse'
                deprecated: false
      x-securityGroup: quotes
      x-securityPermission:
      - write
      - elements-delete
      deprecated: false
      tags:
      - Policy
  /policy/{tenantLocator}/quickquotes/{locator}/elements:
    put:
      operationId: addElementsToQuickQuote
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                $ref: '#/components/schemas/ElementResponse'
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuickQuoteResponse'
                deprecated: false
      x-securityGroup: quick-quotes
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Policy
    delete:
      operationId: deleteElementsFromQuickQuote
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                type: string
                format: ulid
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuickQuoteResponse'
                deprecated: false
      x-securityGroup: quick-quotes
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Policy
  /policy/{tenantLocator}/policies/{locator}/static:
    get:
      operationId: fetchStaticDataForPolicy
      description: Gets the static data on a policy
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                deprecated: false
                additionalProperties:
                  type: object
                  deprecated: false
      x-securityGroup: policies
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Policy
    post:
      operationId: addStaticDataForPolicy
      description: Set the static extension data on a policy
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              deprecated: false
              additionalProperties:
                type: object
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyResponse'
                deprecated: false
      x-securityGroup: policies
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Policy
    put:
      operationId: replaceAllStaticDataForPolicy
      description: Replaces all of the static data on a policy
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              deprecated: false
              additionalProperties:
                type: object
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyResponse'
                deprecated: false
      x-securityGroup: policies
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Policy
    patch:
      operationId: updateStaticDataForPolicy
      description: Updates some of the static data on a policy
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StaticDataUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyResponse'
                deprecated: false
      x-securityGroup: policies
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Policy
  /policy/{tenantLocator}/policies/{locator}/moratoriums/elections:
    put:
      operationId: addPolicyMoratoriumElections
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                $ref: '#/components/schemas/MoratoriumElectionRequest'
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyResponse'
                deprecated: false
      x-securityGroup: policies
      x-securityPermission:
      - moratoriums
      deprecated: false
      tags:
      - Policy
    delete:
      operationId: deletePolicyMoratoriumElections
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: array
              deprecated: false
              items:
                type: string
                deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyResponse'
                deprecated: false
      x-securityGroup: policies
      x-securityPermission:
      - moratoriums
      deprecated: false
      tags:
      - Policy
  /policy/{tenantLocator}/holds:
    put:
      operationId: createEntityHold
      summary: Fetches all entity holds for the current user
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEntityHoldRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityHold'
                deprecated: false
      x-securityGroup: holds
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Policy
  /policy/{tenantLocator}/autoRenewals/{locator}:
    get:
      operationId: fetchAutoRenewal
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format

# --- truncated at 32 KB (342 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-policy-api-openapi.yml