> ## Documentation Index > Fetch the complete documentation index at: https://docs.go.aiinsurance.io/llms.txt > Use this file to discover all available pages before exploring further. # Close Submission > Closes a submission in one transaction. Every active quote on the submission (`inProgress` or `complete`) is cancelled, the submission moves to `closed`, and the optional close reason and explanation are stored when those fields exist in the Company's configuration. Use this action instead of changing `submissionStatus` through the generic entity endpoint. That field is system-managed, so a generic status transition returns `409 GuardedStatusFieldWrite`. A submission that contains a bound quote cannot be closed. Closing an already-closed submission is also a strict conflict; neither case partially cancels quotes or changes the submission. **Required permission:** `submission.close` ## OpenAPI ````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/submissions/{submissionId}/close openapi: 3.0.3 info: title: AI Insurance External API description: External API for AI Insurance platform version: 1.0.0 contact: email: support@aiinsurance.io servers: - url: https://go.aiinsurance.io description: Production security: - ApiKeyAuth: [] paths: /api/v1/companies/{companyId}/submissions/{submissionId}/close: post: tags: - Submission and Quote Lifecycle summary: Close Submission description: > Closes a submission in one transaction. Every active quote on the submission (`inProgress` or `complete`) is cancelled, the submission moves to `closed`, and the optional close reason and explanation are stored when those fields exist in the Company's configuration. Use this action instead of changing `submissionStatus` through the generic entity endpoint. That field is system-managed, so a generic status transition returns `409 GuardedStatusFieldWrite`. A submission that contains a bound quote cannot be closed. Closing an already-closed submission is also a strict conflict; neither case partially cancels quotes or changes the submission. **Required permission:** `submission.close` operationId: closeSubmission parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/submissionIdPath' requestBody: required: false content: application/json: schema: type: object additionalProperties: false properties: closeReason: type: string minLength: 1 description: > Optional key from the tenant's Close Reason option set. It is stored only when `Submission::closeReason` is configured. closeExplanation: type: string minLength: 1 description: | Optional free-text explanation. It is stored only when `Submission::closeExplanation` is configured. examples: withoutReason: summary: Close without an optional reason stamp value: {} withReason: summary: Close with a configured reason and explanation value: closeReason: lostToCompetitor closeExplanation: Incumbent retained the account. responses: '200': description: The submission was closed and its active quotes were cancelled. content: application/json: schema: type: object required: - submissionId - closedQuoteIds properties: submissionId: type: string format: uuid description: The submission that was closed. closedQuoteIds: type: array description: Active quotes cancelled by the close cascade. items: type: string format: uuid examples: closed: summary: Submission closed value: submissionId: 550e8400-e29b-41d4-a716-446655440030 closedQuoteIds: - 550e8400-e29b-41d4-a716-446655440031 '400': description: The submission id or optional close-stamp body is invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidSubmissionId: summary: Submission id is not a UUID value: error: code: VALIDATION_ERROR message: Invalid request '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: No submission with the given id exists for this company. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: submissionNotFound: summary: Submission not found value: error: code: NotFoundError message: Submission not found '409': description: | The submission cannot be closed because it is already closed (`SubmissionAlreadyClosed`) or contains a bound quote (`SubmissionNotCloseable`). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: alreadyClosed: summary: Submission is already closed value: error: code: SubmissionAlreadyClosed message: >- Submission 550e8400-e29b-41d4-a716-446655440030 is already closed userMessages: - >- Submission 550e8400-e29b-41d4-a716-446655440030 is already closed hasBoundQuote: summary: Submission contains a bound quote value: error: code: SubmissionNotCloseable message: >- Submission 550e8400-e29b-41d4-a716-446655440030 has a bound quote and cannot be closed userMessages: - >- Submission 550e8400-e29b-41d4-a716-446655440030 has a bound quote and cannot be closed '500': $ref: '#/components/responses/InternalServerError' components: parameters: companyId: name: companyId in: path required: true schema: type: string format: uuid description: Company identifier submissionIdPath: name: submissionId in: path required: true description: The submission's unique identifier. schema: type: string format: uuid schemas: ErrorResponse: type: object description: Standard error response for all external API endpoints required: - error properties: error: type: object required: - code - message properties: code: type: string description: Machine-readable error code example: VALIDATION_ERROR message: type: string description: Human-readable error message example: 'submissionId: Required field is missing' userMessages: type: array description: >- Clean, verbatim-displayable messages — one entry per failure, free of error-code tags, field paths, and internal noise. Suitable for showing to end users as-is. items: type: string example: - Exposures of type 'company' require an address details: type: array description: Additional details for validation errors (field-level errors) items: type: object properties: field: type: string description: The field that caused the error example: submissionId code: type: string description: Stable problem code for this individual validation failure example: BLANK_LIST_ELEMENT reason: type: string description: Stable reason the value violates its canonical contract example: blank-list-element expected: type: string description: The expected canonical value contract example: nonblank trimmed string message: type: string description: Description of the field error example: Required field is missing responses: Unauthorized: description: Unauthorized - Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingApiKey: summary: Missing API key value: error: code: AuthenticationError message: API key authentication required userMessages: - API key authentication required invalidApiKey: summary: >- Invalid API key (e.g. unknown key, or a Bearer token used instead of an API key) value: error: code: AuthenticationError message: Invalid API key userMessages: - Invalid API key Forbidden: description: Forbidden - Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: insufficientPermissions: summary: Insufficient permissions value: error: code: AuthorizationError message: User is not authorized to perform the requested action userMessages: - User is not authorized to perform the requested action companyMismatch: summary: A valid API key naming another company in the URL value: error: code: AuthorizationError message: API key is not scoped to the requested company userMessages: - API key is not scoped to the requested company InternalServerError: description: Internal Server Error - Unexpected error occurred content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internalError: summary: Unexpected server error value: error: code: UncaughtActionError message: Uncaught error occurred in userMessages: - An unexpected error occurred. Please try again later. securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- API key authentication. Send your raw API key as the `Authorization` header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key` header; those are not accepted. ````