> ## Documentation Index > Fetch the complete documentation index at: https://docs.korint.io/llms.txt > Use this file to discover all available pages before exploring further. # Stop a policy > The policy and its assets all become [STOPPED](#object-statuses) and can no longer be modified. ## OpenAPI ````yaml /openapi.json post /policies/{policyId}/stop openapi: 3.0.0 info: title: Korint API description: >- Quoting, policy issuance, billing, claims, documents and compliance for insurance distribution. version: 1.0.0 contact: {} servers: - url: https://api.korint.io description: Production - url: https://api.sandbox.korint.io description: Sandbox security: - oauth2: [] - bearerAuth: [] tags: [] paths: /policies/{policyId}/stop: post: tags: - policy summary: Stop a policy description: >- The policy and its assets all become [STOPPED](#object-statuses) and can no longer be modified. operationId: PolicyController_stopPolicy parameters: - name: tenant in: header required: true description: Your tenant identifier. Requests without it are rejected. schema: type: string - name: policyId required: true in: path description: the policy id schema: pattern: >- ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$ type: string - name: whenAt required: false in: query description: 'Optional: the whenAt datetime' schema: type: string format: date-time requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopPolicyInputBody' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/StopPolicyOutput' '400': content: application/json: schema: anyOf: - $ref: '#/components/schemas/InvalidEventCreationDateErrorDto' - $ref: '#/components/schemas/InvalidStopReasonErrorDto' - $ref: '#/components/schemas/InvalidStopReasonDetailsErrorDto' examples: INVALID_EVENT_CREATION_DATE: value: code: INVALID_EVENT_CREATION_DATE message: >- You are trying to push an event that is created on {createdAt}, but the creation date should be after the latest event which was created on {latestCreatedAt} details: {} INVALID_STOP_REASON: value: code: INVALID_STOP_REASON message: Invalid stop reason for {productId} details: {} INVALID_STOP_REASON_DETAILS: value: code: INVALID_STOP_REASON_DETAILS message: Invalid stop reason details details: {} description: '' '403': content: application/json: schema: anyOf: - $ref: '#/components/schemas/ForbiddenErrorDto' examples: FORBIDDEN: value: code: FORBIDDEN message: Forbidden details: {} description: '' '404': content: application/json: schema: anyOf: - $ref: '#/components/schemas/PolicyNotFoundErrorDto' examples: POLICY_NOT_FOUND: value: code: POLICY_NOT_FOUND message: Policy {policyId} ({branchId}) not found details: {} description: '' '409': content: application/json: schema: anyOf: - $ref: '#/components/schemas/ConflictingPolicyStatusErrorDto' examples: CONFLICTING_POLICY_STATUS: value: code: CONFLICTING_POLICY_STATUS message: >- {policyId} status {requirement} {policyStatus} to perform {action} details: {} description: '' components: schemas: StopPolicyInputBody: type: object properties: reason: type: string description: >- Stop reason. The accepted values are defined per product; read them from the product configuration in `GET /config/{productId}`. An unlisted value fails with INVALID_STOP_REASON. details: type: array items: $ref: '#/components/schemas/CustomFieldDto' required: - reason StopPolicyOutput: type: object properties: {} InvalidEventCreationDateErrorDto: type: object properties: code: type: string enum: - INVALID_EVENT_CREATION_DATE message: type: string example: >- You are trying to push an event that is created on {createdAt}, but the creation date should be after the latest event which was created on {latestCreatedAt} details: $ref: '#/components/schemas/InvalidEventCreationDateDetailsDto' required: - code - message - details InvalidStopReasonErrorDto: type: object properties: code: type: string enum: - INVALID_STOP_REASON message: type: string example: Invalid stop reason for {productId} details: $ref: '#/components/schemas/InvalidStopReasonDto' required: - code - message - details InvalidStopReasonDetailsErrorDto: type: object properties: code: type: string enum: - INVALID_STOP_REASON_DETAILS message: type: string example: Invalid stop reason details details: $ref: '#/components/schemas/InvalidStopReasonDetailsDto' required: - code - message - details ForbiddenErrorDto: type: object properties: code: type: string enum: - FORBIDDEN message: type: string example: Forbidden details: $ref: '#/components/schemas/ForbiddenDetailsDto' required: - code - message - details PolicyNotFoundErrorDto: type: object properties: code: type: string enum: - POLICY_NOT_FOUND message: type: string example: Policy {policyId} ({branchId}) not found details: $ref: '#/components/schemas/PolicyNotFoundDetailsDto' required: - code - message - details ConflictingPolicyStatusErrorDto: type: object properties: code: type: string enum: - CONFLICTING_POLICY_STATUS message: type: string example: '{policyId} status {requirement} {policyStatus} to perform {action}' details: $ref: '#/components/schemas/ConflictingPolicyStatusDetailsDto' required: - code - message - details CustomFieldDto: type: object properties: key: type: string value: oneOf: - type: string - type: number - type: boolean required: - key - value InvalidEventCreationDateDetailsDto: type: object properties: createdAt: type: string format: date-time latestCreatedAt: type: string format: date-time required: - createdAt - latestCreatedAt InvalidStopReasonDto: type: object properties: productId: type: string reason: type: string required: - productId - reason InvalidStopReasonDetailsDto: type: object properties: productId: type: string errors: type: array items: $ref: '#/components/schemas/InvalidCustomFieldsDetailsErrorsDto' required: - productId - errors ForbiddenDetailsDto: type: object properties: message: type: string documentKey: type: string userId: type: string ownerId: type: string required: - message - documentKey - userId - ownerId PolicyNotFoundDetailsDto: type: object properties: policyId: type: string branchId: type: string whenAt: type: string simulatedAt: type: string required: - policyId ConflictingPolicyStatusDetailsDto: type: object properties: policyStatus: oneOf: - type: string - type: array items: type: string policyId: type: string requirement: allOf: - $ref: '#/components/schemas/OperationRequirement' action: allOf: - $ref: '#/components/schemas/Action' additionalData: type: object additionalProperties: true required: - policyStatus - policyId - requirement - action InvalidCustomFieldsDetailsErrorsDto: type: object properties: key: type: string errorDetails: type: array items: type: string value: type: object required: - key - errorDetails OperationRequirement: type: string enum: - must be - must NOT be - must contain - must NOT contain Action: type: string enum: - PERFORM THIS ACTION - CREATE POLICY - CREATE ASSET - CREATE ASSET WITH START DATE - REPLACE ASSET - REMOVE ASSET - CHOOSE ASSET OPTIONS - STOP ASSET - EDIT ASSET - EDIT ASSET WITH START DATE - CREATE BRANCH - CREATE DEROGATION - CREATE MTA BRANCH - FORK TO NEW MTA BRANCH - FORK TO NEW NB BRANCH - FORK TO NEW RENEWAL BRANCH - FORK TO NEW REPRICING BRANCH - DEFINE PARENT POLICY ID - INITIALIZE CUSTOMER - EDIT CUSTOMER - DELETE CUSTOMER FROM POLICY - SIGN - EDIT POLICY - EDIT POLICY EXTERNAL ID - CONFIRM POLICY - QUOTE POLICY - RETRIEVING QUOTE - STOP POLICY - SUSPEND POLICY - ACTIVATE POLICY - GENERATE MANDATE SIGNATURE REQUEST - GENERATE PAYMENT METHOD SECRET - CREATE CLAIM - FINALIZE RENEWAL - SEND CONTRACT TO SIGNATURE - GENERATE SIGNATURE REQUEST - GENERATE DOCUMENTS FOR SIGNATURE - APPROVE DISTRIBUTION REQUEST - DENY DISTRIBUTION REQUEST - REVOKED_DISTRIBUTION_REQUEST - DELETE DISTRIBUTION REQUEST - WAITING FOR SIGNATURE DISTRIBUTION REQUEST - UPDATE POLICY QUOTE securitySchemes: oauth2: type: oauth2 flows: clientCredentials: tokenUrl: https://korint-tenant.auth.eu-west-3.amazoncognito.com/oauth2/token scopes: korint.io/account: Read account information korint.io/analytics: Access analytics endpoints korint.io/assets: Access asset endpoints korint.io/billing: Access billing endpoints korint.io/branches: Access branch endpoints korint.io/broker: Access broker endpoints korint.io/claims: Access claim endpoints korint.io/comments: Access comment endpoints korint.io/customers: Access customer endpoints korint.io/derogations: Access derogation endpoints korint.io/documents: Access document endpoints korint.io/external: Access external lookup endpoints korint.io/external-claims: Declare claims from an external system korint.io/internal-notes: Access internal note endpoints korint.io/invitations: Access invitation endpoints korint.io/payments: Access payment endpoints korint.io/permissions: Access permission management endpoints korint.io/policies: Access policy endpoints korint.io/quotes: Access quote endpoints korint.io/reportings: Access reporting endpoints korint.io/signature: Access signature endpoints description: >- Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace `tenant` with your tenant identifier. bearerAuth: scheme: bearer bearerFormat: JWT type: http description: An access token obtained from your tenant authorization server. ````