--- title: "Submit Lodgement Case to HMLR" url: "https://developer.pexa.co.uk/apis/lodgement-v1-v1/versions/5d60a5b6-f880-49a9-9ffa-3fcd91fe7f8f/operations/submitLodgementCaseToHmlr" --- > Full API specification: https://developer.pexa.co.uk/apis/lodgement-v1-v1/versions/5d60a5b6-f880-49a9-9ffa-3fcd91fe7f8f.md # Submit Lodgement Case to HMLR `POST` `/partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/submit` Operation ID: `submitLodgementCaseToHmlr` This API is used to manually submit a lodgement case to HMLR for processing. This triggers the submission workflow for the specified lodgement case. ## Path parameters - `lodgement_case_id` (string, uuid, required) - Lodgement case id ## Header parameters - `X-Request-Correlation-Id` (string, optional) ## Responses - `204` - NO CONTENT - Lodgement case submitted successfully - `400` - BAD REQUEST - `401` - UNAUTHORIZED - `403` - FORBIDDEN - `404` - NOT FOUND - `500` - INTERNAL SERVER ERROR - `503` - SERVICE UNAVAILABLE ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Lodgement version: v1 servers: - url: https://api.pexa.co.uk description: API Gateway URL paths: /partner/api/platformconnect/v1/lodgement-cases/{lodgement_case_id}/submit: post: tags: - LodgementCase summary: Submit Lodgement Case to HMLR description: This API is used to manually submit a lodgement case to HMLR for processing. This triggers the submission workflow for the specified lodgement case. operationId: submitLodgementCaseToHmlr security: - oauth2: - x-api:submit:lodgement_applications - submit:lodgement_applications parameters: - in: header name: X-Request-Correlation-Id schema: type: string description: The unique identifier for the request - name: lodgement_case_id in: path description: Lodgement case id required: true schema: type: string format: uuid responses: "204": description: NO CONTENT - Lodgement case submitted successfully headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request "400": description: BAD REQUEST headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: - message: Bad Request "401": description: UNAUTHORIZED headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: - message: Unauthorized "403": description: FORBIDDEN headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: - message: Forbidden "404": description: NOT FOUND headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: - message: Not Found "500": description: INTERNAL SERVER ERROR headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request "503": description: SERVICE UNAVAILABLE headers: X-API-Version: schema: type: string description: The API version that was used to process the request. X-Request-Correlation-Id: schema: type: string description: The unique identifier for the request content: application/json: schema: type: object properties: errors: type: array items: type: object properties: field: type: string description: Field message: type: string description: Error message example: errors: - message: Service under maintenance security: - oauth2: - x-api:submit:lodgement_applications - submit:lodgement_applications components: securitySchemes: oauth2: type: oauth2 flows: clientCredentials: tokenUrl: https://login.pexauk.co.uk/oauth/token scopes: x-api:create:attachments: Create access to the attachments x-api:add:workspace_files: Add access to the workspace files view:title_documents: View access to the title documents x-api:view:documents: View access to the documents x-api:approve:lodgement_applications: Approve access to lodgement applications x-api:unapprove:lodgement_applications: Unapprove access to lodgement applications x-api:submit:lodgement_applications: Submit access to lodgement applications x-api:add:lodgement_titles: Add titles to lodgementCase view:lodgement_cases: View lodgement cases view:lodgement_documents: View lodgement documents add:lodgement_files: Add access to the lodgement files view:lodgement_files: View access to the lodgement files submit:lodgement_applications: Submit access to the lodgement applications view:workspaces: View access to the workspaces ```