MIministryofjustice
Prior Authority

Categorise an uploaded document

Changed on

Assigns a document type to a previously uploaded supporting document.

patch/prior-authorities/{priorAuthorityId}/documents/{documentId}

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/prior-authorities/{priorAuthorityId}/documents/{documentId}
  • Auth
    none declared

Path parameters

priorAuthorityIdstring uuid required

ID of the prior authority.

documentIdstring uuid required

ID of the document to categorise.

Request body

documentType'GATEWAY_EVIDENCE' | 'MERITS_REPORT' | 'STATEMENT_OF_CASE' | 'COURT_APPLICATION' | 'COURT_ORDER' | 'EXPERT_REPORT' | 'COURT_APPLICATION_OR_ORDER' | 'PARENTAL_RESPONSIBILITY' | 'LOCAL_AUTHORITY_ASSESSMENT' | 'GROUNDS_OF_APPEAL' | 'COUNSEL_OPINION' | 'JUDGEMENT' | 'PLF_COURT_ORDER' | 'LETTER_OF_INSTRUCTION' | 'ESTIMATE_OF_COSTS' | 'ALTERNATIVE_QUOTE' | 'OTHER_PARTY_CERTIFICATE_REFERENCE' | 'OTHER_SUPPORTING_DOCUMENT' | 'PRIMARY_QUOTE' | 'ADDITIONAL_QUOTE' required

Type of document being categorised.

Example request

{
  "documentType": "GATEWAY_EVIDENCE"
}

Response

Document category updated.

documentIdstring uuid

Identifier of the document that was updated.

updatedAtstring date-time

Timestamp the category update was recorded by the Access Data Store.

Example response

{
  "documentId": "c3b07e24-d92b-410a-9d95-88f117a12b43",
  "updatedAt": "2026-05-22T10:00:00Z"
}

Changes