v1

latestOpenAPI 3.1.02026-08-061838260.7 KB
Submission Status API

Check Single Submission Status

When an authorized filer requests the status of a single submission that the filer made, the Check Single Submission Status API will respond with the current status of that submission.

get/submission/{accessionNumber}/status

Path parameters

accessionNumberstring required

The accession number returned when a submission is successfully transmitted.

Response

Ok. A submission filed by the authorized filer, with the given accession number, was found

submissionAccessionNumberstring

The accession number associated with any item submissions.

submissionFormTypestring

The FORM TYPE as it would appear on the Submission Status

itemsstring[]

The list of ITEM(s) as it would appear on the Submission Status

trackingstring

A universal tracking identifier that can be used by applications to keep track of individual requests sent to the EDGAR API. The tracking identifier correlates all actions taken in the course of a single request. If seeking support from the EDGAR Help Desk this will be a useful piece of information to provide.

locatorstring

A short identifier that can be used by the EDGAR Help Desk to locate the tracking identifier within the EDGAR system.

accessionNumberstring nullable

The unique number associated with an transmitted submission.

mode'LIVE' | 'TEST'

The submission mode of a filing:

  • TEST - A submission mode that allows a filing to be tested for correctness
  • LIVE - A submission mode that allows a filing to be evaluated as an official filing For more information see the EDGAR Filing Manual
status'PROCESSING' | 'SUSPENDED' | 'DISSEMINATED' | 'NO_STATUS' | 'BLOCKED' | 'DONE' | 'ACCEPTED'

A short string that indicates the status of a submission within the EDGAR system.

  • PROCESSING - The submission is currently being processed by EDGAR
  • SUSPENDED - The submission has been suspended by EDGAR
  • DISSEMINATED - The submission has been processed and disseminated
  • NO_STATUS - The current status of the submission cannot be determined
  • BLOCKED - The submission has reached the blocked status and is awaiting further action
  • DONE - The submission has reached the DONE state in the EDGAR system and no further processing is expected
  • ACCEPTED - The submission has been accepted by EDGAR
companystring

The COMPANY as it would appear on the Submission Status

documentCountinteger

The number of DOCUMENTS as it would appear on the Submission Status

formTypestring

The FORM TYPE as it would appear on the Submission Status

receivedDatestring date-time
filingDatestring date-time
acceptedDatestring date-time
suspendedDatestring date-time
finalboolean

A boolean indicator that, when true, indicates that EDGAR has stopped processing the submission and that the current status is the final status. Once a submission is marked as having its final disposition the full details of the filling are available.

fileNumbersstring[]

The list of FILE NUMBER(s) as it would appear on the Submission Status

notificationstring

A base64 encoded string that, when decoded, is the plain text contents of the submission notification file matching the data from the "Retrieve Submission Information" function of the EDGAR Filing application. This field is only populated when the 'final' field is true.

submissionProcessingStatus'PROCESSING' | 'SUSPENDED' | 'DISSEMINATED' | 'NO_STATUS' | 'BLOCKED' | 'DONE' | 'ACCEPTED'

A short string that indicates the status of a submission within the EDGAR system.

  • PROCESSING - The submission is currently being processed by EDGAR
  • SUSPENDED - The submission has been suspended by EDGAR
  • DISSEMINATED - The submission has been processed and disseminated
  • NO_STATUS - The current status of the submission cannot be determined
  • BLOCKED - The submission has reached the blocked status and is awaiting further action
  • DONE - The submission has reached the DONE state in the EDGAR system and no further processing is expected
  • ACCEPTED - The submission has been accepted by EDGAR

Example response

{
  "accessionNumber": "0000000001-22-000001",
  "messages": [
    {
      "content": "The Filer API Key making this request will expire in less than two weeks."
    }
  ],
  "mode": "LIVE",
  "status": "SUSPENDED",
  "receivedDate": "2022-03-10T12:15:50-04:00",
  "filingDate": "2022-03-10T12:15:50-04:00",
  "acceptedDate": "2022-03-10T12:15:50-04:00",
  "suspendedDate": "2022-03-10T12:15:50-04:00",
  "submissionMessages": [
    {
      "content": "The Filer API Key making this request will expire in less than two weeks.",
      "errorLabel": "INCONSISTENT_TAG_VALUE"
    }
  ],
  "submissionProcessingStatus": "SUSPENDED"
}