Analysis Cancellation

Cancel a vendor registration analysis that is still in progress. After cancellation, no further changes can be made to that analysis.

When cancellation is possible

Cancellation is available while the analysis is in the pending_submission or pending_adm_approval statuses. Analyses that are already approved, rejected or canceled cannot be canceled.

---

Request

ENDPOINT

/vendor_registry/analysis/{analysis_key}/cancel

METHOD

PUT

Path params

Parameter	Type	Description
analysis_key	string	Unique key of the analysis (UUID)

This endpoint does not require a body.

Response

STATUS

202

Response Body

{
    "analysis_key": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "status": "canceled"
}

Response attributes

Field	Type	Description
analysis_key	string	Unique key of the analysis.
status	string	New status of the analysis. Always returns canceled.

---

Possible errors

STATUS

409

Status transition not allowed

The analysis is in a status that does not allow cancellation (for example, it has already been approved or rejected).

{
  "title": "Analysis Status Transition Denied",
  "description": "Analysis with key {analysis_key} is not allowed to switch status from {current_status} to canceled.",
  "translation": "Análise com chave {analysis_key} não pode trocar de status de {current_status} para canceled.",
  "code": "VRG000008"
}

STATUS

404

Analysis not found

The analysis_key provided in the URL does not correspond to any registered analysis.

{
  "title": "Analysis not found",
  "description": "Analysis with the key {analysis_key} was not found.",
  "translation": "A análise com a chave {analysis_key} não foi encontrada.",
  "code": "VRG000007"
}

---

Next steps

To register the vendor again, start a new process via:

Analysis creation — submit the vendor data again.