Sign in

v11

latestSwagger 2.0raw.githubusercontent.com2026-05-29223242.1 KB
get submission
query

Fetch details of a submission

get/submission/{submission-id}

Response

Submission details

idstring required

Unique identifer of a submission

confirmation_referencestring required

user-friendly reference for confirmation screen and email

created_atstring date-time required

Date and time the submission was created

submitted_atstring date-time

Date and time the submission was submitted

last_modified_atstring date-time required

Date and time the submission was last updated

fee_on_submissionstring

fee amount at time submission was made

status'OPEN' | 'SUBMITTED' | 'REJECTED_BY_VIRUS_SCAN' | 'PROCESSED_BY_EMAIL' | 'PROCESSING' | 'REJECTED_BY_DOCUMENT_CONVERTER' | 'READY_TO_SUBMIT' | 'SENT_TO_FES' | 'ACCEPTED' | 'REJECTED' required

Example response

{
  "id": "123456",
  "confirmation_reference": "b7hg xnpd mydt 3t81",
  "created_at": "2020-03-11T11:15:38.633Z",
  "submitted_at": "2020-03-11T11:15:38.633Z",
  "last_modified_at": "2020-03-11T11:15:38.633Z",
  "presenter": {
    "email": "elangworth@example.mail.com"
  },
  "company": {
    "company_name": "Ritchie Group",
    "company_number": "000000007"
  },
  "payment_sessions": [
    {
      "session_id": "yMxgdNVSdwyk7sN",
      "session_state": "FD_RlzcLp-xcK1YZGEbn3ZpRHGlwy7tNjn_zsjYVauoB8Ml3GkfpmbhPuPd093XM",
      "session_status": "Pending"
    }
  ],
  "fee_on_submission": "17",
  "status": "OPEN",
  "form": {
    "barcode": "Y9357QG8",
    "form_type": "SH04",
    "file_details": [
      {
        "file_id": "123456",
        "file_name": "SHO1.pdf",
        "file_size": 1234,
        "converted_file_id": "654321",
        "number_of_pages": 1234,
        "last_modified_at": "2020-03-11T11:15:38.633Z"
      }
    ]
  },
  "reject_reasons": [
    {
      "reason": "You have not used the correct form"
    }
  ]
}