v1

latestOpenAPI 3.1.02026-08-061838260.7 KB

Submission API

Bulk Test Submission

Allows an authorized filer to transmit a BULK TEST submission file. When an authorized filer transmits a filing to this resource it will transmit the file to EDGAR and return a list of accession numbers. EDGAR will then begin processing the submissions.

post/submission/bulk/test

Headers

X-EDGAR-CIKstring

DEPRECATED in favor of X-EDGAR-LOGIN-CIK. If a value is sent in X-EDGAR-LOGIN-CIK this header will be ignored. If no header value is sent in X-EDGAR-LOGIN-CIK this header's value (if present) will be used. An optional header to use to provide an alternate CIK to use to generate the accession number of the submission. The provided CIK must delegate to the CIK that the Filer API Token belongs to and the User API Token must represent a user that has permission to file for that CIK. This must be a valid CIK and cannot be blank or empty.

X-EDGAR-LOGIN-CIKstring

An optional header to use to provide an alternate CIK to use to generate the accession number of the submission. The provided CIK must delegate to the CIK that the Filer API Token belongs to and the User API Token must represent a user that has permission to file for that CIK. This must be a valid CIK and cannot be blank or empty.

Response

Accepted. The filing has been transmitted to the BULK TEST resource and the EDGAR system has generated accession number(s) for each contained filing. The submission(s) have begun processing.

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.

status'RECEIVED' | 'REJECTED' | 'FAILED'

A short string that indicates the status of filing that was transmitted to EDGAR.

RECEIVED - The transmission has been received by EDGAR and an accession number has been generated
REJECTED - The transmission was rejected by EDGAR and will not be processed
FAILED - The transmission failed to be transmitted to EDGAR and will not be processed`

transmissionStatus'RECEIVED' | 'REJECTED' | 'FAILED'

A short string that indicates the status of filing that was transmitted to EDGAR.

RECEIVED - The transmission has been received by EDGAR and an accession number has been generated
REJECTED - The transmission was rejected by EDGAR and will not be processed
FAILED - The transmission failed to be transmitted to EDGAR and will not be processed`

Example response

{
  "status": "RECEIVED",
  "responses": [
    {
      "accessionNumber": "0000000001-22-000001",
      "messages": [
        {
          "content": "The Filer API Key making this request will expire in less than two weeks."
        }
      ],
      "mode": "LIVE",
      "transmissionStatus": "RECEIVED"
    }
  ],
  "messages": [
    {
      "content": "The Filer API Key making this request will expire in less than two weeks."
    }
  ],
  "transmissionStatus": "RECEIVED"
}